diff --git a/NOTICE.md b/NOTICE.md index 4d5ce9d8661..6a15f4e5ffe 100644 --- a/NOTICE.md +++ b/NOTICE.md @@ -39,6 +39,11 @@ See DEPENDENCIES file. In addtion, we use 'Manrope' as font. Copyright (c) Mikhail Sharanda (), with Reserved Font Name 'Manrope' under the SIL Open Font License 1.1 (OFL-1.1) see +Icons from svgrepo: + +* License: CC0 License +* Location: https://www.svgrepo.com/ + ## Cryptography Content may contain encryption software. The country in which you are currently diff --git a/blog-meeting-minutes/2024-04-11-security-hour.md b/blog-meeting-minutes/2024-04-11-security-hour.md new file mode 100644 index 00000000000..db553358c4c --- /dev/null +++ b/blog-meeting-minutes/2024-04-11-security-hour.md @@ -0,0 +1,15 @@ +--- +slug: security-office-hour-2024-04-11 +title: Security Office Hour 11.04.2024 +authors: + - rohan_krishnamurthy +tags: [meeting-minutes, community, security] +--- + +## Security Office Hour meeting minutes + +### Announcements + +- SAST: CodeQL workflows seems successfully well integrated +- KICS, Trivy, GitGuardian and Dependabot tools will continue as it is. +- No new updates diff --git a/blog/2024-04-10-open-planning-r24.08.mdx b/blog/2024-04-10-open-planning-r24.08.mdx index 7a45fb989cb..bedcf6da42c 100644 --- a/blog/2024-04-10-open-planning-r24.08.mdx +++ b/blog/2024-04-10-open-planning-r24.08.mdx @@ -46,7 +46,8 @@ The detailed agenda is only filtered by `label`not by status. As a prequisite, t | Time | Topic / Labels | Link | Number of features | | ---- | ----- | ------------- | ---- | -| 09:00 - 09:15 | pcf, circularity, eco pass | [features](https://github.com/eclipse-tractusx/sig-release/issues?q=is%3Aissue+is%3Aopen+issue%3A+628+591+632+638) | 4 | +| 09:00 - 09:10 | pcf, circularity, eco pass | [features](https://github.com/eclipse-tractusx/sig-release/issues?q=is%3Aissue+is%3Aopen+issue%3A+628+591+632+638+614) | 5 | +| 09:10 - 09:15 | digital product pass | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22digital+product+pass%22&pane=issue&itemId=59170648) | 4 | #### Platform Domain @@ -54,20 +55,16 @@ The detailed agenda is only filtered by `label`not by status. As a prequisite, t | ---- | ----- | ------------- | ---- | | 09:15 - 09:35 | golden record, business partner | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22golden+record%22%2C%22business+partner%22) | 7 | | 09:35 - 09:55 | portal | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22++label%3A%22portal%22+) | 8 | -| 09:55 - 10:05 | miw | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22miw%22) | 3 | -| 10:05 - 10:35 | edc | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22edc%22) | 15 | | 10:35 - 10:40 | data sovereignty | [features](https://github.com/eclipse-tractusx/sig-release/issues?q=is%3Aissue+is%3Aopen+issue%3A+584+583+581) | 3 | | 10:40 - 10:50 | digital twin registry, discovery finder, discovery service, semantic hub | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22digital+twin+registry%22%2C%22discovery+finder%22%2C%22discovery+service%22%2C%22semantic+hub%22) | 4 | | 10:50 - 10:55 | knowledge agent | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22knowledge+agent%22+) | 2 | -| 10:55 - 11:00 | sde | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22sde%22) | 1 | -| 11:00 - 11:05 | sd factory | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22sd+factory%22) | 2 | -| 11:05 - 11:15 | irs | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22irs%22) | 1 | + #### Business Domain PQR | Time | Topic / Labels | Link | Number of features | | ---- | ----- | ------------- | ---- | -| 11:15 - 11:30 | dcm | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?sliceBy%5Bvalue%5D=dcm) | 4 | +| 11:15 - 11:30 | dcm, puris, osim | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22osim%22%2C%22puris%22%2C%22dcm%22+) | 8 | ### Thursday, 11th April 2024 @@ -77,6 +74,29 @@ The detailed agenda is only filtered by `label`not by status. As a prequisite, t - **11:00 - 11:30** - Feedback / Retro - **11:30 - 12:00** - Open Planning Wrap-Up / Summary +#### Platform Domain + +| Time | Topic / Labels | Link | Number of features | +| ---- | ----- | ------------- | ---- | +| 09:00 - 09:15 | miw | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22miw%22) | 3 | +| 09:15 - 09:30 | edc | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22edc%22) | 15 | +| 09:30 - 09:35 | sde | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22sde%22) | 1 | +| 09:35 - 09:45 | sd factory | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22sd+factory%22) | 2 | +| 09:45 - 09:55 | irs | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22irs%22) | 1 | +| 09:45 - 09:55 | trace-x | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22trace-x%22+) | 4 | + +#### Business Domain PQR + +| Time | Topic / Labels | Link | Number of features | +| ---- | ----- | ------------- | ---- | +| 09:55 - 10:15 | dcm, puris, osim | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?filterQuery=label%3A%22Prep-PI13%22+label%3A%22osim%22%2C%22puris%22%2C%22dcm%22+) | 8 | + +#### Left over + +| Time | Topic / Labels | Link | Number of features | +| ---- | ----- | ------------- | ---- | +| 10:15 - 10:30 | open decision | [features](https://github.com/orgs/eclipse-tractusx/projects/26/views/23?sliceBy%5Bvalue%5D=open+decision) | 7 | + ## Staying Informed To stay updated on any changes or additional information, please subscribe to our mailing list. A great way to keep informed is through the provided [Tractus-X Development Mailing List RSS Feed](https://www.eclipse.org/lists/tractusx-dev/maillist.rss). diff --git a/community/open-meetings.mdx b/community/open-meetings.mdx index e2fb35c4eb2..2a8a5e64a08 100644 --- a/community/open-meetings.mdx +++ b/community/open-meetings.mdx @@ -75,15 +75,78 @@ These are dedicated sync meetings for specific products, as well as open plannin ## One-time meetings - + + + + + + + + diff --git a/docs-kits/kits/Certificate Management Kit/Documentation Certificate Management/certificate-arc42.md b/docs-kits/kits/Certificate Management Kit/Documentation Certificate Management/certificate-arc42.md index 5407388754f..d7f5113a7d6 100644 --- a/docs-kits/kits/Certificate Management Kit/Documentation Certificate Management/certificate-arc42.md +++ b/docs-kits/kits/Certificate Management Kit/Documentation Certificate Management/certificate-arc42.md @@ -5,7 +5,7 @@ description: 'Architecture documentation' sidebar_position: 1 --- -![Certificate Management kit banner](/img/Certificate_Kit_Icon.png) +![Certificate Management kit banner](/img/kit-icons/certificate-kit-icon.svg) ## Certificate Management KIT diff --git a/docs-kits/kits/Certificate Management Kit/Software Development View/page-software-development-view.md b/docs-kits/kits/Certificate Management Kit/Software Development View/page-software-development-view.md index 9b07f47b267..d8593b3aa22 100644 --- a/docs-kits/kits/Certificate Management Kit/Software Development View/page-software-development-view.md +++ b/docs-kits/kits/Certificate Management Kit/Software Development View/page-software-development-view.md @@ -5,7 +5,7 @@ description: '' sidebar_position: 1 --- -![Certificate Management kit banner](/img/Certificate_Kit_Icon.png) +![Certificate Management kit banner](/img/kit-icons/certificate-kit-icon.svg) ### Certificate Management KIT diff --git a/docs-kits_versioned_docs/version-23.09/introduction.md b/docs-kits_versioned_docs/version-23.09/introduction.md deleted file mode 100644 index e10b99d0138..00000000000 --- a/docs-kits_versioned_docs/version-23.09/introduction.md +++ /dev/null @@ -1 +0,0 @@ -# Introduction diff --git a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/Software Development View/_category_.json b/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/Software Development View/_category_.json deleted file mode 100644 index e5c5b7565a3..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/Software Development View/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Development View" -} diff --git a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/Software Development View/page_software-development-view.md deleted file mode 100644 index f9a46c06c5c..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/Software Development View/page_software-development-view.md +++ /dev/null @@ -1,1083 +0,0 @@ ---- -id: Specification Remaining Useful Life Kit -title: Specification -description: 'Remaining Useful Life Kit' -sidebar_position: 4 ---- - -![Remaining Useful Life kit banner](@site/static/img/doc-rul_header-minified.png) - - -### Remaining Useful Life Kit - -**This is only a preview KIT.** - -There will be changes in the following releases. -We plan to provide a more general RuL skill and more generalized interfaces for service -input data. With these improvements, it will be much easier and more flexible for you to -participate in the RuL use case. - -# Overview -The RuL use case takes advantage of knowledge graphs. Therefore, every participant must support the Knowledge Agent (see Knowledge Agent KIT). - -## Roles -As a developer in the Remaining Useful Life use case, you may apply to one or more -of the following roles: -- RuL consumer (RuL result requester) -- skill provider (provider of the use case logic) -- RuL data provider (provider of usage data, likely an OEM) -- delegator (likely a supplier of a component that is assembled of subcomponents which are providing RuL calculation services) -- RuL calculation service provider (likely a supplier of a part or component) - -## Logic -The central logic of the RuL use case is a **RuL skill**. -You can use a predefined RuL skill and use it or modify it to build up a similar use -case. It is written in SPARQL, a query language for federated knowledge graphs. -The current RuL skill takes vehicle identifier numbers (VINs) as parameters. -In general, a RuL skill will take one or more vehicle/component IDs as parameters. -It then collects the related usage data at the RuL data providers and calls the RuL -calculation services at the RuL service providers. The result is then collected and -transferred to the consumer. - -## Your interface -You always need access to your **running EDC with knowledge agent components** and -the (extensible) **ontologies of Catena-X**. In most cases, you can use them as they are. - -Your interface to the use case depends on your role(s): -If you are only a consumer, you are fine with the previous mentioned components. -If you are a data provider or delegator, you may have your data organized in relational databases. In this case, you need to have a running **provisioning -agent** with **configured data bindings** (linking your data to the knowledge graph). -If you are a service provider, you need to have a running **remoting agent** with -**configured service bindings** (linking your service to the knowledge graph). - -For more information, see the operation view. - -## Mandatory components -- ontologies (semantic models) -- usage data -- calculation services -- EDC + knowledge agent -- delegation data -- matchmaking agent: Mapping ontology to knowledge graph, integrated into KA-dataplane -- binding agents: - - provisioning agent: provide data - - remoting agent: bind service to graph - -| | calculation service provider | delegator | RuL data provider | RuL consumer | skill provider | -| --------------------- | :---: | :---: | :---: | :---: | :---: | -| EDC + knowledge agent
+ matchmaking agent | x | x | x | x | x | -| ontologies | x | x | x | x | x | -| skill-access | | | | x | x | -| delegation data | | x | x | x | | -| usage data | | | x | | | -| provisioning agent | | | x | | | -| calculation service | x | | | | | -| remoting agent | x | | | | | - -## Knowledge graph basics -Knowledge graphs are buildup of semantic triplets (subject --predicate-> object), where subject and object are nodes, the predicate is a unidirectional edge. All nodes are object instances, and the edges between them are their relations. For more information, see [W3C Resource Description Framework (RDF)](https://www.w3.org/RDF/). -Object types and relations are formally defined within ontologies. - -## Basic Architecture -For a detailed view of the architecture with the knowledge agent see the Knowledge Agent KIT. -Here you can see an overview over the used components and elements that must be developed: - -![Remaining Useful Life architecture overview](../assets/rul_architecture_overview.png) - -## Ontology -For the Behaviour Twin (BT) RuL User Case, beside the [core](https://w3id.org/catenax/core_ontology.ttl) and [common](https://w3id.org/catenax/common_ontology.ttl) ontologies, a specific ontology was defined. For our use cases following sub-ontologies are needed: - - [reliability ontology](https://w3id.org/catenax/reliability_ontology.ttl) -- [vehicle ontology](https://w3id.org/catenax/vehicle_ontology.ttl) and -- [behaviour ontology](https://w3id.org/catenax/behaviour_twin.ttl) - -All needed ontologies for the RuL use case are bundled in one named on our [Behaviour Twin Kit](https://w3id.org/catenax/usecase/behaviour_twin.ttl. - -General information about Knowledge-Agent Semantic Models refer to the KA-KIT (https://catenax-ng.github.io/product-knowledge/docs/development-view/modules#semantic-models). -The specific (reliability and behaviour) ontologies are based respectively compatible with the standardized SAMM Models ([Load Spectrum](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.classified_load_spectrum) and [Remaining Useful Life](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.rul/1.0.0/RemainingUsefulLife.ttl)) release by Behaviour Twin team. - -For the calculation of the remaining useful life for a specific component, the service needs to get the Load Spectrum data to proceed with the calculation. Hence, in the reliability ontology all needed semantic models are defined. - -``` ttl -################################################################ -# Copyright (c) 2022,2023 T-Systems International GmbH -# Copyright (c) 2022,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022,2023 ZF Friedrichshafen AG -# Copyright (c) 2023 Allgemeine Deutsche Automobil-Club (ADAC) e.V -# Copyright (c) 2022,2023 Mercedes-Benz AG -# Copyright (c) 2022,2023 Contributors to the Catena-X Association -# -# See the NOTICE file(s) distributed with this work for additional -# information regarding copyright ownership. -# -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 -################################################################ - -### https://w3id.org/catenax/ontology/reliability#LoadSpectrum -cx-reliability:LoadSpectrum rdf:type owl:Class ; - rdfs:subClassOf cx-reliability:AnalysisResult ; - rdfs:seeAlso , - ; - skos:altLabel "load collective"@en ; - skos:definition "Load spectrum is a 2d histogram that contains the load history of a vehicle, i.e. how a vehicle was used, for a given time period."@en ; - skos:example "force"@en , - "tension"@en , - "torque"@en ; - skos:prefLabel "Lastkollektiv"@de , - "Load Spectrum"@en . -``` - -The RuL services were designed with interoperability in mind, thus the communication in both directions (input/input) fully supports the Catena-X Notification standard. These aspects are also covered by Catena-X ontologies. The RuL Calculation can return two values: -- Remaining Running Distance and -- Remaining Operating Hours - -For this purpose, in the behaviour_ontology, a function is defined: -``` ttl -################################################################ -# Copyright (c) 2022,2023 T-Systems International GmbH -# Copyright (c) 2022,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022,2023 ZF Friedrichshafen AG -# Copyright (c) 2023 Allgemeine Deutsche Automobil-Club (ADAC) e.V -# Copyright (c) 2022,2023 Mercedes-Benz AG -# Copyright (c) 2022,2023 Contributors to the Catena-X Association -# -# See the NOTICE file(s) distributed with this work for additional -# information regarding copyright ownership. -# -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 -################################################################ - -cx-behaviour:RemainingUsefulLife rdf:type cx-fx:Function; - dc:description "Remaining Useful Life is a Prediction of the Estimated Mileage/Runtime until a Breakdown."@en ; - dc:title "Remaining Useful Life" ; - cx-fx:input cx-behaviour:notification; - cx-fx:input cx-behaviour:sender; - cx-fx:input cx-behaviour:senderConnector; - cx-fx:input cx-behaviour:recipient; - cx-fx:input cx-behaviour:recipientConnector; - cx-fx:input cx-behaviour:recipient; - cx-fx:input cx-behaviour:recipientConnector; - cx-fx:input cx-behaviour:severity; - cx-fx:input cx-behaviour:status; - cx-fx:input cx-behaviour:targetDate; - cx-fx:input cx-behaviour:timeStamp; - cx-fx:input cx-behaviour:classification; - cx-fx:input cx-behaviour:component; - cx-fx:input cx-behaviour:metadata; - cx-fx:input cx-behaviour:statusDate; - cx-fx:input cx-behaviour:statusOperatingHours; - cx-fx:input cx-behaviour:statusMileage; - cx-fx:input cx-behaviour:countingMethod; - cx-fx:input cx-behaviour:countingValue; - cx-fx:input cx-behaviour:countingUnit; - cx-fx:input cx-behaviour:headerChannels; - cx-fx:input cx-behaviour:bodyClasses; - cx-fx:input cx-behaviour:bodyCountsList; - cx-fx:result cx-behaviour:response. -``` - -The result contains the expected values: -``` ttl -################################################################ -# Copyright (c) 2022,2023 T-Systems International GmbH -# Copyright (c) 2022,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022,2023 ZF Friedrichshafen AG -# Copyright (c) 2023 Allgemeine Deutsche Automobil-Club (ADAC) e.V -# Copyright (c) 2022,2023 Mercedes-Benz AG -# Copyright (c) 2022,2023 Contributors to the Catena-X Association -# -# See the NOTICE file(s) distributed with this work for additional -# information regarding copyright ownership. -# -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 -################################################################ - -cx-behaviour:response rdf:type cx-fx:Result; -dc:description "The asynchronous notification response."@en ; -dc:title "Asynchronous notification response." ; -cx-fx:output cx-behaviour:remainingOperatingHours; -cx-fx:output cx-behaviour:remainingRunningDistance. - -cx-behaviour:remainingOperatingHours rdf:type cx-fx:ReturnValue; - dc:description "Predicted Operating Hours of Remaining Useful Life Response"@en ; - dc:title "Remaining Useful Life Operating Hours" ; - cx-fx:dataType xsd:float. - -cx-behaviour:remainingRunningDistance rdf:type cx-fx:ReturnValue; - dc:description "Predicted Distance of Remaining Useful Life Response"@en ; - dc:title "Remaining Useful Life Distance" ; - cx-fx:dataType xsd:int. -``` - -## Standards/SAMM -- [Load Spectrum](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.classified_load_spectrum) -- [Remaining Useful Life](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.rul/1.0.0/RemainingUsefulLife.ttl) - -# RuL Skill -Applies to: *RuL Skill provider* - -For the RuL calculation of a vehicle part, we have three different "roles" involved: -- consumer: which request the RuL value by VIN. -- OEM: which has the vehicle Load Spectrum data and forwards them by calling the supplier of that specific part. -- Supplier: which provides the service for the RuL calculation for his parts. - -A reference (sample) Agent-Skill for a Gearbox is implemented, - -For more information regarding the RuL Skill see [Knowledge Agent KIT](https://bit.ly/tractusx-agents). - -``` sparql -################################################################ -# Copyright (c) 2022,2023 T-Systems International GmbH -# Copyright (c) 2022,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022,2023 ZF Friedrichshafen AG -# Copyright (c) 2023 Allgemeine Deutsche Automobil-Club (ADAC) e.V -# Copyright (c) 2022,2023 Mercedes-Benz AG -# Copyright (c) 2022,2023 Contributors to the Catena-X Association -# -# See the NOTICE file(s) distributed with this work for additional -# information regarding copyright ownership. -# -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 -################################################################ - -PREFIX cx-common: -PREFIX cx-core: -PREFIX cx-vehicle: -PREFIX cx-reliability: -PREFIX cx-behaviour: -PREFIX rdf: -PREFIX rdfs: -PREFIX xsd: -PREFIX json: -PREFIX bpnl: -PREFIX oem: -PREFIX supplier: - -################################################################ -# Sample for a Federated (Consumer-Deployed) SparQL Skill which -# - Jumps into an OEM-owned reliability asset given a set of candidate VANs -# - Feeds the gathered data back into the respective supplier connector/agent -#. to perform a health indication -# Author: cgjung -# (c) 2023 Catena-X assocation -################################################################ - -SELECT DISTINCT ?vehicle ?van ?aggregate ?assembly ?supplier ?distanceKm ?timeHours WHERE { - - VALUES (?van ?aggregate) { - ("@van"^^xsd:string "Differential Gear"^^xsd:string) - } - - VALUES (?ls_type) { - ("GearOil"^^xsd:string) ("GearSet"^^xsd:string) - } - - bpnl:{{oemBPNL}} cx-common:hasConnector ?oemEDC. - ?oemEDC cx-common:offers [ rdfs:isDefinedBy ; cx-common:id ?reliabilityAssetId]. - - SERVICE ?oemEDC { - GRAPH ?reliabilityAssetId { - ?vehicle rdf:type cx-vehicle:Vehicle; - cx-vehicle:vehicleIdentificationNumber ?van. - - ?assembly rdf:type cx-vehicle:Part; - cx-vehicle:name ?aggregate; - cx-vehicle:isPartOf ?vehicle; - cx-vehicle:supplier ?supplier. - - ?teleAnalysis rdf:type cx-reliability:Analysis; - cx-reliability:analysedObject ?assembly; - cx-reliability:operatingHoursOfVehicle ?operatingTime; - cx-reliability:mileageOfVehicle ?mileage; - cx-core:startDateTime ?recordDate; - cx-reliability:result [ - cx-core:id ?ls_type; - cx-core:name ?ls_name; - cx-reliability:countingValue ?ls_value; - cx-reliability:countingUnit ?ls_unit; - cx-reliability:countingMethod ?ls_method; - cx-reliability:channels ?ls_channels; - cx-reliability:classes ?ls_classes; - cx-reliability:values ?ls_values - ]. - } # OEM#GRAPH - - ?supplier cx-common:hasConnector ?supplierEDC. - ?supplierEDC cx-common:offers [ rdfs:isDefinedBy ; cx-common:id ?prognosisAssetId]. - - SERVICE ?supplierEDC { - GRAPH ?prognosisAssetId { - SELECT ?distanceKm ?timeHours WHERE { - ?invocation a cx-behaviour:RemainingUsefulLife; - cx-behaviour:sender bpnl:{{oemBPNL}}; - cx-behaviour:senderConnector ?oemEDC; - cx-behaviour:recipient ?supplier; - cx-behaviour:recipientConnector ?supplierEDC; - cx-behaviour:targetDate ?recordDate; - cx-behaviour:timeStamp ?recordDate; - cx-behaviour:component ?assembly; - cx-behaviour:observationType ?ls_type; - cx-behaviour:statusDate ?recordDate; - cx-behaviour:statusOperatingHours ?operatingTime; - cx-behaviour:statusMileage ?mileage; - cx-behaviour:countingValue ?ls_value; - cx-behaviour:countingUnit ?ls_unit; - cx-behaviour:countingMethod ?ls_method; - cx-behaviour:headerChannels ?ls_channels; - cx-behaviour:bodyClasses ?ls_classes; - cx-behaviour:bodyCountsList ?ls_values; - cx-behaviour:remainingOperatingHours ?timeHours; - cx-behaviour:remainingRunningDistance ?distanceKm. - } - } # SUPPLIER#GRAPH - } # SUPPLIER#CATALOG - - } # OEM#CATALOG - -} # SELECT -``` - -## Skill usage -The registered skill is available over Agent Plane API and can be called also for a list of input variables: - -```curl -curl --location 'agentPlaneEdcUrl/api/agent?asset=SkillAsset%3Fconsumer%3DRemainingUsefulLife' \ ---header 'Content-Type: application/sparql-results+json' \ ---data '{ - "head": { "vars": [ "van" ]}, - "results": { "bindings": [ - { "van": { "type": "literal", "value": "FNLQNRVCOFLHAQ"}} - ] - } -}' -``` - -The RuL results for the given VAN's is provided are provided as bindings for the requested variables in the Skill itself and looks like: - -```json -{ - "head": { - "vars": [ - "vehicle", - "van", - "aggregate", - "assembly", - "supplier", - "distanceKm", - "timeHours" - ] - }, - "results": { - "bindings": [ - { - "vehicle": { - "type": "uri", - "value": "urn:uuid:4cf8b668-0f27-4f39-b986-36423d81d222" - }, - "van": { - "type": "literal", - "value": "FNLQNRVCOFLHAQ" - }, - "aggregate": { - "type": "literal", - "value": "Some vehicle name" - }, - "assembly": { - "type": "", - "value": "urn:uuid:4cf8b668-0f27-4f39-b986-36423d81d111" - }, - "supplier": { - "type": "uri", - "value": "bpn:legal:BPNL0000SUPPLIER" - }, - "distanceKm": { - "type": "", - "datatype": "http://w3.org/2001/XMLSchema#int", - "value": "123000" - }, - "timeHours": { - "type": "", - "datatype": "http://w3.org/2001/XMLSchema#float", - "value": "12345.0" - } - } - ] - } -} -``` - -If the given VAN is not found on OEM side, then we get an empty binding result: -```json -{ - "head": { - "vars": [ - "vehicle", - "van", - "aggregate", - "assembly", - "supplier", - "distanceKm", - "timeHours" - ] - }, - "results": { - "bindings": [] - } -} -``` - -# Data bindings for relational data -Applies to: *RuL data provider* and *delegator* - -## Overview -In this context, data are usage data as well as delegation data (where the sill/data have to go next). - -In most cases, data are provided in relational form (relational databases, data lakes, ...). -To provide such data as part of the knowledge graph, you have to bind/map them to the underlying ontologies. - -## Data mapping tool -To bind the relational data to the knowledge graph, you can use a **provisioning agent**, also called the **data binding agent**. The software **Ontop** (see the Ontop webpage [https://ontop-vkg.org/](https://ontop-vkg.org/)), which is under the Apache 2.0 license, is our tool of choice in this case. - -## Data mapping configuration -To configure the bindings, a config file for the Ontop software has to be created. The file is written in the Ontop mapping language and has the extension **.obda**. For more information, see the Knowledge Agent KIT. - -## Construction of a single data binding -Each data binding consists of 3 lines in the config file. -The first line defines a unique mapping id (arbitrarily selectable). -The second line lists one or more RDF triplets (target). -The third line is a SQL statement on the relational data source. - -A simple example from: -``` obda - mappingId partsvehicle - target <{gearbox_id}> cx-vehicle:isPartOf <{vehicle_id}> . - source SELECT vehicle_id, gearbox_id FROM vehicles -``` - -The target is described as a triple with two variables: gearbox_id and vehicle_id. The exact same variables must occur in the result of the source SQL statement. The SQL result is then mapped to the variables in the target triplets. -For each row in the SQL result, a triplet instance is created. If the SQL result is empty, no triplet instances are created. -The result of this example is a triplet that represents the relation between a specific vehicle its gearbox. - -A little more complex example: -``` obda - mappingId vehicles - target <{vehicle_id}> rdf:type cx-vehicle:Vehicle ; cx-vehicle:vehicleIdentificationNumber {van}^^xsd:string; cx-vehicle:worldManufaturerId bpnl:{oem_bpnl}; cx-vehicle:productionDate {production_date}^^xsd:date. - source SELECT vehicle_id, van, oem_bpnl, production_date FROM vehicles -``` - -The target now consists of 4 triplets, all with the same subject (<{vehicle_id}>) and separated by a semicolon. The semicolon means, the following triplet only defines the predicate and the object while the subject from the previous triplet is reused. -In the example above, there are the following triplets: -- *<{vehicle_id}> rdf:type cx-vehicle:Vehicle*: All objects in the database table/view "vehicles" are mapped to the type cx-vehicle:Vehicle. -- *<{vehicle_id}> cx-vehicle:vehicleIdentificationNumber {van}^^xsd:string*: Relation between a vehicle and the related VAN. The type of VAN must be string. -- *<{vehicle_id}> cx-vehicle:worldManufaturerId bpnl:{oem_bpnl}*: Relation between a vehicle and its manufacturer's BPN. -- *<{vehicle_id}> cx-vehicle:productionDate {production_date}^^xsd:date*: Relation between a vehicle and it's date of production. The type of production_date must be date. - -Complex types like the load spectra are composed of many triplets. If you have stored those load spectra as SAMM specified JSON strings, you may decompose them with specific JSON functions of your database system. - -### Full example -The following example shows mappings at an OEM that can be used to determine the vehicle object by a given VIN, find the related gearbox and the associated gearbox load spectra: -``` -################################################################ -# Copyright (c) 2022,2023 T-Systems International GmbH -# Copyright (c) 2022,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022,2023 ZF Friedrichshafen AG -# Copyright (c) 2023 Allgemeine Deutsche Automobil-Club (ADAC) e.V -# Copyright (c) 2022,2023 Mercedes-Benz AG -# Copyright (c) 2022,2023 Contributors to the Catena-X Association -# -# See the NOTICE file(s) distributed with this work for additional -# information regarding copyright ownership. -# -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 -################################################################ -```` -```obda - [PrefixDeclaration] - cx-common: https://w3id.org/catenax/ontology/common# - cx-core: https://w3id.org/catenax/ontology/core# - cx-vehicle: https://w3id.org/catenax/ontology/vehicle# - cx-reliability: https://w3id.org/catenax/ontology/reliability# - uuid: urn:uuid: - bpnl: bpn:legal: - owl: http://www.w3.org/2002/07/owl# - rdf: http://www.w3.org/1999/02/22-rdf-syntax-ns# - xml: http://www.w3.org/XML/1998/namespace - xsd: http://www.w3.org/2001/XMLSchema# - json: https://json-schema.org/draft/2020-12/schema# - obda: https://w3id.org/obda/vocabulary# - rdfs: http://www.w3.org/2000/01/rdf-schema# - oem: urn:oem: - - [MappingDeclaration] @collection [[ - mappingId vehicles - target <{vehicle_id}> rdf:type cx-vehicle:Vehicle ; cx-vehicle:vehicleIdentificationNumber {van}^^xsd:string; cx-vehicle:worldManufaturerId bpnl:{oem_bpnl}; cx-vehicle:productionDate {production_date}^^xsd:date. - source SELECT vehicle_id, van, oem_bpnl, production_date FROM vehicles - - mappingId partsvehicle - target <{gearbox_id}> cx-vehicle:isPartOf <{vehicle_id}> . - source SELECT vehicle_id, gearbox_id FROM vehicles - - mappingId vehicleparts - target <{vehicle_id}> cx-vehicle:hasPart <{gearbox_id}> . - source SELECT vehicle_id, gearbox_id FROM vehicles - - mappingId parts - target <{gearbox_id}> rdf:type cx-vehicle:Part ; cx-vehicle:id {gearbox_id}^^xsd:string; cx-vehicle:name {partTypeInformation_nameAtManufacturer}^^xsd:string; cx-vehicle:number {partTypeInformation_manufacturerPartId}^^xsd:string; cx-vehicle:supplier bpnl:{gearbox_manufacturer_bpnl}; cx-vehicle:productionDate {production_date}^^xsd:date . - source SELECT gearbox_id, production_date, 'Differential Gear' as partTypeInformation_nameAtManufacturer, gearbox_manufacturer_bpnl, 'Dummy Gearbox' as partTypeInformation_manufacturerPartId FROM vehicles - - mappingId partAnalysis - target oem:{newest_telematics_id} cx-reliability:analysedObject <{gearbox_id}>. - source SELECT gearbox_id, newest_telematics_id FROM vehicles - - mappingId analysisInformation - target oem:{id} rdf:type cx-reliability:Analysis; cx-reliability:operatingHoursOfVehicle {metadata_status_operatingHours}^^xsd:float; cx-core:startDateTime {metadata_status_date}^^xsd:dateTime; cx-core:endDateTime {metadata_status_date}^^xsd:dateTime; cx-reliability:mileageOfVehicle {metadata_status_mileage}^^xsd:int. - source SELECT id, metadata_status_operatingHours, metadata_status_date, metadata_status_mileage FROM reading - - mappingId analysisResult - target oem:{id} cx-reliability:result oem:{id}/{index}. - source SELECT id, index FROM loadspectra - - mappingId loadspectrum - target oem:{id}/{index} rdf:type cx-reliability:LoadSpectrum; cx-core:id {metadata_componentDescription}^^xsd:string; cx-core:name {metadata_projectDescription}^^xsd:string; cx-reliability:description {metadata_routeDescription}^^xsd:string; cx-reliability:countingValue {body_counts_countsName}^^xsd:string; cx-reliability:countingUnit {header_countingUnit}^^xsd:string; cx-reliability:countingMethod {header_countingMethod}^^xsd:string; cx-reliability:channels {header_channels}^^json:Object; cx-reliability:classes {body_classes}^^json:Object; cx-reliability:values {body_counts_countsList}^^json:Object . - source SELECT id, index, metadata_componentDescription, metadata_projectDescription, metadata_routeDescription, header_countingUnit, header_countingMethod, header_channels, body_classes, body_counts_countsName, body_counts_countsList FROM loadspectra - - ]] -``` - -## Graph asset for the data binding -To enable the knowledge agent's matchmaking agent to find the data bindings, a graph asset has to be registered at the EDC. This asset must have a property "rdfs:isDefinedBy" that defines the shape of the provided graph. - -``` -",,,", - "cx-common:implementsProtocol": "cx-common:Protocol?w3c:http:SPARQL", - "sh:shapesGraph": "@prefix cx-common: . \n@prefix : .\n@prefix cx-tele: .\n@prefix owl: .\n@prefix rdf: .\n@prefix xsd: .\n@prefix sh: .@prefix : .\n\n:OemLoadSpectrum rdf:type sh:NodeShape ;\n sh:targetClass cx-tele:LoadSpectrum ;\n sh:property [\n sh:path cx-tele:provisionedBy ;\n sh:hasValue \n ] ;\n sh:property [\n sh:path cx-tele:Version ;\n sh:hasValue \"0\"^^xsd:long \n ] ;\n sh:property [\n sh:path cx-tele:component ;\n sh:class :SupplierParts \n ] .\n\n:SupplierParts rdf:type sh:NodeShape ;\n sh:targetClass cx-tele:VehicleComponent ;\n sh:property [\n sh:path cx-tele:isProducedBy ;\n sh:hasValue \n ] .\n" -``` -For more information see the Knowledge Agent KIT. - -# Service Bindings -Applies to: *RuL calculation service provider* - -## Overview -In most cases, services are provided via REST APIs and are using JSON as input and output format. For the RuL use case, the output format is specified by a SAMM model. -To include those services into the knowledge graph, you have to bind/map them to the underlying ontologies. - -## Service mapping tool -To bind a service to the knowledge graph, you must use a **remoting agent**, also called the **service binding agent**. The software **RDF4J** (see the RDF4J webpage [https://rdf4j.org/](https://rdf4j.org/)), which is under the Eclipse Distribution License (EDL), v1.0, is our tool of choice in this case. - -## Service mapping configuration -For RDF4J, a configuration must be provided that formally describes the service binding. -The configuration is written in Turtle (Terse RDF Triple Language) and has the extension **.ttl**. For more information, see the Knowledge Agent KIT. - -### RDF4J repository -The RDF4J repository is the basic configuration that refers to the service object and defines the callback endpoint for an asynchronous response of this service. - -```ttl -################################################################ -# Copyright (c) 2022,2023 T-Systems International GmbH -# Copyright (c) 2022,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022,2023 ZF Friedrichshafen AG -# Copyright (c) 2023 Allgemeine Deutsche Automobil-Club (ADAC) e.V -# Copyright (c) 2022,2023 Mercedes-Benz AG -# Copyright (c) 2022,2023 Contributors to the Catena-X Association -# -# See the NOTICE file(s) distributed with this work for additional -# information regarding copyright ownership. -# -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 -################################################################ - -[] rdf:type rep:Repository ; - rep:repositoryID "rul" ; - rdfs:label "Remainig Useful Life Functions Repository" ; - rep:repositoryImpl [ - rep:repositoryType "openrdf:SailRepository" ; - sr:sailImpl [ - sail:sailType "org.eclipse.tractusx.agents:Remoting" ; - cx-fx:supportsInvocation cx-behaviour:RemainingUsefulLife; - cx-fx:callbackAddress ; - ] - ]. -``` - -The callback address in this example is the callback address of the own RDF4J server. - -### Types to be bound -#### cx-fx:Function -Definition of the function. It defines the endpoint and describes the input and output elements (analogous to the ontology). - -```ttl -################################################################ -# Copyright (c) 2022,2023 T-Systems International GmbH -# Copyright (c) 2022,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022,2023 ZF Friedrichshafen AG -# Copyright (c) 2023 Allgemeine Deutsche Automobil-Club (ADAC) e.V -# Copyright (c) 2022,2023 Mercedes-Benz AG -# Copyright (c) 2022,2023 Contributors to the Catena-X Association -# -# See the NOTICE file(s) distributed with this work for additional -# information regarding copyright ownership. -# -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 -################################################################ - -cx-behaviour:RemainingUsefulLife rdf:type cx-fx:Function; - dcterms:description "Remaining Useful Life is an asynchronous batch invocation."@en ; - dcterms:title "Remaining Useful Life" ; - cx-fx:targetUri "https://rul.supplier.com/api/v1/routine/notification"; - cx-fx:invocationMethod "POST-JSON"; - # cx-common:authenticationKey "Authorization"; - # cx-common:authenticationCode "Basic Zdm7vsdgasfghcg=="; - cx-fx:invocationMethod "POST-JSON"; - cx-fx:invocationIdProperty "header.notificationID,content.requestRefId"; - cx-fx:callbackProperty "header.respondAssetId"; - cx-fx:input cx-behaviour:notification; - cx-fx:input cx-behaviour:sender; - cx-fx:input cx-behaviour:senderConnector; - cx-fx:input cx-behaviour:recipient; - cx-fx:input cx-behaviour:recipientConnector; - cx-fx:input cx-behaviour:recipient; - cx-fx:input cx-behaviour:recipientConnector; - cx-fx:input cx-behaviour:severity; - cx-fx:input cx-behaviour:status; - cx-fx:input cx-behaviour:targetDate; - cx-fx:input cx-behaviour:timeStamp; - cx-fx:input cx-behaviour:classification; - cx-fx:input cx-behaviour:component; - cx-fx:input cx-behaviour:observationType; - cx-fx:input cx-behaviour:statusDate; - cx-fx:input cx-behaviour:statusOperatingHours; - cx-fx:input cx-behaviour:statusMileage; - cx-fx:input cx-behaviour:observationType; - cx-fx:input cx-behaviour:metadata; - cx-fx:input cx-behaviour:countingMethod; - cx-fx:input cx-behaviour:countingValue; - cx-fx:input cx-behaviour:countingUnit; - cx-fx:input cx-behaviour:headerChannels; - cx-fx:input cx-behaviour:bodyClasses; - cx-fx:input cx-behaviour:bodyCountsList; - cx-fx:result cx-behaviour:response. -``` - -#### cx-fx:Argument -The input data that are received from the knowledge graph are converted to the desired JSON format that is requested by the service. Therefore, each value (input parameter) that is represented in the ontology as a separate object must be described as an argument which is related to the corresponding JSON path. The argument name represents the JSON path. Default values can be specified in case some values are not present in the knowledge graph. - -```ttl -cx-behaviour:recipient rdf:type cx-fx:Argument; - dcterms:description "Recipient of the notification as a BPN."@en ; - dcterms:title "Notification Recipient"; - cx-fx:argumentName "header.recipientBPN"; - cx-fx:default "anonymous". -``` - -#### cx-fx:Result -The result of the service is also a JSON string. It consists of properties and output values. -The mapping must provide all data that are defined in the ontology. -The properties are of predefined types and are mapped directly (without further descriptions and attributes). -The output values are specified each separate. - -```ttl -################################################################ -# Copyright (c) 2022,2023 T-Systems International GmbH -# Copyright (c) 2022,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022,2023 ZF Friedrichshafen AG -# Copyright (c) 2023 Allgemeine Deutsche Automobil-Club (ADAC) e.V -# Copyright (c) 2022,2023 Mercedes-Benz AG -# Copyright (c) 2022,2023 Contributors to the Catena-X Association -# -# See the NOTICE file(s) distributed with this work for additional -# information regarding copyright ownership. -# -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 -################################################################ - -cx-behaviour:response rdf:type cx-fx:Result; - dcterms:description "The asynchronous notification response."@en ; - dcterms:title "Asynchronous notification response." ; - cx-fx:callbackProperty "header.referencedNotificationID"; - cx-fx:outputProperty "content.endurancePredictorOutputs"; - cx-fx:output cx-behaviour:remainingOperatingHours; - cx-fx:output cx-behaviour:remainingRunningDistance. -``` - -#### cx-fx:ReturnValue -The output values (return values) are specified with their path in the output JSON structure and their data type. - -```ttl -################################################################ -# Copyright (c) 2022,2023 T-Systems International GmbH -# Copyright (c) 2022,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022,2023 ZF Friedrichshafen AG -# Copyright (c) 2023 Allgemeine Deutsche Automobil-Club (ADAC) e.V -# Copyright (c) 2022,2023 Mercedes-Benz AG -# Copyright (c) 2022,2023 Contributors to the Catena-X Association -# -# See the NOTICE file(s) distributed with this work for additional -# information regarding copyright ownership. -# -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 -################################################################ - -cx-behaviour:remainingOperatingHours rdf:type cx-fx:ReturnValue; - dcterms:description "Predicted Operating Hours of Remaining Useful Life Response"@en ; - dcterms:title "Remaining Useful Life Operating Hours" ; - cx-fx:valuePath "0.remainingUsefulLife.remainingOperatingHours"; - cx-fx:dataType xsd:float. -``` - -### Full Example -In this example, an asynchronous calculation service for gearbox RuL values is bound. It uses the Catena-X notification format as a container for the input data. The content of the notification is a JSON structure with a list of load spectra in it. The input format provides more than one Element (batch processing), but the RuL logic always requires exact one input per calculation. Therefore, always the first (and only the first) item of the input list is bound. - -```ttl -################################################################ -# Copyright (c) 2022,2023 T-Systems International GmbH -# Copyright (c) 2022,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -# Copyright (c) 2022,2023 ZF Friedrichshafen AG -# Copyright (c) 2023 Allgemeine Deutsche Automobil-Club (ADAC) e.V -# Copyright (c) 2022,2023 Mercedes-Benz AG -# Copyright (c) 2022,2023 Contributors to the Catena-X Association -# -# See the NOTICE file(s) distributed with this work for additional -# information regarding copyright ownership. -# -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 -################################################################ - -# -# Rdf4j configuration for a rul-specific remoting -# -@prefix rdf: . -@prefix rdfs: . -@prefix rep: . -@prefix sr: . -@prefix sail: . -@prefix sp: . -@prefix xsd: . -@prefix json: . -@prefix dcterms: . -@prefix cx-fx: . -@prefix cx-common: . -@prefix cx-core: . -@prefix cx-vehicle: . -@prefix cx-reliability: . -@prefix cx-behaviour: . - -[] rdf:type rep:Repository ; - rep:repositoryID "rul" ; - rdfs:label "Remainig Useful Life Functions Repository" ; - rep:repositoryImpl [ - rep:repositoryType "openrdf:SailRepository" ; - sr:sailImpl [ - sail:sailType "org.eclipse.tractusx.agents:Remoting" ; - cx-fx:supportsInvocation cx-behaviour:RemainingUsefulLife; - cx-fx:callbackAddress ; - ] - ]. - -cx-behaviour:RemainingUsefulLife rdf:type cx-fx:Function; - dcterms:description "Remaining Useful Life is an asynchronous batch invocation."@en ; - dcterms:title "Remaining Useful Life" ; - cx-fx:targetUri "https://rul.supplier.com/api/v1/routine/notification"; - cx-fx:invocationMethod "POST-JSON"; -# cx-common:authenticationKey "Authorization"; -# cx-common:authenticationCode "Basic AAAAAAAAAAAAA=="; - cx-fx:invocationMethod "POST-JSON"; - cx-fx:invocationIdProperty "header.notificationID,content.requestRefId"; - cx-fx:callbackProperty "header.respondAssetId"; - cx-fx:input cx-behaviour:notification; - cx-fx:input cx-behaviour:sender; - cx-fx:input cx-behaviour:senderConnector; - cx-fx:input cx-behaviour:recipient; - cx-fx:input cx-behaviour:recipientConnector; - cx-fx:input cx-behaviour:recipient; - cx-fx:input cx-behaviour:recipientConnector; - cx-fx:input cx-behaviour:severity; - cx-fx:input cx-behaviour:status; - cx-fx:input cx-behaviour:targetDate; - cx-fx:input cx-behaviour:timeStamp; - cx-fx:input cx-behaviour:classification; - cx-fx:input cx-behaviour:component; - cx-fx:input cx-behaviour:observationType; - cx-fx:input cx-behaviour:statusDate; - cx-fx:input cx-behaviour:statusOperatingHours; - cx-fx:input cx-behaviour:statusMileage; - cx-fx:input cx-behaviour:observationType; - cx-fx:input cx-behaviour:metadata; - cx-fx:input cx-behaviour:countingMethod; - cx-fx:input cx-behaviour:countingValue; - cx-fx:input cx-behaviour:countingUnit; - cx-fx:input cx-behaviour:headerChannels; - cx-fx:input cx-behaviour:bodyClasses; - cx-fx:input cx-behaviour:bodyCountsList; - cx-fx:result cx-behaviour:response. - -cx-behaviour:notification rdf:type cx-fx:Argument; - dcterms:description "A default notification output template."@en ; - dcterms:title "Notification Template"; - cx-fx:argumentName "."; - cx-fx:dataType json:Object; - cx-fx:priority "-1"^^xsd:integer; - #cx-fx:default "{ \"content\": { \"endurancePredictorInputs\": [ { } ]}}"^^json:Object. - cx-fx:default "{ \"content\": { \"endurancePredictorInputs\": [ ]}}"^^json:Object. - -cx-behaviour:sender rdf:type cx-fx:Argument; - dcterms:description "Sender of the notification as a BPN."@en ; - dcterms:title "Notification Sender"; - cx-fx:argumentName "header.senderBPN"; - cx-fx:default "anonymous". - -cx-behaviour:senderConnector rdf:type cx-fx:Argument; - dcterms:description "Sender Address of the notification as a URL."@en ; - dcterms:title "Notification Sender Address"; - cx-fx:argumentName "header.senderAddress"; - cx-fx:default "unknown". - -cx-behaviour:recipient rdf:type cx-fx:Argument; - dcterms:description "Recipient of the notification as a BPN."@en ; - dcterms:title "Notification Recipient"; - cx-fx:argumentName "header.recipientBPN"; - cx-fx:default "anonymous". - -cx-behaviour:recipientConnector rdf:type cx-fx:Argument; - dcterms:description "Recipient Address of the notification as a URL."@en ; - dcterms:title "Notification Recipient Address"; - cx-fx:argumentName "header.recipientAddress"; - cx-fx:default "unknown". - -cx-behaviour:severity rdf:type cx-fx:Argument; - dcterms:description "Severity of the notification."@en ; - dcterms:title "Notification Severity"; - cx-fx:argumentName "header.severity"; - cx-fx:dataType xsd:string; - cx-fx:default "MINOR". - -cx-behaviour:status rdf:type cx-fx:Argument; - dcterms:description "Status of the notification."@en ; - dcterms:title "Notification Status"; - cx-fx:argumentName "header.status"; - cx-fx:dataType xsd:string; - cx-fx:default "SENT". - -cx-behaviour:targetDate rdf:type cx-fx:Argument; - dcterms:description "Target Date of the notification."@en ; - dcterms:title "Notification Target Date"; - cx-fx:dataType xsd:dateTime; - cx-fx:argumentName "header.targetDate". - -cx-behaviour:timeStamp rdf:type cx-fx:Argument; - dcterms:description "Timestamp of the notification."@en ; - dcterms:title "Notification Timestamp"; - cx-fx:dataType xsd:dateTime; - cx-fx:argumentName "header.timeStamp". - -cx-behaviour:classification rdf:type cx-fx:Argument; - dcterms:description "Classification of the notification."@en ; - dcterms:title "Notification Classification"; - cx-fx:argumentName "header.classification"; - cx-fx:dataType xsd:string; - cx-fx:default "RemainingUsefulLifePredictor". - -cx-behaviour:component rdf:type cx-fx:Argument; - dcterms:description "Component of the Predicition."@en ; - dcterms:title "Predicted Component"; - cx-fx:formsBatchGroup "true"^^xsd:boolean; - cx-fx:argumentName "content.endurancePredictorInputs.0.componentId,content.endurancePredictorInputs.0.classifiedLoadSpectrum{https://w3id.org/catenax/ontology/behaviour#observationType}.targetComponentId". - -cx-behaviour:observationType rdf:type cx-fx:Argument; - dcterms:description "The type of observation made."@en ; - dcterms:title "Observation Type"; - cx-fx:argumentName "content.endurancePredictorInputs.0.classifiedLoadSpectrum{https://w3id.org/catenax/ontology/behaviour#observationType}.metadata.componentDescription"; - cx-fx:dataType xsd:string. - -cx-behaviour:metadata rdf:type cx-fx:Argument; - dcterms:description "Metadata of the Loadspectrum."@en ; - dcterms:title "Loadspectrum Metadata"; - cx-fx:argumentName "content.endurancePredictorInputs.0.classifiedLoadSpectrum{https://w3id.org/catenax/ontology/behaviour#observationType}"; - cx-fx:dataType json:Object; - cx-fx:priority "0"^^xsd:integer; - cx-fx:default "{ \"metadata\":{ \"projectDescription\": \"pnr_76543\", \"routeDescription\": \"logged\" }, \"bammId\": \"urn:bamm:io.openmanufacturing.digitaltwin:1.0.0#ClassifiedLoadSpectrum\" }"^^json:Object. - -cx-behaviour:statusDate rdf:type cx-fx:Argument; - dcterms:description "Time of Recording."@en ; - dcterms:title "Loadspectrum Recording Time"; - cx-fx:dataType xsd:dateTime; - cx-fx:argumentName "content.endurancePredictorInputs.0.classifiedLoadSpectrum{https://w3id.org/catenax/ontology/behaviour#observationType}.metadata.status.date". - -cx-behaviour:statusOperatingHours rdf:type cx-fx:Argument; - dcterms:description "Operating Hours of Target Component at Time of Recording."@en ; - dcterms:title "Loadspectrum Operating Hours"; - cx-fx:dataType xsd:float; - cx-fx:argumentName "content.endurancePredictorInputs.0.classifiedLoadSpectrum{https://w3id.org/catenax/ontology/behaviour#observationType}.metadata.status.operatingHours". - -cx-behaviour:statusMileage rdf:type cx-fx:Argument; - dcterms:description "Mileage of Component at Time of Recording."@en ; - dcterms:title "Loadspectrum Mileage"; - cx-fx:dataType xsd:int; - cx-fx:argumentName "content.endurancePredictorInputs.0.classifiedLoadSpectrum{https://w3id.org/catenax/ontology/behaviour#observationType}.metadata.status.mileage". - -cx-behaviour:countingUnit rdf:type cx-fx:Argument; - dcterms:description "Counting Unit of Load Spectrum."@en ; - dcterms:title "Loadspectrum Counting Unit"; - cx-fx:dataType xsd:string; - cx-fx:argumentName "content.endurancePredictorInputs.0.classifiedLoadSpectrum{https://w3id.org/catenax/ontology/behaviour#observationType}.header.countingUnit". - -cx-behaviour:countingValue rdf:type cx-fx:Argument; - dcterms:description "Counting Value Name of Load Spectrum."@en ; - dcterms:title "Loadspectrum Counting Value"; - cx-fx:dataType xsd:string; - cx-fx:argumentName "content.endurancePredictorInputs.0.classifiedLoadSpectrum{https://w3id.org/catenax/ontology/behaviour#observationType}.header.countingValue,content.endurancePredictorInputs.0.classifiedLoadSpectrum{https://w3id.org/catenax/ontology/behaviour#observationType}.body.counts.countsName". - -cx-behaviour:countingMethod rdf:type cx-fx:Argument; - dcterms:description "Counting Method of Load Spectrum."@en ; - dcterms:title "Loadspectrum Counting Method"; - cx-fx:dataType xsd:string; - cx-fx:argumentName "content.endurancePredictorInputs.0.classifiedLoadSpectrum{https://w3id.org/catenax/ontology/behaviour#observationType}.header.countingMethod". - -cx-behaviour:headerChannels rdf:type cx-fx:Argument; - dcterms:description "Channels of Load Spectrum."@en ; - dcterms:title "Loadspectrum Channels"; - cx-fx:dataType json:Object; - cx-fx:argumentName "content.endurancePredictorInputs.0.classifiedLoadSpectrum{https://w3id.org/catenax/ontology/behaviour#observationType}.header.channels". - -cx-behaviour:bodyClasses rdf:type cx-fx:Argument; - dcterms:description "Classes of Load Spectrum."@en ; - dcterms:title "Loadspectrum Classes"; - cx-fx:dataType json:Object; - cx-fx:argumentName "content.endurancePredictorInputs.0.classifiedLoadSpectrum{https://w3id.org/catenax/ontology/behaviour#observationType}.body.classes". - -cx-behaviour:bodyCountsList rdf:type cx-fx:Argument; - dcterms:description "Counts List of Load Spectrum."@en ; - dcterms:title "Loadspectrum Counts List"; - cx-fx:dataType json:Object; - cx-fx:argumentName "content.endurancePredictorInputs.0.classifiedLoadSpectrum{https://w3id.org/catenax/ontology/behaviour#observationType}.body.counts.countsList". - -cx-behaviour:response rdf:type cx-fx:Result; - dcterms:description "The asynchronous notification response."@en ; - dcterms:title "Asynchronous notification response." ; - cx-fx:callbackProperty "header.referencedNotificationID"; - cx-fx:outputProperty "content.endurancePredictorOutputs"; - cx-fx:output cx-behaviour:remainingOperatingHours; - cx-fx:output cx-behaviour:remainingRunningDistance. - -cx-behaviour:remainingOperatingHours rdf:type cx-fx:ReturnValue; - dcterms:description "Predicted Operating Hours of Remaining Useful Life Response"@en ; - dcterms:title "Remaining Useful Life Operating Hours" ; - cx-fx:valuePath "0.remainingUsefulLife.remainingOperatingHours"; - cx-fx:dataType xsd:float. - -cx-behaviour:remainingRunningDistance rdf:type cx-fx:ReturnValue; - dcterms:description "Predicted Distance of Remaining Useful Life Response"@en ; - dcterms:title "Remaining Useful Life Distance" ; - cx-fx:valuePath "0.remainingUsefulLife.remainingRunningDistance"; - cx-fx:dataType xsd:int. -``` - -## Graph asset for the service binding -To enable the knowledge agent's matchmaking agent to find the service binding, a graph asset has to be registered at the EDC. This asset must have a property "rdfs:isDefinedBy" that defines the shape of the provided graph. - -``` -",,,", - "cx-common:implementsProtocol": "cx-common:Protocol?w3c:http:SPARQL", - "sh:shapesGraph": "@prefix cx-common: . \n@prefix : .\n@prefix cx-prognosis: .\n@prefix cx-fx: .\n@prefix owl: .\n@prefix rdf: .\n@prefix xsd: .\n@prefix sh: .\n\n:Tier1LifetimePrognosis rdf:type sh:NodeShape ;\n sh:targetClass cx-prognosis:Function ;\n sh:property [\n sh:path cx-prognosis:provisionedBy ;\n sh:hasValue ]." -``` -For more information see the [Knowledge Agent KIT](https://bit.ly/tractusx-agents). diff --git a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/assets/RKIT_Building_Block_Architecture_Overview_V1.png b/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/assets/RKIT_Building_Block_Architecture_Overview_V1.png deleted file mode 100644 index a23a972e5a1..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/assets/RKIT_Building_Block_Architecture_Overview_V1.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/assets/RKIT_business_process_1.png b/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/assets/RKIT_business_process_1.png deleted file mode 100644 index f93dbe77d10..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/assets/RKIT_business_process_1.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/assets/RKIT_business_process_2.png b/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/assets/RKIT_business_process_2.png deleted file mode 100644 index a796f9c6537..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/assets/RKIT_business_process_2.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/assets/rul_architecture_overview.png b/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/assets/rul_architecture_overview.png deleted file mode 100644 index e40d7f88b3d..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/assets/rul_architecture_overview.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/page_adoption-view.md deleted file mode 100644 index d3f186c2f7b..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/page_adoption-view.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -id: Adoption View Remaining Useful Life Kit -title: Adoption View -description: 'Remaining Useful Life Kit' -sidebar_position: 2 ---- - -![Remaining Useful Life kit banner](@site/static/img/doc-rul_header-minified.png) - -### Remaining Useful Life Kit - - -## Vision & Mission - -### Vision - -Calculating Remaining Useful Life is a business. - -The *Remaining Useful Life* Kit aims at novel business models based on the calculation of *Remaining Useful Life*. The wide range of possible applications starts with product development and finally extends to recycling: the entire product life cycle offers potential. The *Remaining Useful Life* Kit provides efficient support in planning, designing, building, using and operating *Remaining Useful Life* Services and applications based on them. - -### Mission - -The *Remaining Useful Life* Kit comes with the necessary Catena-X standards for damage models and remaining useful life statements. On this basis, interoperable solutions are created. The KIT includes tools for the simple implementation of component-specific damage models and for linking the damage models with dynamic input data. All components are easily adaptable to specific applications and simplify the journey to the finished service. - - - -### Customer Journey - -With the *Remaining Useful Life* Kit, we support the Catena-X customer journey for our adopters and solutions providers. - - - -## Business Value - -Through the standardized specifications described in the *Remaining Useful Life* Kit – for example the semantic models and APIs – application and service providers can reduce investment and implementation costs to integrate new Catena-X services. Furthermore, application, data, model and service providers can enter potential new markets within the entire product life cycle. - -## Use Case - -- OEM, TIER-X: In the early development phase, components can be designed using digital prototypes based on component-specific damage calculation. The load data required for this comes from simulation or measurement in the digital twin. - -- Tier-X: The overall product range becomes more attractive in the offer phase when model-based damage calculation is included as a product-related service. - -- During the usage phase, OEMs, car dealers and automotive clubs can further interpret the *Remaining Useful Life* calculation for a vehicle evaluation and offer it as vehicle-related services for their end customers and fleet operators. - -- Even during the usage phase, but particularly during the recycling phase, OEMs, Tier-X, automotive clubs, car dealers, insurers, fleet operators and recyclers benefit from precise residual value analyses of the entire vehicle and its components on the basis of component-specific damage calculation. - - -### Status Quo - -Within company limits, the calculation of component damage based on internally available data and models is already state of the art. However, across company boundaries, there are only individual, complex and not generally available options for calculating component-specific damage. - -### Today’s challenge - -For successful implementation, the following challenges must be addressed: - -- the correct allocation of the appropriate damage calculation to the respective component -- recording and providing the necessary input variables -- an easy-to-interpret preparation of results -- easy scalability across company boundaries - -### Benefits - -**OEMs and big suppliers** benefit from cost savings, improved quality and shorter development times through customer-data-based, precise design of individual components and the entire system. The decisive hub is created by using load data and damage models across company boundaries — always in compliance with IP and data protection. - -It will be easier for **SMEs** to use product-related *Remaining Useful Life* services, for example for design and recycling. - -Generating added value by providing *Remaining Useful Life* services offers new areas of business for **solution providers**. These can be the suppliers themselves, pure service providers or so-called value-added resellers (VAR). - -## Logic & Schema - -### Building Block View -The architecture image describes the interaction between the RuL Service and the Knowledge Agent components. - -![Building Block Architecture Overview](assets/RKIT_Building_Block_Architecture_Overview_V1.png) - -The Consumer A is only allowed to communicate via the Data Provider B. -The indirect communication ensures data sovereignty for Data Provider B (as B might not want to advertise its providers). Thus, the communication of the RuL result is to Data Provider B and is not allowed to deliver the result directly to A. - -### RuL Components -|Subsystem|Description| -|---------|-----------| -|Data Consuming App| This component is the app that is hosted at the Consumer and provides the end user interface. The end user can enter a vehicle identifier number (VIN) and gets back a calculated RuL value.
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.
The Matchmaking Agents are matching the (sub)graphs and negotiate appropriated graph assets with the partner EDCs.| -|Binding Agent| The Binding Agent is a restricted version of the Matchmaking Agent (subset of OWL/SparQL, e.g., without federation) which is just focused on translating Sub-Skills of a particular business domain (Bill-Of-Material, Chemical Materials, Production Sites, etc.) into proper SQL- or REST based backend system calls.
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. -![Business Process 3 Partners](assets/RKIT_business_process_1.png) -- 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: -![Business Process 3 Partners](assets/RKIT_business_process_2.png) -- 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/Archiv/Update_Juli_23_R_3.2/CX-0059-TriangleBehavioralTwinEndurancePredictorService-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 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._ - - - -Some of our relevant standards can **not yet** be downloaded from the official [Catena-X Standard Library](https://catena-x.net/de/standard-library) **as they don't have been published yet**. Here is a preview of our **standard candidates**: - -- CX - 0088 Aspect Model User Estimated Loading: - - _The semantic model for "User Estimated Loading" is the structured the input for the Endurance Estimator Service. It is basic data about the vehicle and information about the usage, previous usage as well as future usage._ - -- CX - 0089 Triangle BehaviourTwin EnduranceEstimator: - - _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 : - - _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 (UserEstimatedLoading, see CX-0088). This standard covers exclusively the illustration of the specific API endpoints._ - -## 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: 2022,2023 Allgemeine Deutsche Automobil-Club (ADAC) e.V -- SPDX-FileCopyrightText: 2022,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2022,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2022,2023 Contributors to the Eclipse Foundation \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/page_changelog.md b/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/page_changelog.md deleted file mode 100644 index 5cf5636a2df..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/page_changelog.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: Changelog Remaining Useful Life Kit -title: Changelog -description: 'Remaining Useful Life Kit' -sidebar_position: 1 ---- - -![Remaining Useful Life kit banner](@site/static/img/doc-rul_header-minified.png) - -### 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.09/kits/Behaviour Twin RuL Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/page_software-operation-view.md deleted file mode 100644 index 1c5fdd693a2..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Behaviour Twin RuL Kit/page_software-operation-view.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -id: Operation View Remaining Useful Life Kit -title: Operation View -description: 'Remaining Useful Life Kit' -sidebar_position: 3 ---- - -![Remaining Useful Life kit banner](@site/static/img/doc-rul_header-minified.png) - -### 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": ",,,", - "cx-common:implementsProtocol": "cx-common:Protocol?w3c:http:SPARQL", - "sh:shapesGraph": "@prefix cx-common: . \n@prefix : .\n@prefix cx-tele: .\n@prefix owl: .\n@prefix rdf: .\n@prefix xsd: .\n@prefix sh: .@prefix : .\n\n:OemLoadSpectrum rdf:type sh:NodeShape ;\n sh:targetClass cx-tele:LoadSpectrum ;\n sh:property [\n sh:path cx-tele:provisionedBy ;\n sh:hasValue \n ] ;\n sh:property [\n sh:path cx-tele:Version ;\n sh:hasValue \"0\"^^xsd:long \n ] ;\n sh:property [\n sh:path cx-tele:component ;\n sh:class :SupplierParts \n ] .\n\n:SupplierParts rdf:type sh:NodeShape ;\n sh:targetClass cx-tele:VehicleComponent ;\n sh:property [\n sh:path cx-tele:isProducedBy ;\n sh:hasValue \n ] .\n", - "cx-common:isFederated": "true^^xsd:boolean" - } - }, - "dataAddress": { - "id": "GraphAsset?oem=BehaviourTwinReliability", - "@type": "DataAddress", - "baseUrl": "{{provisioningAgent}}/{{reliabilityPath}}/sparql", - "type": "cx-common:Protocol?w3c:http:SPARQL", - "proxyPath": "false", - "proxyMethod": "true", - "proxyQueryParams": "true", - "proxyBody": "true", - "authKey": "{{oemBackendAuthKey}}", - "authCode": "{{oemBackendAuthCode}}" - } -} -``` -It also provides some META-Information's, which are for example, to find a specific based on isDefinedBy property. - -## Service Provider Graph Asset -The same applies for the service/function supplier. To make the service available as part of the federated knowledge graph, a Grapth Asset pointing to your Remoting Agent endpoint is needed. - -Such a Graph Asset for a service provider can look like following example: -```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#" - }, - "asset": { - "@type": "Asset", - "@id": "GraphAsset?supplier=BehaviourTwinRUL", - "properties": { - "name": "Lifetime Prognosis Service for Gearboxes", - "description": "A sample graph asset/offering referring to a specific prognosis resource.", - "version": "1.9.4-SNAPSHOT", - "contenttype": "application/json, application/xml", - "cx-common:publishedUnderContract": "Contract?supplier=Graph", - "rdf:type": "cx-common:GraphAsset", - "rdfs:isDefinedBy": ",,,", - "cx-common:implementsProtocol": "cx-common:Protocol?w3c:http:SPARQL", - "sh:shapesGraph": "@prefix cx-common: . \n@prefix : .\n@prefix cx-prognosis: .\n@prefix cx-fx: .\n@prefix owl: .\n@prefix rdf: .\n@prefix xsd: .\n@prefix sh: .\n\n:Tier1LifetimePrognosis rdf:type sh:NodeShape ;\n sh:targetClass cx-prognosis:Function ;\n sh:property [\n sh:path cx-prognosis:provisionedBy ;\n sh:hasValue ].", - "cx-common:isFederated": "true^^xsd:boolean" - } - }, - "dataAddress": { - "id": "GraphAsset?supplier=BehaviourTwinRUL", - "@type": "DataAddress", - "baseUrl": "{{remotingAgent}}/repositories/rul", - "type": "cx-common:Protocol?w3c:http:SPARQL", - "proxyPath": "false", - "proxyMethod": "true", - "proxyQueryParams": "true", - "proxyBody": "true", - "authKey": "{{supplierBackendAuthKey}}", - "authCode": "{{supplierBackendAuthCode}}" - } - } -``` - -# Deployment of RuL Skill -After the skill is defined, it has to be registered. -As described in th "KA-KIT", one have to define the Asset, Policy and Contractdefiniton as for other EDC assets. - -To bo able to invoke the sample Agent-Skill defined above, we have to deploy, or better said, to register it in our agent enabled EDC. For the registration we need, as for other EDC assets, the asset, a policy and a contract definition registration. - -**Policy Registration** -``` json -{ - "@context": { - "odrl": "http://www.w3.org/ns/odrl/2/", - "cx-common": "https://w3id.org/catenax/ontology/common#" - }, - "@type": "PolicyDefinitionRequestDto", - "@id": "Policy?consumer=Asset&mode=open", - "policy": { - "@type": "Policy", - "odrl:permission" : [{ - "odrl:action" : "USE", - "odrl:constraint" : [] - }] - } -} -``` - -**Contractdefiniton Registration** -``` json -{ - "@context": { - "cx-common": "https://w3id.org/catenax/ontology/common#" - }, - "@id": "Contract?consumer=Asset&mode=open", - "@type": "ContractDefinition", - "accessPolicyId": "Policy?consumer=Asset&mode=open", - "contractPolicyId": "Policy?consumer=Asset&mode=open", - "assetsSelector" : { - "@type" : "CriterionDto", - "operandLeft": "https://w3id.org/catenax/ontology/common#publishedUnderContract", - "operator": "=", - "operandRight": "Contract?consumer=Asset&mode=open" - } -} -``` - -**Skill Registration** - -A Skill can be registered over the AgentPlane API: -``` -curl --location 'agentPlaneEdcUrl/api/agent/skill?asset=SkillAsset%3Fconsumer%3DRemainingUsefulLife&distributionMode=PROVIDER%26contract%3DContract%3Fconsumer%3DAsset%26mode%3Dopen' \ ---header 'Content-Type: application/sparql-query' \ ---data-raw ' - -' -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Documentation BPDM/_category_.json b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Documentation BPDM/_category_.json deleted file mode 100644 index da9a4885a1c..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Documentation BPDM/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Documentation" -} diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Documentation BPDM/bpdm_arc42.md b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Documentation BPDM/bpdm_arc42.md deleted file mode 100644 index c045088b90c..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Documentation BPDM/bpdm_arc42.md +++ /dev/null @@ -1,358 +0,0 @@ ---- -id: bpdm_arc42 -title: Architecture documentation (arc42) -description: 'Architecture documentation (arc42)' -sidebar_position: 1 ---- - -![Business partner kit banner](@site/static/img/BPKitIcon.png) - -## Business Partner KIT - -## Business Partner Data Management Application for Golden Record (BPDM) - -- [Business Partner Data Management Application for Golden Record (BPDM)](#business-partner-data-management-application-for-golden-record-bpdm) -- [Introduction and Goals](#introduction-and-goals) - - [Goals Overview](#goals-overview) - - [Requirements Overview](#requirements-overview) - - [Quality Goals {#\_quality\_goals}](#quality-goals-_quality_goals) - - [Stakeholders](#stakeholders) -- [Architecture Constraints](#architecture-constraints) -- [System Scope and Context](#system-scope-and-context) - - [Business Context](#business-context) - - [Technical Context](#technical-context) -- [Solution Strategy (High Level Picture)](#solution-strategy-high-level-picture) -- [Building Block View](#building-block-view) - - [Target Architecture](#target-architecture) - - [Architecture for Release 3.2](#architecture-for-release-32) - - [Architecture for Release 3.3](#architecture-for-release-33) - - [Keycloak Authentication \& Autorization Flow](#keycloak-authentication--autorization-flow) -- [Runtime View](#runtime-view) - - [Upload Business Partner (BPN-L)](#upload-business-partner-bpn-l) -- [Deployment View](#deployment-view) -- [Crosscutting Concepts](#crosscutting-concepts) - - [Business Partner Data Management Standards](#business-partner-data-management-standards) -- [Architecture Decisions](#architecture-decisions) -- [Quality Requirements](#quality-requirements) -- [Risks and Technical Debts](#risks-and-technical-debts) -- [Glossary](#glossary) - -## Introduction and Goals - -This document describes the Catena-X Business Partner Data Management Application, short BPDM. - -In the Catena-X Automotive Network, the so-called Golden Record, together with a unique identifier, the Business Partner Number (BPN), creates an efficient solution to the increasing data retention costs. - -The Golden Record is a concept that identifies, links and harmonizes identical data on legal entites, sites and addresses from different sources (“sharing members"). During the creation of the Golden Record data, duplicates are removed, the quality within the data records is improved, missing information is added and deviations are automatically corrected. This is done using public, commercial or other agreed sources of trust and/or information. This approach reduces costs of business partner data maintenance and validation for all the companies concerned. - -The BPN, as the unique identifier of the Golden Record, can be stored as a verifiable credential used in an SSI solution so that a business partner can provide it for authentication and authorization. - -The Golden Record business partner data in combination with the BPN acts as the basis for a range of supplementary value-added services to optimize business partner data management. These are referred to as value-added services. Together with decentralized, self-determined identity management, they create a global, cross-industry standard for business partner data and a possible 360° view of the value chain. - -> ⚠️ **HINT**: A Business Partner Data cleaning as well as Golden Record Creation Process is **not** part of this reference implementation! - -**Additional Information Material**: - -- Visit BPDM on the official Catena-X Website: [bpdm_catenax_website](https://catena-x.net/en/offers/bpdm) - -## Goals Overview - -The following goals have been established for this system: - -| Priority | Goal | -| -------- | ------------------------------------------------------------------------------------------------------------ | -| 1 | Provide unique global business partner IDs within the Catena-X Network | -| 1 | Provide centralized Master Data Management for business partner data | -| 2 | Enable network-based data sharing for business partner data to increase overall data quality and reliability | -| 2 | Enable also Small and medium-sized Businesses (SMEs) to use the services | -| 3 | Provide a change history für business partner data | - -## Requirements Overview - -> :warning: **Note:** Cross-Check with CACs - -![bpdm_usecase_diagram](@site/static/img/usecase_diagram.drawio.svg) - -The following Usecases together with its requirements exist for this system: - -| Req-Id | Requirement | Explanation | -| ------- | ------------------ | ----------- | -| BPDM-R1 | Upload and curate BP data | CX Member can upload their business partner and get curated business partner information back, based on the Golden Record | -| BPDM-R2 | Provide changelog for BP | A changelog is provided to determine which changes on which date are available | -| BPDM-R3 | Provide GR | Based on the shared business partner information and external service providers a Golden Record is created | -| BPDM-R4 | Provide changelog for GR | A changelog is provided to determine which changes on which date are available | -| BPDM-R5 | Keep GR up-to-date based on external resources | Golden Records must regularly checked for changes based on external resources | -| BPDM-R6 | Provide unique business partner IDs | For each Golden Record a unique ID, the so called Business Partner Number (BPN) is created | - -## Quality Goals {#\_quality\_goals} - -| Priority | Quality Goal | Scenario | -| -------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1 | Security | All users and services which access the Golden Record Application must be authenticated and authorized. Only the Golden Record Application itself is allowed to perform changes on data. Consuming services/users are only allowed to read data. In addition they are only allowed to read the specific data that belongs with this, the Data Sovereignty principles of Catena-X has to be fulfilled | -| 1 | Integrity | Only the Golden Record Application is allowed to perform changes on the data. In addition, all changes must be traceable and must be able to be rolled back | -| 1 | Legally | No natural persons are allowed to get uploaded and stored. For all other uploaded Business Partner data it is mandatory that users (CX Members) can only see their own uploaded data and that it is not possible to draw conclusions about other business partner relationships | -| 1 | Integrity & Correctness | It must be ensured that the data of the golden record which is created during the process is correct. | -| 2 | Reliability | The Golden Record Application is a central foundation in the Catena-X Network. It provides all participants and services, business partner data and the unique Business Partner Number (BPN) as identifier. Therefore the BPDM Services must be always/highly available | -| 2 | Functional Stability | Since the Golden Record Application is a central foundation in the Catena-X Network the defined standards of the API and datamodel for the associated Release Version must be fulfilled | -| 1 | Sensitivity of data | the uploaded business partner data is highly sensitive, that's why it must be ensured that no unauthorized user/system can access data which does not belong to it. More over it must be guaranteed that no one can see the business partners related to the specific Catena-X Member. | - -[](@site/static/img/iso_25010.png) - -## Stakeholders - -| Role/Name | Expectations | Example | -| ----------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | -| Big Company (CX-Member) | Company wants to have cleaned and enriched business partner data objects with a BPN. | | -| SME Company (CX-Member) | Company wants to have cleaned and enriched business partner data objects with a BPN based on a CSV data. | | -| CX Apps | Other apps and their use cases want to use the business partner data objects and the BPN for their processes | The CX Portal will use the BPN for on-boarding new companies into the network. Traceability Apps will use BPN to describe business partners | - -## Architecture Constraints - -| Constraint ID | Constraint | Description | -| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| C-1 | Software and third party software must be compliant to the Catena-X and Eclipse Foundation Guidelines/Policies [eclipse_foundation](https://www.eclipse.org/projects/dev_process/) | | -| C-2 | [Eclipse Dataspace Connector](https://github.com/eclipse-tractusx/tractusx-edc/tree/main) must be used for data transfer between different legal entities | | - -## System Scope and Context - -## Business Context - -The following figure depicts the business context setup for BPDM: - -![bpdm_business_context](@site/static/img/cx_bpdm_context_business.drawio.svg) - -The following are the various components of the business context setup: - -### Master Data Management (Catena-X Member) - -- A backend system that's operated by a company which is participating in the Catena-X Ecosystem and consuming digital services or data assets. - -### Small-Medium-Enterprises (SME) (Catena-X Member) - -- A SME company that's participating in the Catena-X Ecosystem and consuming digital services or data assets. - -### Catena-X Portal/Marketplace (CX Portal) - -- The Portal which provides an entry point for the Catena-X Members, to discover Apps that are offered in Catena-X. - -### Value Added Services - -- Value Added Services can be provided be either the Operator itself or by an external App/Service Provider. The Value Added Services provide data or service offers based on Catena-X Network data. -- There are several value added services that can be offered in context of business partner data. For example a Fraud Prevention Dashboard/API, Country Risk Scoring and so on. - -### Catena-X Operative Environment for BPDM - -- Within Catena-X there will be only one central operation environment that operates the BPDM Application. This operative environment provides the services and data for other operation environment or applications which needs to consume business partner data or golden record data. - -### Catena-X BPDM Application - -- The BPDM Application which offers services to Catena-X Members, Catena-X Use Cases and Catena-X BPDM Value Added Services for consuming and processing business partner data as well as Golden Record Information and BPN Numbers. - -### Curation & Enrichment Services - -- To offer the BPDM and Golden Record Services, Catena-X uses services from external third party service providers. These can either be operated by the operator itself or external companies that have a contract with the operator. - -## Technical Context - -The technical context setup including deployment is depicted in the following figure: -![cx_bpdm_deployment_context](@site/static/img/cx_bpdm_context_technical.drawio.svg) - -- The BPDM Application follows a microservice approach to separate the different components of the system. -- Within Catena-X there will be only one central operation environment that operates the BPDM Application. This operation environment provides the services and data for other operation environment or applications which needs to consume business partner data or golden record data. - -## Solution Strategy (High Level Picture) - -The following high level view gives a basic overview about the BPDM Components: - -![cx_bpdm_highlevel](@site/static/img/cx_bpdm_highlevel.drawio.svg) - -### BPDM Gate - -- The BPDM Gate provides the interfaces for Catena-X Members to manage their business partner data within Catena-X. -- Based on the network data a Golden Record Proposal is created. -- The BPDM Gate has its own persistence layer in which the business partner data of the Catena-X Members are stored. -- For the current reference implementation, multi-tenancy is realized via a 1:1 deployment for each Catena-X Member. This means that every Catena-X Member who shares his business partner data, has its own Gate and own persistence. - -### BPDM Pool - -- The BPDM Pool is the central instance for business partner data within Catena-X. -- The BPDM Pool provides the interface and persistance for accessing Golden Record Data and the unique Business Partner Number. -- In comparison to the BPDM Gate, there is only one central instance of the BPDM Pool. - -### BPN Issuer - -- Every participant in the Catena-X network shall have a unique Business Partner Number (BPN) according to the concept defined by the Catena-X BPN concept. The task of the BPN Generator is to issue such a BPN for a presented Business Partner data object. In that, the BPN Generator serves as the central issuing authority for BPNs within Catena-X. -- Technically, it constitutes a service that is available as a singleton within the network. -- Currently (Release 3.2) the BPN Issuer is part of the BPDM Pool. After implementing the BPDM Orchestrator, the BPN Issuer should become an independent component. - -### BPDM Orchestrator - -- The BPDM Orchestrator is **not** part of Release 3.2. -- Intention of the BPDM Orchestrator is to provide a passive component that offers standardized APIs for the BPDM Gate, BPDM Pool and Data Curation and Enrichment Services to orchestrate the process of Golden Record Creation and handling the different states a business partner record can have during this process. - -## Building Block View - -## Target Architecture - -![bpdm_target_architecture](@site/static/img/cx_bpdm_target_architecture.drawio.svg) - -## Architecture for Release 3.2 - -![bpdm_current_architecture](@site/static/img/cx_bpdm_architecture_v3_2.drawio.svg) - -### Simulator Service - -- To become more independent in testing the BPDM Application, a Simulator Service was developed. -- The Simulator Services supports the E2E Test Cases to validate the flow from BPDM Gate to BPDM Pool and back again. - -## Architecture for Release 3.3 - -The transition architecture outlines the next goal for current development phase to get one step closer to the target architecture. - -In Progress... - -## Keycloak Authentication & Autorization Flow - -```mermaid - -sequenceDiagram - participant EDC of CX Member - participant OpenIDConnect Server - participant BPDM Gate - - autonumber - - EDC of CX Member-->>OpenIDConnect Server: Send Client Credentials - OpenIDConnect Server-->>EDC of CX Member: Respond OAuth2 Token - EDC of CX Member -->> BPDM Gate: Send Request with OAuth2 Token in Authorization Header - BPDM Gate -->> OpenIDConnect Server: Validate Token - OpenIDConnect Server -->> BPDM Gate: Confirms validity of Token - BPDM Gate -->> BPDM Gate: Check "resource_access" section of OAuth Token - - -``` - -## Runtime View - -## Upload Business Partner (BPN-L) - -The diagram below describes the flow of uploading a business partner of type "legal entity". -For further information about the different business partner types (Legal Entity, Site, Address), please have a look on the Standards [CX - 0010 Business Partner Number](https://catena-x.net/de/standard-library) - -```mermaid - -sequenceDiagram - participant CX Member - participant BPDM Gate - participant BPDM Simulator - participant BPDM Pool - autonumber - - rect rgb(125, 184, 240) - Note over CX Member,BPDM Gate: EDC enabled - CX Member->>BPDM Gate: Upload Business Partner - Note left of BPDM Gate: PUT api/catena/input/legal-entities - # loop Healthcheck - # John->>John: Fight against hypochondria - # end - # Note right of John: Rational thoughts! - end - BPDM Gate-->BPDM Gate: Update input changelog - BPDM Simulator->>BPDM Gate: Poll for Business Partner changes - Note right of BPDM Gate: POST api/catena/input/changelog/search - BPDM Gate -->> BPDM Simulator: Send Changelog for Business Partners - BPDM Simulator->>BPDM Gate: Request Business Partner based on Changelog (external ID and business partner type) - Note right of BPDM Gate: POST /api/catena/input/legal-entities/search - BPDM Gate -->> BPDM Simulator: Send Business Partners - BPDM Simulator->>BPDM Gate: Request Sharing State for Business Partner based on Changelog - Note right of BPDM Gate: GET api/catena/sharing-state - BPDM Gate -->> BPDM Simulator: Send Sharing State (BPN) of Business Partners (Sharing state determines if BPN exist or not) - BPDM Simulator-->> BPDM Simulator: Update last sync changelog timestamp - BPDM Simulator->>BPDM Pool: Forward Business Partner - Note left of BPDM Pool: POST/PUT api/catena/legal-entities - opt BPN does not exist - BPDM Pool-->>BPDM Pool: Create BPN - end - BPDM Pool-->>BPDM Pool: Update Changelog - BPDM Pool-->>BPDM Simulator: Respond Business Partner with BPN - BPDM Simulator-->>BPDM Gate: Forward Business Partner with BPN - Note right of BPDM Gate: PUT api/catena/output/legal-entities - BPDM Simulator-->>BPDM Gate: Update Sharing State - Note right of BPDM Gate: PUT api/catena/sharing-state - BPDM Gate-->BPDM Gate: Link External ID with BPN - BPDM Gate-->BPDM Gate: Update Output Changelog - - loop Every x hour - rect rgb(125, 184, 240) - Note over CX Member,BPDM Gate: EDC enabled - CX Member->>BPDM Gate: Poll output changelog and fetch updates - Note left of BPDM Gate: POST api/catena/output/changelog/search - BPDM Gate-->>CX Member: Send changelog - CX Member->>BPDM Gate: Fetch updates - Note left of BPDM Gate: POST api/catena/output/legal-entities/search - BPDM Gate-->>CX Member: Send Business Partner changes - end - CX Member-->>CX Member: Update data - CX Member-->>CX Member: Update last polled timestamp - end -``` - -## Deployment View - -How to run the service - -![Deployment View](@site/static/img/deployment-view-3-2.png) - -## Crosscutting Concepts - -## Business Partner Data Management Standards - -[bpdm_standards](https://catena-x.net/de/standard-library) - -## 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) - -## 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 SME - -- 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.09/kits/Business Partner Kit/Software Development View/BPDM Bridge Dummy.postman_collection.json b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/BPDM Bridge Dummy.postman_collection.json deleted file mode 100644 index cc3a88a65ab..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/BPDM Bridge Dummy.postman_collection.json +++ /dev/null @@ -1,109 +0,0 @@ -{ - "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.09/kits/Business Partner Kit/Software Development View/BPDM Gate.postman_collection.json b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/BPDM Gate.postman_collection.json deleted file mode 100644 index 1fc510cb95f..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/BPDM Gate.postman_collection.json +++ /dev/null @@ -1,800 +0,0 @@ -{ - "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/12044444", - "host": [ - "{{Gate-Host}}" - ], - "path": [ - "api", - "catena", - "input", - "legal-entities", - "12044444" - ] - } - }, - "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 \"description\": \"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 },\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 12044444\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_legalAddress\",\n \"legalEntityExternalId\": \"12044444\",\n \"siteExternalId\": null,\n \"bpn\": \"BPNA000000000001\"\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": "Output", - "item": [ - { - "name": "Legal Entity Search", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "[\n \"12044444\"\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 \"description\": \"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 \"businessPartnerTypes\": [\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 \"businessPartnerTypes\": [\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": [] - } - ] - } - ], - "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.09/kits/Business Partner Kit/Software Development View/BPDM Pool.postman_collection.json b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/BPDM Pool.postman_collection.json deleted file mode 100644 index ecd29357457..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/BPDM Pool.postman_collection.json +++ /dev/null @@ -1,1029 +0,0 @@ -{ - "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": "Create Legal Form", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"technicalKey\": \"CUSTOM_LEGAL_FORM_test1\",\n \"name\": \"Custom Legal Form for Testing 1\",\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=100&businessPartnerType=ADDRESS", - "host": [ - "{{Pool-Host}}" - ], - "path": [ - "api", - "catena", - "identifier-types" - ], - "query": [ - { - "key": "page", - "value": "0" - }, - { - "key": "size", - "value": "100" - }, - { - "key": "businessPartnerType", - "value": "ADDRESS" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Identifier Type", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"technicalKey\": \"CUSTOM_ID_ADD_TYPE\",\n \"businessPartnerType\": \"ADDRESS\",\n \"name\": \"Custom Identifier Type of Address for Testing\",\n \"details\": [\n {\n \"country\": \"DE\",\n \"mandatory\": true\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=DE", - "host": [ - "{{Pool-Host}}" - ], - "path": [ - "api", - "catena", - "field-quality-rules", - "" - ], - "query": [ - { - "key": "country", - "value": "DE" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Legal Entity Controller", - "item": [ - { - "name": "Legal Entities", - "request": { - "method": "GET", - "header": [], - "url": { - "raw": "{{Pool-Host}}/api/catena/legal-entities?page=0&size=10", - "host": [ - "{{Pool-Host}}" - ], - "path": [ - "api", - "catena", - "legal-entities" - ], - "query": [ - { - "key": "legalName", - "value": "company", - "disabled": true - }, - { - "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 \"description\": \"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 \"description\": \"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 \"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/BPNS000000000001", - "host": [ - "{{Pool-Host}}" - ], - "path": [ - "api", - "catena", - "sites", - "BPNS000000000001" - ] - } - }, - "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", - "host": [ - "{{Pool-Host}}" - ], - "path": [ - "api", - "catena", - "addresses" - ], - "query": [ - { - "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": "countryCode", - "value": "", - "disabled": true - }, - { - "key": "page", - "value": "0", - "disabled": true - }, - { - "key": "size", - "value": "10", - "disabled": true - } - ] - } - }, - "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": [] - } - ] - } - ], - "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.09/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.09/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/business-partner-data-management-bridge-dummy.info.mdx deleted file mode 100644 index 9f966c14dad..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/business-partner-data-management-bridge-dummy.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: business-partner-data-management-bridge-dummy -title: "Business Partner Data Management Bridge Dummy" -description: "Bridge between Gate and Pool as a simple replacement for a dedicated sharing service" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 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.09/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/sidebar.js b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/sidebar.js deleted file mode 100644 index 26bad89f12c..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Bridge Dummy Api/business-partner-data-management-bridge-dummy"},{"type":"category","label":"bridge-controller","link":{"type":"generated-index","title":"bridge-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/bridge-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Bridge Dummy Api/trigger-sync","label":"Start sync between Gate and Pool","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/trigger-sync.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/trigger-sync.api.mdx deleted file mode 100644 index 3b9b10acbe7..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/trigger-sync.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: trigger-sync -title: "Start sync between Gate and Pool" -description: "Start sync between Gate and Pool" -sidebar_label: "Start sync between Gate and Pool" -hide_title: true -hide_table_of_contents: true -api: {"tags":["bridge-controller"],"operationId":"triggerSync","responses":{"200":{"description":"OK"}},"description":"Start sync between Gate and Pool","method":"post","path":"/api/bridge/sync","servers":[{"url":"http://localhost:8083","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Bridge Dummy","description":"Bridge between Gate and Pool as a simple replacement for a dedicated sharing service","version":"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 - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate.info.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate.info.mdx deleted file mode 100644 index bdc9828ebe5..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: business-partner-data-management-gate -title: "Business Partner Data Management Gate" -description: "A gate for a member to share business partner data with CatenaX" -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 Gate - - - -A gate for a member to share business partner data with CatenaX - - - \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-address-by-external-id.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-address-by-external-id.api.mdx deleted file mode 100644 index 8e342d15895..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-address-by-external-id.api.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: get-address-by-external-id -title: "Get address by external identifier" -description: "Get address by external identifier." -sidebar_label: "Get address by external identifier" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Get address by external identifier.","operationId":"getAddressByExternalId","parameters":[{"name":"externalId","in":"path","description":"External identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found address with external identifier","content":{"application/json":{"schema":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."}}}},"404":{"description":"No address found under specified external identifier"}},"method":"get","path":"/api/catena/input/addresses/{externalId}","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get address by external identifier","description":{"content":"Get address by external identifier.","type":"text/plain"},"url":{"path":["api","catena","input","addresses",":externalId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) External identifier","type":"text/plain"},"type":"any","value":"","key":"externalId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get address by external identifier - - - -Get address by external identifier. - -
Path Parameters
- -Found address with external identifier - -
Schema
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -No address found under specified external identifier - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-by-external-ids.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-by-external-ids.api.mdx deleted file mode 100644 index bce4a5ddd87..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-by-external-ids.api.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: get-addresses-by-external-ids -title: "Get page of addresses filtered by a collection of externalIds" -description: "Get page of addresses filtered by a collection of externalIds." -sidebar_label: "Get page of addresses filtered by a collection of externalIds" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Get page of addresses filtered by a collection of externalIds.","operationId":"getAddressesByExternalIds","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"The requested page of addresses","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/api/catena/input/addresses/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get page of addresses filtered by a collection of externalIds","description":{"content":"Get page of addresses filtered by a collection of externalIds.","type":"text/plain"},"url":{"path":["api","catena","input","addresses","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of addresses filtered by a collection of externalIds - - - -Get page of addresses filtered by a collection of externalIds. - -
Query Parameters
Request Body array required
  • string
- -The requested page of addresses - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-output.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-output.api.mdx deleted file mode 100644 index 004eb0c0d74..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-output.api.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: get-addresses-output -title: "Get page of addresses (Output)" -description: "Get page of addresses (Output). Can optionally be filtered by external ids." -sidebar_label: "Get page of addresses (Output)" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Get page of addresses (Output). Can optionally be filtered by external ids.","operationId":"getAddressesOutput","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"The requested page of addresses","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/api/catena/output/addresses/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get page of addresses (Output)","description":{"content":"Get page of addresses (Output). Can optionally be filtered by external ids.","type":"text/plain"},"url":{"path":["api","catena","output","addresses","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of addresses (Output) - - - -Get page of addresses (Output). Can optionally be filtered by external ids. - -
Query Parameters
Request Body array
  • string
- -The requested page of addresses - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-addresses.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-addresses.api.mdx deleted file mode 100644 index 0c4f923846d..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-addresses.api.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: get-addresses -title: "Get page of addresses" -description: "Get page of addresses." -sidebar_label: "Get page of addresses" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Get page of addresses.","operationId":"getAddresses","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"The requested page of addresses","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"get","path":"/api/catena/input/addresses","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get page of addresses","description":{"content":"Get page of addresses.","type":"text/plain"},"url":{"path":["api","catena","input","addresses"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of addresses - - - -Get page of addresses. - -
Query Parameters
- -The requested page of addresses - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-input-changelog.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-input-changelog.api.mdx deleted file mode 100644 index d459bafbcdf..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-input-changelog.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-input-changelog -title: "Get business partner changelog entries for changes to the business partner input data" -description: "Get business partner changelog entries for changes to the business partner input data. Filter by list external id, from timestamp and/or lsa type" -sidebar_label: "Get business partner changelog entries for changes to the business partner input data" -hide_title: true -hide_table_of_contents: true -api: {"tags":["changelog-controller"],"description":"Get business partner changelog entries for changes to the business partner input data. Filter by list external id, from timestamp and/or lsa type","operationId":"getInputChangelog","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"fromTime":{"type":"string","format":"date-time"},"externalIds":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"lsaTypes":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["LEGAL_ENTITY","SITE","ADDRESS"]}}}}}},"required":true},"responses":{"200":{"description":"The changelog entries for the specified parameters","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"externalId":{"type":"string"},"businessPartnerType":{"type":"string","enum":["LEGAL_ENTITY","SITE","ADDRESS"]},"modifiedAt":{"type":"string","format":"date-time"}},"description":"Changelog entry for a business partner"}},"invalidEntries":{"type":"integer","format":"int32"},"errors":{"type":"array","items":{"title":"ErrorInfo","type":"object","properties":{"errorCode":{"type":"string","description":"ChangeLogOutputError","enum":["ExternalIdNotFound"]},"message":{"type":"string"},"entityKey":{"type":"string"}},"description":"Holds information about failures"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/api/catena/input/changelog/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":{"fromTime":"2023-06-26","externalIds":["string"],"lsaTypes":["LEGAL_ENTITY"]},"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get business partner changelog entries for changes to the business partner input data","description":{"content":"Get business partner changelog entries for changes to the business partner input data. Filter by list external id, from timestamp and/or lsa type","type":"text/plain"},"url":{"path":["api","catena","input","changelog","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get business partner changelog entries for changes to the business partner input data - - - -Get business partner changelog entries for changes to the business partner input data. Filter by list external id, from timestamp and/or lsa type - -
Query Parameters
Request Body required
- -The changelog entries for the specified parameters - -
Schema
    content object[]
    errors object[]
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-by-external-ids.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-by-external-ids.api.mdx deleted file mode 100644 index 81de19a3459..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-by-external-ids.api.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: get-legal-entities-by-external-ids -title: "Get page of legal-entities filtered by a collection of externalIds" -description: "Get page of legal-entities filtered by a collection of externalIds." -sidebar_label: "Get page of legal-entities filtered by a collection of externalIds" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Get page of legal-entities filtered by a collection of externalIds.","operationId":"getLegalEntitiesByExternalIds","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"The requested page of legal-entities","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"legalNameParts":{"type":"array","items":{"type":"string"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"},"issuingBody":{"type":"string","description":"Body which issued the identifier"}},"description":"Identifier record for a legal entity"}},"legalShortName":{"type":"string","description":"Abbreviated name or shorthand"},"legalForm":{"type":"string","description":"Technical key of the legal form"},"states":{"type":"array","items":{"type":"object","properties":{"officialDenotation":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record of a legal entity"}},"classifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Name of the classification"},"code":{"type":"string","description":"Identifying code of the classification, if applicable"},"type":{"type":"string","description":"Type of specified classification","enum":["NACE","NAF","NAICS","SIC"]}},"description":"Classification record for a business partner"}},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"legalAddress":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."},"externalId":{"type":"string"}},"description":"Legal entity with external id"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/api/catena/input/legal-entities/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get page of legal-entities filtered by a collection of externalIds","description":{"content":"Get page of legal-entities filtered by a collection of externalIds.","type":"text/plain"},"url":{"path":["api","catena","input","legal-entities","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of legal-entities filtered by a collection of externalIds - - - -Get page of legal-entities filtered by a collection of externalIds. - -
Query Parameters
Request Body array required
  • string
- -The requested page of legal-entities - -
Schema
    content object[]
    - -Collection of results in the page - -
    identifiers object[]
    states object[]
    classifications object[]
    legalAddress object
    - -Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address. - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-output.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-output.api.mdx deleted file mode 100644 index 5fc44e46e59..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-output.api.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: get-legal-entities-output -title: "Get page of legal entities" -description: "Get page of legal entities. Can optionally be filtered by external ids." -sidebar_label: "Get page of legal entities" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Get page of legal entities. Can optionally be filtered by external ids.","operationId":"getLegalEntitiesOutput","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"The requested page of legal entities","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"},"issuingBody":{"type":"string","description":"Body which issued the identifier"}},"description":"Identifier record for a legal entity"}},"legalShortName":{"type":"string","description":"Abbreviated name or shorthand"},"legalForm":{"type":"string","description":"Technical key of the legal form"},"states":{"type":"array","items":{"type":"object","properties":{"officialDenotation":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record of a legal entity"}},"classifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Name of the classification"},"code":{"type":"string","description":"Identifying code of the classification, if applicable"},"type":{"type":"string","description":"Type of specified classification","enum":["NACE","NAF","NAICS","SIC"]}},"description":"Classification record for a business partner"}},"legalNameParts":{"type":"array","items":{"type":"string"}},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"legalAddress":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."},"externalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Legal entity with external id"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/api/catena/output/legal-entities/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get page of legal entities","description":{"content":"Get page of legal entities. Can optionally be filtered by external ids.","type":"text/plain"},"url":{"path":["api","catena","output","legal-entities","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of legal entities - - - -Get page of legal entities. Can optionally be filtered by external ids. - -
Query Parameters
Request Body array
  • string
- -The requested page of legal entities - -
Schema
    content object[]
    - -Collection of results in the page - -
    identifiers object[]
    states object[]
    classifications object[]
    legalAddress object
    - -Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address. - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities.api.mdx deleted file mode 100644 index 889b350e23e..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities.api.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: get-legal-entities -title: "Get page of legal entities" -description: "Get page of legal entities." -sidebar_label: "Get page of legal entities" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Get page of legal entities.","operationId":"getLegalEntities","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"The requested page of legal entities","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"legalNameParts":{"type":"array","items":{"type":"string"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"},"issuingBody":{"type":"string","description":"Body which issued the identifier"}},"description":"Identifier record for a legal entity"}},"legalShortName":{"type":"string","description":"Abbreviated name or shorthand"},"legalForm":{"type":"string","description":"Technical key of the legal form"},"states":{"type":"array","items":{"type":"object","properties":{"officialDenotation":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record of a legal entity"}},"classifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Name of the classification"},"code":{"type":"string","description":"Identifying code of the classification, if applicable"},"type":{"type":"string","description":"Type of specified classification","enum":["NACE","NAF","NAICS","SIC"]}},"description":"Classification record for a business partner"}},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"legalAddress":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."},"externalId":{"type":"string"}},"description":"Legal entity with external id"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"get","path":"/api/catena/input/legal-entities","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get page of legal entities","description":{"content":"Get page of legal entities.","type":"text/plain"},"url":{"path":["api","catena","input","legal-entities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of legal entities - - - -Get page of legal entities. - -
Query Parameters
- -The requested page of legal entities - -
Schema
    content object[]
    - -Collection of results in the page - -
    identifiers object[]
    states object[]
    classifications object[]
    legalAddress object
    - -Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address. - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entity-by-external-id.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entity-by-external-id.api.mdx deleted file mode 100644 index 16bf05cf834..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entity-by-external-id.api.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: get-legal-entity-by-external-id -title: "Get legal entity by external identifier" -description: "Get legal entity by external identifier." -sidebar_label: "Get legal entity by external identifier" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Get legal entity by external identifier.","operationId":"getLegalEntityByExternalId","parameters":[{"name":"externalId","in":"path","description":"External identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found legal entity with external identifier","content":{"application/json":{"schema":{"type":"object","properties":{"legalNameParts":{"type":"array","items":{"type":"string"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"},"issuingBody":{"type":"string","description":"Body which issued the identifier"}},"description":"Identifier record for a legal entity"}},"legalShortName":{"type":"string","description":"Abbreviated name or shorthand"},"legalForm":{"type":"string","description":"Technical key of the legal form"},"states":{"type":"array","items":{"type":"object","properties":{"officialDenotation":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record of a legal entity"}},"classifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Name of the classification"},"code":{"type":"string","description":"Identifying code of the classification, if applicable"},"type":{"type":"string","description":"Type of specified classification","enum":["NACE","NAF","NAICS","SIC"]}},"description":"Classification record for a business partner"}},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"legalAddress":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."},"externalId":{"type":"string"}},"description":"Legal entity with external id"}}}},"404":{"description":"No legal entity found under specified external identifier"}},"method":"get","path":"/api/catena/input/legal-entities/{externalId}","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get legal entity by external identifier","description":{"content":"Get legal entity by external identifier.","type":"text/plain"},"url":{"path":["api","catena","input","legal-entities",":externalId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) External identifier","type":"text/plain"},"type":"any","value":"","key":"externalId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get legal entity by external identifier - - - -Get legal entity by external identifier. - -
Path Parameters
- -Found legal entity with external identifier - -
Schema
    identifiers object[]
    states object[]
    classifications object[]
    legalAddress object
    - -Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address. - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -No legal entity found under specified external identifier - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-output-changelog.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-output-changelog.api.mdx deleted file mode 100644 index 2bafed8097a..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-output-changelog.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-output-changelog -title: "Get business partner changelog entries for changes to the business partner output data" -description: "Get business partner changelog entries for changes to the business partner output data. Filter by list external id, from timestamp and/or lsa type" -sidebar_label: "Get business partner changelog entries for changes to the business partner output data" -hide_title: true -hide_table_of_contents: true -api: {"tags":["changelog-controller"],"description":"Get business partner changelog entries for changes to the business partner output data. Filter by list external id, from timestamp and/or lsa type","operationId":"getOutputChangelog","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"fromTime":{"type":"string","format":"date-time"},"externalIds":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"lsaTypes":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["LEGAL_ENTITY","SITE","ADDRESS"]}}}}}},"required":true},"responses":{"200":{"description":"The changelog entries for the specified parameters","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"externalId":{"type":"string"},"businessPartnerType":{"type":"string","enum":["LEGAL_ENTITY","SITE","ADDRESS"]},"modifiedAt":{"type":"string","format":"date-time"}},"description":"Changelog entry for a business partner"}},"invalidEntries":{"type":"integer","format":"int32"},"errors":{"type":"array","items":{"title":"ErrorInfo","type":"object","properties":{"errorCode":{"type":"string","description":"ChangeLogOutputError","enum":["ExternalIdNotFound"]},"message":{"type":"string"},"entityKey":{"type":"string"}},"description":"Holds information about failures"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/api/catena/output/changelog/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":{"fromTime":"2023-06-26","externalIds":["string"],"lsaTypes":["LEGAL_ENTITY"]},"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get business partner changelog entries for changes to the business partner output data","description":{"content":"Get business partner changelog entries for changes to the business partner output data. Filter by list external id, from timestamp and/or lsa type","type":"text/plain"},"url":{"path":["api","catena","output","changelog","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get business partner changelog entries for changes to the business partner output data - - - -Get business partner changelog entries for changes to the business partner output data. Filter by list external id, from timestamp and/or lsa type - -
Query Parameters
Request Body required
- -The changelog entries for the specified parameters - -
Schema
    content object[]
    errors object[]
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-sharing-states.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-sharing-states.api.mdx deleted file mode 100644 index 085b10788e4..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-sharing-states.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-sharing-states -title: "Get sharing states (including error info and BPN) for business partners, optionally filtered by LSA type and external ID" -description: "Get sharing states (including error info and BPN) for business partners, optionally filtered by LSA type and external ID" -sidebar_label: "Get sharing states (including error info and BPN) for business partners, optionally filtered by LSA type and external ID" -hide_title: true -hide_table_of_contents: true -api: {"tags":["sharing-state-controller"],"operationId":"getSharingStates","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}},{"name":"lsaType","in":"query","description":"LSA Type","required":false,"schema":{"type":"string","enum":["LEGAL_ENTITY","SITE","ADDRESS"]}},{"name":"externalIds","in":"query","description":"External identifiers","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Page of sharing states","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"lsaType":{"type":"string","description":"LSA Type","enum":["LEGAL_ENTITY","SITE","ADDRESS"]},"externalId":{"type":"string","description":"External identifier"},"sharingStateType":{"type":"string","description":"Type of sharing state","enum":["Pending","Success","Error"]},"sharingErrorCode":{"type":"string","description":"BusinessPartnerSharingError","enum":["SharingProcessError","SharingTimeout","BpnNotInPool"]},"sharingErrorMessage":{"type":"string","description":"Sharing error message (for error)"},"bpn":{"type":"string","description":"BPN (for success)"},"sharingProcessStarted":{"type":"string","description":"Sharing process started (not updated if null)","format":"date-time"}}}}},"description":"Paginated collection of results"}}}}},"description":"Get sharing states (including error info and BPN) for business partners, optionally filtered by LSA type and external ID","method":"get","path":"/api/catena/sharing-state","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get sharing states (including error info and BPN) for business partners, optionally filtered by LSA type and external ID","description":{"type":"text/plain"},"url":{"path":["api","catena","sharing-state"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""},{"disabled":false,"description":{"content":"LSA Type","type":"text/plain"},"key":"lsaType","value":""},{"disabled":false,"description":{"content":"External identifiers","type":"text/plain"},"key":"externalIds","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get sharing states (including error info and BPN) for business partners, optionally filtered by LSA type and external ID - - - -Get sharing states (including error info and BPN) for business partners, optionally filtered by LSA type and external ID - -
Query Parameters
- -Page of sharing states - -
Schema
    content object[]
    - -Collection of results in the page - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-site-by-external-id.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-site-by-external-id.api.mdx deleted file mode 100644 index 8df46df23bc..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-site-by-external-id.api.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: get-site-by-external-id -title: "Get site by external identifier" -description: "Get site by external identifier." -sidebar_label: "Get site by external identifier" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Get site by external identifier.","operationId":"getSiteByExternalId","parameters":[{"name":"externalId","in":"path","description":"External identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found site with external identifier","content":{"application/json":{"schema":{"type":"object","properties":{"nameParts":{"type":"array","description":"Parts that make up the name of that site","items":{"type":"string","description":"Parts that make up the name of that site"}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record of a site"}},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"mainAddress":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"}},"description":"Site with legal entity reference"}}}},"404":{"description":"No site found under specified external identifier"}},"method":"get","path":"/api/catena/input/sites/{externalId}","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get site by external identifier","description":{"content":"Get site by external identifier.","type":"text/plain"},"url":{"path":["api","catena","input","sites",":externalId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) External identifier","type":"text/plain"},"type":"any","value":"","key":"externalId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get site by external identifier - - - -Get site by external identifier. - -
Path Parameters
- -Found site with external identifier - -
Schema
    states object[]
    mainAddress object
    - -Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address. - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -No site found under specified external identifier - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-sites-by-external-ids.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-sites-by-external-ids.api.mdx deleted file mode 100644 index bd1bdfb72b7..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-sites-by-external-ids.api.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: get-sites-by-external-ids -title: "Get page of sites filtered by a collection of externalIds" -description: "Get page of sites filtered by a collection of externalIds." -sidebar_label: "Get page of sites filtered by a collection of externalIds" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Get page of sites filtered by a collection of externalIds.","operationId":"getSitesByExternalIds","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"The requested page of sites","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"nameParts":{"type":"array","description":"Parts that make up the name of that site","items":{"type":"string","description":"Parts that make up the name of that site"}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record of a site"}},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"mainAddress":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"}},"description":"Site with legal entity reference"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/api/catena/input/sites/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get page of sites filtered by a collection of externalIds","description":{"content":"Get page of sites filtered by a collection of externalIds.","type":"text/plain"},"url":{"path":["api","catena","input","sites","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of sites filtered by a collection of externalIds - - - -Get page of sites filtered by a collection of externalIds. - -
Query Parameters
Request Body array required
  • string
- -The requested page of sites - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    mainAddress object
    - -Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address. - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-sites-output.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-sites-output.api.mdx deleted file mode 100644 index 765041f2c37..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-sites-output.api.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: get-sites-output -title: "Get page of sites" -description: "Get page of sites. Can optionally be filtered by external ids." -sidebar_label: "Get page of sites" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Get page of sites. Can optionally be filtered by external ids.","operationId":"getSitesOutput","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"The requested page of sites","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"nameParts":{"type":"array","description":"Parts that make up the name of that site","items":{"type":"string","description":"Parts that make up the name of that site"}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record of a site"}},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"mainAddress":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Site with legal entity reference"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/api/catena/output/sites/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get page of sites","description":{"content":"Get page of sites. Can optionally be filtered by external ids.","type":"text/plain"},"url":{"path":["api","catena","output","sites","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of sites - - - -Get page of sites. Can optionally be filtered by external ids. - -
Query Parameters
Request Body array
  • string
- -The requested page of sites - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    mainAddress object
    - -Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address. - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-sites.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-sites.api.mdx deleted file mode 100644 index 5b99105a49a..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/get-sites.api.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: get-sites -title: "Get page of sites" -description: "Get page of sites." -sidebar_label: "Get page of sites" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Get page of sites.","operationId":"getSites","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"The requested page of sites","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"nameParts":{"type":"array","description":"Parts that make up the name of that site","items":{"type":"string","description":"Parts that make up the name of that site"}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record of a site"}},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"mainAddress":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"}},"description":"Site with legal entity reference"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"get","path":"/api/catena/input/sites","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get page of sites","description":{"content":"Get page of sites.","type":"text/plain"},"url":{"path":["api","catena","input","sites"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of sites - - - -Get page of sites. - -
Query Parameters
- -The requested page of sites - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    mainAddress object
    - -Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address. - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/put-addresses-output.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/put-addresses-output.api.mdx deleted file mode 100644 index 8109902d598..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/put-addresses-output.api.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: put-addresses-output -title: "Create or update output addresses." -description: "Create or update addresses (Output). Updates instead of creating a new address if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of addresses in the request is limited to 100 entries." -sidebar_label: "Create or update output addresses." -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Create or update addresses (Output). Updates instead of creating a new address if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of addresses in the request is limited to 100 entries.","operationId":"putAddressesOutput","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."}}}},"required":true},"responses":{"200":{"description":"Addresses were successfully updated or created","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"On malformed address request"}},"method":"put","path":"/api/catena/output/addresses","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":[{"nameParts":["string"],"states":[{"description":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","street":{"namePrefix":"string","additionalNamePrefix":"string","name":"string","additionalNameSuffix":"string","houseNumber":"string","milestone":"string","direction":"string","nameSuffix":"string"},"administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","district":"string","companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","administrativeAreaLevel1":"string","deliveryServiceNumber":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string"},"roles":["SUPPLIER"],"externalId":"string","legalEntityExternalId":"string","siteExternalId":"string","bpn":"string"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Create or update output addresses.","description":{"content":"Create or update addresses (Output). Updates instead of creating a new address if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of addresses in the request is limited to 100 entries.","type":"text/plain"},"url":{"path":["api","catena","output","addresses"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create or update output addresses. - - - -Create or update addresses (Output). Updates instead of creating a new address if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of addresses in the request is limited to 100 entries. - -
Request Body array required
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -Addresses were successfully updated or created - -
Schema
  • object
- -On malformed address request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/sidebar.js b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/sidebar.js deleted file mode 100644 index 6c98c11afdf..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate"},{"type":"category","label":"sharing-state-controller","link":{"type":"generated-index","title":"sharing-state-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/sharing-state-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-sharing-states","label":"Get sharing states (including error info and BPN) for business partners, optionally filtered by LSA type and external ID","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/upsert-sharing-state","label":"Insert/update sharing state (including error info and BPN) for business partner with LSA type and external ID","className":"api-method put"}]},{"type":"category","label":"site-controller","link":{"type":"generated-index","title":"site-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/site-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites-output","label":"Create or update output sites.","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-sites","label":"Get page of sites","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites","label":"Create or update sites.","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-sites-output","label":"Get page of sites","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-sites-by-external-ids","label":"Get page of sites filtered by a collection of externalIds","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-site-by-external-id","label":"Get site by external identifier","className":"api-method get"}]},{"type":"category","label":"legal-entity-controller","link":{"type":"generated-index","title":"legal-entity-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/legal-entity-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities-output","label":"Create or update output legal entities.","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities","label":"Get page of legal entities","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities","label":"Create or update legal entities.","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-output","label":"Get page of legal entities","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-by-external-ids","label":"Get page of legal-entities filtered by a collection of externalIds","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entity-by-external-id","label":"Get legal entity by external identifier","className":"api-method get"}]},{"type":"category","label":"address-controller","link":{"type":"generated-index","title":"address-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/address-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/put-addresses-output","label":"Create or update output addresses.","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-addresses","label":"Get page of addresses","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/upsert-addresses","label":"Create or update addresses.","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-output","label":"Get page of addresses (Output)","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-by-external-ids","label":"Get page of addresses filtered by a collection of externalIds","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-address-by-external-id","label":"Get address by external identifier","className":"api-method get"}]},{"type":"category","label":"changelog-controller","link":{"type":"generated-index","title":"changelog-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/changelog-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-output-changelog","label":"Get business partner changelog entries for changes to the business partner output data","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-input-changelog","label":"Get business partner changelog entries for changes to the business partner input data","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-addresses.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-addresses.api.mdx deleted file mode 100644 index 0a3b325e05a..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-addresses.api.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: upsert-addresses -title: "Create or update addresses." -description: "Create or update addresses. Updates instead of creating a new address if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of addresses in the request is limited to 100 entries." -sidebar_label: "Create or update addresses." -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Create or update addresses. Updates instead of creating a new address if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of addresses in the request is limited to 100 entries.","operationId":"upsertAddresses","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."}}}},"required":true},"responses":{"200":{"description":"Addresses were successfully updated or created","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"On malformed address request"}},"method":"put","path":"/api/catena/input/addresses","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":[{"nameParts":["string"],"states":[{"description":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","street":{"namePrefix":"string","additionalNamePrefix":"string","name":"string","additionalNameSuffix":"string","houseNumber":"string","milestone":"string","direction":"string","nameSuffix":"string"},"administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","district":"string","companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","administrativeAreaLevel1":"string","deliveryServiceNumber":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string"},"roles":["SUPPLIER"],"externalId":"string","legalEntityExternalId":"string","siteExternalId":"string"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Create or update addresses.","description":{"content":"Create or update addresses. Updates instead of creating a new address if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of addresses in the request is limited to 100 entries.","type":"text/plain"},"url":{"path":["api","catena","input","addresses"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create or update addresses. - - - -Create or update addresses. Updates instead of creating a new address if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of addresses in the request is limited to 100 entries. - -
Request Body array required
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -Addresses were successfully updated or created - -
Schema
  • object
- -On malformed address request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities-output.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities-output.api.mdx deleted file mode 100644 index 4b8e81ca097..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities-output.api.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: upsert-legal-entities-output -title: "Create or update output legal entities." -description: "Create or update legal entities (Output). Updates instead of creating a new legal entity if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of legal entities in the request is limited to 100 entries." -sidebar_label: "Create or update output legal entities." -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Create or update legal entities (Output). Updates instead of creating a new legal entity if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of legal entities in the request is limited to 100 entries.","operationId":"upsertLegalEntitiesOutput","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"legalNameParts":{"type":"array","items":{"type":"string"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"},"issuingBody":{"type":"string","description":"Body which issued the identifier"}},"description":"Identifier record for a legal entity"}},"legalShortName":{"type":"string","description":"Abbreviated name or shorthand"},"legalForm":{"type":"string","description":"Technical key of the legal form"},"states":{"type":"array","items":{"type":"object","properties":{"officialDenotation":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record of a legal entity"}},"classifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Name of the classification"},"code":{"type":"string","description":"Identifying code of the classification, if applicable"},"type":{"type":"string","description":"Type of specified classification","enum":["NACE","NAF","NAICS","SIC"]}},"description":"Classification record for a business partner"}},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"legalAddress":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"bpn":{"type":"string"}},"description":"DTO for setting the output address data with BPN."},"externalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Legal entity with external id"}}}},"required":true},"responses":{"200":{"description":"Legal entities were successfully updated or created","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"On malformed legal entity request"}},"method":"put","path":"/api/catena/output/legal-entities","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":[{"legalNameParts":["string"],"identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"legalShortName":"string","legalForm":"string","states":[{"officialDenotation":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"classifications":[{"value":"string","code":"string","type":"NACE"}],"roles":["SUPPLIER"],"legalAddress":{"nameParts":["string"],"states":[{"description":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","street":{"namePrefix":"string","additionalNamePrefix":"string","name":"string","additionalNameSuffix":"string","houseNumber":"string","milestone":"string","direction":"string","nameSuffix":"string"},"administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","district":"string","companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","administrativeAreaLevel1":"string","deliveryServiceNumber":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string"},"roles":["SUPPLIER"],"bpn":"string"},"externalId":"string","bpn":"string"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Create or update output legal entities.","description":{"content":"Create or update legal entities (Output). Updates instead of creating a new legal entity if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of legal entities in the request is limited to 100 entries.","type":"text/plain"},"url":{"path":["api","catena","output","legal-entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create or update output legal entities. - - - -Create or update legal entities (Output). Updates instead of creating a new legal entity if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of legal entities in the request is limited to 100 entries. - -
Request Body array required
    identifiers object[]
    states object[]
    classifications object[]
    legalAddress object
    - -DTO for setting the output address data with BPN. - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -Legal entities were successfully updated or created - -
Schema
  • object
- -On malformed legal entity request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities.api.mdx deleted file mode 100644 index afbc3cea628..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities.api.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: upsert-legal-entities -title: "Create or update legal entities." -description: "Create or update legal entities. Updates instead of creating a new legal entity if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of legal entities in the request is limited to 100 entries." -sidebar_label: "Create or update legal entities." -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Create or update legal entities. Updates instead of creating a new legal entity if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of legal entities in the request is limited to 100 entries.","operationId":"upsertLegalEntities","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"legalNameParts":{"type":"array","items":{"type":"string"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"},"issuingBody":{"type":"string","description":"Body which issued the identifier"}},"description":"Identifier record for a legal entity"}},"legalShortName":{"type":"string","description":"Abbreviated name or shorthand"},"legalForm":{"type":"string","description":"Technical key of the legal form"},"states":{"type":"array","items":{"type":"object","properties":{"officialDenotation":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record of a legal entity"}},"classifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Name of the classification"},"code":{"type":"string","description":"Identifying code of the classification, if applicable"},"type":{"type":"string","description":"Type of specified classification","enum":["NACE","NAF","NAICS","SIC"]}},"description":"Classification record for a business partner"}},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"legalAddress":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}}},"description":"Address record for a business partner"},"externalId":{"type":"string"}},"description":"Legal entity with external id"}}}},"required":true},"responses":{"200":{"description":"Legal entities were successfully updated or created","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"On malformed legal entity request"}},"method":"put","path":"/api/catena/input/legal-entities","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":[{"legalNameParts":["string"],"identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"legalShortName":"string","legalForm":"string","states":[{"officialDenotation":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"classifications":[{"value":"string","code":"string","type":"NACE"}],"roles":["SUPPLIER"],"legalAddress":{"nameParts":["string"],"states":[{"description":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","street":{"namePrefix":"string","additionalNamePrefix":"string","name":"string","additionalNameSuffix":"string","houseNumber":"string","milestone":"string","direction":"string","nameSuffix":"string"},"administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","district":"string","companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","administrativeAreaLevel1":"string","deliveryServiceNumber":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string"},"roles":["SUPPLIER"]},"externalId":"string"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Create or update legal entities.","description":{"content":"Create or update legal entities. Updates instead of creating a new legal entity if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of legal entities in the request is limited to 100 entries.","type":"text/plain"},"url":{"path":["api","catena","input","legal-entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create or update legal entities. - - - -Create or update legal entities. Updates instead of creating a new legal entity if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of legal entities in the request is limited to 100 entries. - -
Request Body array required
    identifiers object[]
    states object[]
    classifications object[]
    legalAddress object
    - -Address record for a business partner - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -Legal entities were successfully updated or created - -
Schema
  • object
- -On malformed legal entity request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-sharing-state.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-sharing-state.api.mdx deleted file mode 100644 index 54bcd7e02ca..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-sharing-state.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: upsert-sharing-state -title: "Insert/update sharing state (including error info and BPN) for business partner with LSA type and external ID" -description: "Insert/update sharing state (including error info and BPN) for business partner with LSA type and external ID" -sidebar_label: "Insert/update sharing state (including error info and BPN) for business partner with LSA type and external ID" -hide_title: true -hide_table_of_contents: true -api: {"tags":["sharing-state-controller"],"operationId":"upsertSharingState","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"lsaType":{"type":"string","description":"LSA Type","enum":["LEGAL_ENTITY","SITE","ADDRESS"]},"externalId":{"type":"string","description":"External identifier"},"sharingStateType":{"type":"string","description":"Type of sharing state","enum":["Pending","Success","Error"]},"sharingErrorCode":{"type":"string","description":"BusinessPartnerSharingError","enum":["SharingProcessError","SharingTimeout","BpnNotInPool"]},"sharingErrorMessage":{"type":"string","description":"Sharing error message (for error)"},"bpn":{"type":"string","description":"BPN (for success)"},"sharingProcessStarted":{"type":"string","description":"Sharing process started (not updated if null)","format":"date-time"}}}}},"required":true},"responses":{"204":{"description":"Operation completed successfully"},"400":{"description":"Invalid data (e.g. externalId)"}},"description":"Insert/update sharing state (including error info and BPN) for business partner with LSA type and external ID","method":"put","path":"/api/catena/sharing-state","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":{"lsaType":"LEGAL_ENTITY","externalId":"string","sharingStateType":"Pending","sharingErrorCode":"SharingProcessError","sharingErrorMessage":"string","bpn":"string","sharingProcessStarted":"2023-06-26"},"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Insert/update sharing state (including error info and BPN) for business partner with LSA type and external ID","description":{"type":"text/plain"},"url":{"path":["api","catena","sharing-state"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Insert/update sharing state (including error info and BPN) for business partner with LSA type and external ID - - - -Insert/update sharing state (including error info and BPN) for business partner with LSA type and external ID - -
Request Body required
- -Operation completed successfully - -
- -Invalid data (e.g. externalId) - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites-output.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites-output.api.mdx deleted file mode 100644 index 6e519a12a95..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites-output.api.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: upsert-sites-output -title: "Create or update output sites." -description: "Create or update sites (Output). Updates instead of creating a new site if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of sites in the request is limited to 100 entries." -sidebar_label: "Create or update output sites." -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Create or update sites (Output). Updates instead of creating a new site if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of sites in the request is limited to 100 entries.","operationId":"upsertSitesOutput","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"nameParts":{"type":"array","description":"Parts that make up the name of that site","items":{"type":"string","description":"Parts that make up the name of that site"}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record of a site"}},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"mainAddress":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"bpn":{"type":"string"}},"description":"DTO for setting the output address data with BPN."},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Site with legal entity reference"}}}},"required":true},"responses":{"200":{"description":"Sites were successfully updated or created","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"On malformed site request"}},"method":"put","path":"/api/catena/output/sites","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":[{"nameParts":["string"],"states":[{"description":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"roles":["SUPPLIER"],"mainAddress":{"nameParts":["string"],"states":[{"description":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","street":{"namePrefix":"string","additionalNamePrefix":"string","name":"string","additionalNameSuffix":"string","houseNumber":"string","milestone":"string","direction":"string","nameSuffix":"string"},"administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","district":"string","companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","administrativeAreaLevel1":"string","deliveryServiceNumber":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string"},"roles":["SUPPLIER"],"bpn":"string"},"externalId":"string","legalEntityExternalId":"string","bpn":"string"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Create or update output sites.","description":{"content":"Create or update sites (Output). Updates instead of creating a new site if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of sites in the request is limited to 100 entries.","type":"text/plain"},"url":{"path":["api","catena","output","sites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create or update output sites. - - - -Create or update sites (Output). Updates instead of creating a new site if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of sites in the request is limited to 100 entries. - -
Request Body array required
    states object[]
    mainAddress object
    - -DTO for setting the output address data with BPN. - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -Sites were successfully updated or created - -
Schema
  • object
- -On malformed site request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites.api.mdx deleted file mode 100644 index 97a90c8e63a..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites.api.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: upsert-sites -title: "Create or update sites." -description: "Create or update sites. Updates instead of creating a new site if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of sites in the request is limited to 100 entries." -sidebar_label: "Create or update sites." -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Create or update sites. Updates instead of creating a new site if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of sites in the request is limited to 100 entries.","operationId":"upsertSites","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"nameParts":{"type":"array","description":"Parts that make up the name of that site","items":{"type":"string","description":"Parts that make up the name of that site"}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record of a site"}},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}},"mainAddress":{"type":"object","properties":{"nameParts":{"type":"array","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses.","items":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."}},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"Describes the official name prefix of the Street."},"additionalNamePrefix":{"type":"string","description":"Describes the additional name prefix of the Street."},"name":{"type":"string","description":"Describes the Name of the Street."},"additionalNameSuffix":{"type":"string","description":"Describes the additional name suffix of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"},"nameSuffix":{"type":"string","description":"Describes the name suffix of the Street."}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"roles":{"type":"array","items":{"type":"string","enum":["SUPPLIER","CUSTOMER"]}}},"description":"Address record for a business partner"},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"}},"description":"Site with legal entity reference"}}}},"required":true},"responses":{"200":{"description":"Sites were successfully updated or created","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"On malformed site request"}},"method":"put","path":"/api/catena/input/sites","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":[{"nameParts":["string"],"states":[{"description":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"roles":["SUPPLIER"],"mainAddress":{"nameParts":["string"],"states":[{"description":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","street":{"namePrefix":"string","additionalNamePrefix":"string","name":"string","additionalNameSuffix":"string","houseNumber":"string","milestone":"string","direction":"string","nameSuffix":"string"},"administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","district":"string","companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","administrativeAreaLevel1":"string","deliveryServiceNumber":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string"},"roles":["SUPPLIER"]},"externalId":"string","legalEntityExternalId":"string"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Create or update sites.","description":{"content":"Create or update sites. Updates instead of creating a new site if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of sites in the request is limited to 100 entries.","type":"text/plain"},"url":{"path":["api","catena","input","sites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create or update sites. - - - -Create or update sites. Updates instead of creating a new site if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of sites in the request is limited to 100 entries. - -
Request Body array required
    states object[]
    mainAddress object
    - -Address record for a business partner - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -Sites were successfully updated or created - -
Schema
  • object
- -On malformed site request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Local.postman_environment.json b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Local.postman_environment.json deleted file mode 100644 index 4a2e72cb428..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Local.postman_environment.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "id": "6c6dd52d-bf34-496d-9d33-57802fa339d0", - "name": "Local", - "values": [ - { - "key": "Environment", - "value": "Local", - "type": "default", - "enabled": true - }, - { - "key": "Keycloak-Host", - "value": "http://localhost:8180", - "type": "default", - "enabled": true - }, - { - "key": "Pool-Client-ID", - "value": "BPDM_Client", - "type": "default", - "enabled": true - }, - { - "key": "Pool-Client-Secret", - "value": "", - "type": "secret", - "enabled": true - }, - { - "key": "Pool-Host", - "value": "http://localhost:8080", - "type": "default", - "enabled": true - }, - { - "key": "Gate-Host", - "value": "http://localhost:8081", - "type": "default", - "enabled": true - }, - { - "key": "Gate-Client-ID", - "value": "BPDM_Client", - "type": "default", - "enabled": true - }, - { - "key": "Gate-Client-Secret", - "value": "", - "type": "secret", - "enabled": true - }, - { - "key": "Bridge-Host", - "value": "http://localhost:8083", - "type": "default", - "enabled": true - }, - { - "key": "Bridge-Client-ID", - "value": "bridge-client", - "type": "default", - "enabled": true - }, - { - "key": "Bridge-Client-Secret", - "value": "", - "type": "secret", - "enabled": true - } - ], - "_postman_variable_scope": "environment", - "_postman_exported_at": "2023-06-15T09:50:00.606Z", - "_postman_exported_using": "Postman/10.14.2" -} \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool.info.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool.info.mdx deleted file mode 100644 index c1e87a2fc70..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: business-partner-data-management-pool -title: "Business Partner Data Management Pool" -description: "Service that manages and shares business partner data with other CatenaX services" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 4.0.0-SNAPSHOT - -# Business Partner Data Management Pool - - - -Service that manages and shares business partner data with other CatenaX services - - - \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/clear.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/clear.api.mdx deleted file mode 100644 index da636bb8f8e..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/clear.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: clear -title: "Clear business partner index on OpenSearch" -description: "Deletes all business partner records in the OpenSearch index. Also resets the timestamp from the last export." -sidebar_label: "Clear business partner index on OpenSearch" -hide_title: true -hide_table_of_contents: true -api: {"tags":["open-search-controller"],"description":"Deletes all business partner records in the OpenSearch index. Also resets the timestamp from the last export.","operationId":"clear","responses":{"200":{"description":"Index successfully cleared"},"500":{"description":"Clearing failed (no connection to OpenSearch or database)"}},"method":"delete","path":"/api/opensearch/business-partner","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Clear business partner index on OpenSearch","description":{"content":"Deletes all business partner records in the OpenSearch index. Also resets the timestamp from the last export.","type":"text/plain"},"url":{"path":["api","opensearch","business-partner"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"DELETE"}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Clear business partner index on OpenSearch - - - -Deletes all business partner records in the OpenSearch index. Also resets the timestamp from the last export. - -
- -Index successfully cleared - -
- -Clearing failed (no connection to OpenSearch or database) - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/create-addresses.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/create-addresses.api.mdx deleted file mode 100644 index 3752b4ee463..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/create-addresses.api.mdx +++ /dev/null @@ -1,86 +0,0 @@ ---- -id: create-addresses -title: "Create new address business partners" -description: "Create new business partners of type address by specifying the BPN of the parent each address belongs to. A parent can be either a site or legal entity business partner. If the parent cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response." -sidebar_label: "Create new address business partners" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Create new business partners of type address by specifying the BPN of the parent each address belongs to. A parent can be either a site or legal entity business partner. If the parent cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","operationId":"createAddresses","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnParent":{"type":"string"},"index":{"type":"string"}},"description":"Request for creating new business partner record of type address"}}}},"required":true},"responses":{"200":{"description":"New business partner record successfully created, possible errors are returned","content":{"application/json":{"schema":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"object","properties":{"bpna":{"type":"string","description":"Business Partner Number of this address"},"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnLegalEntity":{"type":"string","description":"BPN of the related legal entity, if available"},"bpnSite":{"type":"string","description":"BPN of the related site, if available"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"isLegalAddress":{"type":"boolean","description":"Flag if this is the legal address of its related legal entity"},"isMainAddress":{"type":"boolean","description":"Flag if this is the main address of its related site"},"index":{"type":"string"}},"description":"Created business partners of type address"}},"errors":{"type":"array","items":{"title":"ErrorInfo","type":"object","properties":{"errorCode":{"type":"string","description":"AddressCreateError","enum":["BpnNotValid","SiteNotFound","LegalEntityNotFound"]},"message":{"type":"string"},"entityKey":{"type":"string"}},"description":"Holds information about failures when creating or updating an entity"}},"errorCount":{"type":"integer","format":"int32"},"entityCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"post","path":"/api/catena/addresses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"name":"string","states":[{"description":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","street":{"name":"string","houseNumber":"string","milestone":"string","direction":"string"},"administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","district":"string","companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","administrativeAreaLevel1":"string","deliveryServiceNumber":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string"},"bpnParent":"string","index":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Create new address business partners","description":{"content":"Create new business partners of type address by specifying the BPN of the parent each address belongs to. A parent can be either a site or legal entity business partner. If the parent cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","type":"text/plain"},"url":{"path":["api","catena","addresses"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create new address business partners - - - -Create new business partners of type address by specifying the BPN of the parent each address belongs to. A parent can be either a site or legal entity business partner. If the parent cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. - -
Request Body array required
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -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
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners.api.mdx deleted file mode 100644 index bf10ffea8d9..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners.api.mdx +++ /dev/null @@ -1,114 +0,0 @@ ---- -id: create-business-partners -title: "Create new legal entity business partners" -description: "Create new business partners of type legal entity. The given additional identifiers of a record need to be unique, otherwise they are ignored. For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response." -sidebar_label: "Create new legal entity business partners" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Create new business partners of type legal entity. The given additional identifiers of a record need to be unique, otherwise they are ignored. For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","operationId":"createBusinessPartners","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"legalName":{"type":"string","description":"Legal name the partner goes by"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"},"issuingBody":{"type":"string","description":"Body which issued the identifier"}},"description":"Identifier record for a legal entity"}},"legalShortName":{"type":"string","description":"Abbreviated name or shorthand"},"legalForm":{"type":"string","description":"Technical key of the legal form"},"states":{"type":"array","items":{"type":"object","properties":{"officialDenotation":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record of a legal entity"}},"classifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Name of the classification"},"code":{"type":"string","description":"Identifying code of the classification, if applicable"},"type":{"type":"string","description":"Type of specified classification","enum":["NACE","NAF","NAICS","SIC"]}},"description":"Classification record for a business partner"}},"legalAddress":{"type":"object","properties":{"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"}},"description":"Address record for a business partner"},"index":{"type":"string"}},"description":"Request for creating new business partner record of type legal entity"}}}},"required":true},"responses":{"200":{"description":"New legal entities request was processed successfully, possible errors are returned","content":{"application/json":{"schema":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"object","properties":{"legalName":{"type":"string","description":"Legal name the partner goes by"},"bpnl":{"type":"string","description":"Business Partner Number of this legal entity"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"Body which issued the identifier"}},"description":"Identifier record of a legal entity"}},"legalShortName":{"type":"string","description":"Abbreviated name or shorthand"},"legalForm":{"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key to be used for reference"},"name":{"type":"string","description":"Full name of the legal form"},"abbreviation":{"type":"string","description":"Abbreviation of the legal form name"}},"description":"Legal form a business partner can have"},"states":{"type":"array","items":{"type":"object","properties":{"officialDenotation":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"classifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Name of the classification"},"code":{"type":"string","description":"Identifying code of the classification, if applicable"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["NACE","NAF","NAICS","SIC"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Classification record of a business partner"}},"relations":{"type":"array","items":{"type":"object","properties":{"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"startBpn":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpn":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The timestamp the business partner data was last indicated to be still current","format":"date-time"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"legalAddress":{"type":"object","properties":{"bpna":{"type":"string","description":"Business Partner Number of this address"},"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnLegalEntity":{"type":"string","description":"BPN of the related legal entity, if available"},"bpnSite":{"type":"string","description":"BPN of the related site, if available"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"isLegalAddress":{"type":"boolean","description":"Flag if this is the legal address of its related legal entity"},"isMainAddress":{"type":"boolean","description":"Flag if this is the main address of its related site"}},"description":"Logistic address "},"index":{"type":"string"}},"description":"Created business partner of type legal entity"}},"errors":{"type":"array","items":{"title":"ErrorInfo","type":"object","properties":{"errorCode":{"type":"string","description":"LegalEntityCreateError","enum":["LegalEntityDuplicateIdentifier"]},"message":{"type":"string"},"entityKey":{"type":"string"}},"description":"Holds information about failures when creating or updating an entity"}},"errorCount":{"type":"integer","format":"int32"},"entityCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"post","path":"/api/catena/legal-entities","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"legalName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"legalShortName":"string","legalForm":"string","states":[{"officialDenotation":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"classifications":[{"value":"string","code":"string","type":"NACE"}],"legalAddress":{"name":"string","states":[{"description":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","street":{"name":"string","houseNumber":"string","milestone":"string","direction":"string"},"administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","district":"string","companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","administrativeAreaLevel1":"string","deliveryServiceNumber":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string"}},"index":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Create new legal entity business partners","description":{"content":"Create new business partners of type legal entity. The given additional identifiers of a record need to be unique, otherwise they are ignored. For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","type":"text/plain"},"url":{"path":["api","catena","legal-entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create new legal entity business partners - - - -Create new business partners of type legal entity. The given additional identifiers of a record need to be unique, otherwise they are ignored. For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. - -
Request Body array required
    identifiers object[]
    states object[]
    classifications object[]
    legalAddress object
    - -Address record for a business partner - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -New legal entities request was processed successfully, possible errors are returned - -
Schema
    entities object[]
    identifiers object[]
    type object
    - -Named type uniquely identified by its technical key - -
    legalForm object
    - -Legal form a business partner can have - -
    states object[]
    type object
    - -Named type uniquely identified by its technical key - -
    classifications object[]
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    type object
    - -Named type uniquely identified by its technical key - -
    legalAddress object
    - -Logistic address - -
    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
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type.api.mdx deleted file mode 100644 index 98a4aa09134..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: create-identifier-type -title: "Create new identifier type" -description: "Create a new identifier type (including validity details) which can be referenced by business partner records. Identifier types such as BPN or VAT determine with which kind of values a business partner can be identified with. The actual name of the identifier type is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the lsaType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems." -sidebar_label: "Create new identifier type" -hide_title: true -hide_table_of_contents: true -api: {"tags":["metadata-controller"],"description":"Create a new identifier type (including validity details) which can be referenced by business partner records. Identifier types such as BPN or VAT determine with which kind of values a business partner can be identified with. The actual name of the identifier type is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the lsaType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.","operationId":"createIdentifierType","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key (in combination with lsaType) to be used as reference"},"lsaType":{"type":"string","description":"Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported.","enum":["LEGAL_ENTITY","ADDRESS"]},"name":{"type":"string","description":"Full name"},"details":{"type":"array","description":"Validity details","items":{"type":"object","properties":{"country":{"type":"string","description":"Country in which this identifier is valid, null for universal identifiers","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"mandatory":{"type":"boolean","description":"True if identifier is mandatory in this country"}},"description":"Identifier type validity details"}}},"description":"Identifier type definition for legal entity or address"}}},"required":true},"responses":{"200":{"description":"New identifier type successfully created","content":{"application/json":{"schema":{"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key (in combination with lsaType) to be used as reference"},"lsaType":{"type":"string","description":"Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported.","enum":["LEGAL_ENTITY","ADDRESS"]},"name":{"type":"string","description":"Full name"},"details":{"type":"array","description":"Validity details","items":{"type":"object","properties":{"country":{"type":"string","description":"Country in which this identifier is valid, null for universal identifiers","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"mandatory":{"type":"boolean","description":"True if identifier is mandatory in this country"}},"description":"Identifier type validity details"}}},"description":"Identifier type definition for legal entity or address"}}}},"400":{"description":"On malformed request parameters"},"409":{"description":"Identifier type with specified technical key already exists"}},"method":"post","path":"/api/catena/identifier-types","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"technicalKey":"string","lsaType":"LEGAL_ENTITY","name":"string","details":[{"country":"UNDEFINED","mandatory":true}]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Create new identifier type","description":{"content":"Create a new identifier type (including validity details) which can be referenced by business partner records. Identifier types such as BPN or VAT determine with which kind of values a business partner can be identified with. The actual name of the identifier type is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the lsaType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.","type":"text/plain"},"url":{"path":["api","catena","identifier-types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create new identifier type - - - -Create a new identifier type (including validity details) which can be referenced by business partner records. Identifier types such as BPN or VAT determine with which kind of values a business partner can be identified with. The actual name of the identifier type is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the lsaType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems. - -
Request Body required
    details object[]
    - -Validity details - -
- -New identifier type successfully created - -
Schema
    details object[]
    - -Validity details - -
- -On malformed request parameters - -
- -Identifier type with specified technical key already exists - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form.api.mdx deleted file mode 100644 index 9d112656654..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-legal-form -title: "Create new legal form" -description: "Create a new legal form which can be referenced by business partner records. The actual name of the legal form is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the lsaType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems." -sidebar_label: "Create new legal form" -hide_title: true -hide_table_of_contents: true -api: {"tags":["metadata-controller"],"description":"Create a new legal form which can be referenced by business partner records. The actual name of the legal form is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the lsaType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.","operationId":"createLegalForm","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"description":"New legal form record to be referenced by business partners"}}},"required":true},"responses":{"200":{"description":"New legal form successfully created","content":{"application/json":{"schema":{"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key to be used for reference"},"name":{"type":"string","description":"Full name of the legal form"},"abbreviation":{"type":"string","description":"Abbreviation of the legal form name"}},"description":"Legal form a business partner can have"}}}},"400":{"description":"On malformed request parameters"},"409":{"description":"Legal form with specified technical key already exists"}},"method":"post","path":"/api/catena/legal-forms","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"technicalKey":"string","name":"string","abbreviation":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Create new legal form","description":{"content":"Create a new legal form which can be referenced by business partner records. The actual name of the legal form is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the lsaType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.","type":"text/plain"},"url":{"path":["api","catena","legal-forms"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create new legal form - - - -Create a new legal form which can be referenced by business partner records. The actual name of the legal form is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the lsaType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems. - -
Request Body required
- -New legal form successfully created - -
Schema
- -On malformed request parameters - -
- -Legal form with specified technical key already exists - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/create-site.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/create-site.api.mdx deleted file mode 100644 index 29b11f62587..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/create-site.api.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -id: create-site -title: "Create new site business partners" -description: "Create new business partners of type site by specifying the BPNL of the legal entity each site belongs to. If the legal entitiy cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response." -sidebar_label: "Create new site business partners" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Create new business partners of type site by specifying the BPNL of the legal entity each site belongs to. If the legal entitiy cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","operationId":"createSite","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Site name"},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record of a site"}},"mainAddress":{"type":"object","properties":{"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"}},"description":"Address record for a business partner"},"bpnlParent":{"type":"string"},"index":{"type":"string"}},"description":"Request for creating new business partner record of type site"}}}},"required":true},"responses":{"200":{"description":"New sites request was processed successfully, possible errors are returned","content":{"application/json":{"schema":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"object","properties":{"bpns":{"type":"string","description":"Business Partner Number, main identifier value for sites"},"name":{"type":"string","description":"Site name"},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a site"}},"bpnLegalEntity":{"type":"string","description":"Business Partner Number of the related legal entity"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"mainAddress":{"type":"object","properties":{"bpna":{"type":"string","description":"Business Partner Number of this address"},"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnLegalEntity":{"type":"string","description":"BPN of the related legal entity, if available"},"bpnSite":{"type":"string","description":"BPN of the related site, if available"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"isLegalAddress":{"type":"boolean","description":"Flag if this is the legal address of its related legal entity"},"isMainAddress":{"type":"boolean","description":"Flag if this is the main address of its related site"}},"description":"Logistic address "},"index":{"type":"string"}},"description":"Created business partner record of type site"}},"errors":{"type":"array","items":{"title":"ErrorInfo","type":"object","properties":{"errorCode":{"type":"string","description":"SiteCreateError","enum":["LegalEntityNotFound"]},"message":{"type":"string"},"entityKey":{"type":"string"}},"description":"Holds information about failures when creating or updating an entity"}},"errorCount":{"type":"integer","format":"int32"},"entityCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"post","path":"/api/catena/sites","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"name":"string","states":[{"description":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"mainAddress":{"name":"string","states":[{"description":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","street":{"name":"string","houseNumber":"string","milestone":"string","direction":"string"},"administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","district":"string","companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","administrativeAreaLevel1":"string","deliveryServiceNumber":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string"}},"bpnlParent":"string","index":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Create new site business partners","description":{"content":"Create new business partners of type site by specifying the BPNL of the legal entity each site belongs to. If the legal entitiy cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","type":"text/plain"},"url":{"path":["api","catena","sites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create new site business partners - - - -Create new business partners of type site by specifying the BPNL of the legal entity each site belongs to. If the legal entitiy cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. - -
Request Body array required
    states object[]
    mainAddress object
    - -Address record for a business partner - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -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
    - -Logistic address - -
    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
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/export.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/export.api.mdx deleted file mode 100644 index 86989deec54..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/export.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: export -title: "Index new business partner records on OpenSearch" -description: "Triggers an asynchronous export of business partner records from BPDM to OpenSearch. Only exports records which have been updated since the last export." -sidebar_label: "Index new business partner records on OpenSearch" -hide_title: true -hide_table_of_contents: true -api: {"tags":["open-search-controller"],"description":"Triggers an asynchronous export of business partner records from BPDM to OpenSearch. Only exports records which have been updated since the last export. ","operationId":"export","responses":{"200":{"description":"Export of records successfully","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["OPENSEARCH","SAAS_IMPORT"]},"status":{"type":"string","enum":["NOT_SYNCED","RUNNING","SUCCESS","ERROR"]},"count":{"type":"integer","format":"int32"},"progress":{"type":"number","format":"float"},"errorDetails":{"type":"string"},"startedAt":{"type":"string","format":"date-time"},"finishedAt":{"type":"string","format":"date-time"}}}}}},"500":{"description":"Export failed (no connection to OpenSearch or database)"}},"method":"post","path":"/api/opensearch/business-partner","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Index new business partner records on OpenSearch","description":{"content":"Triggers an asynchronous export of business partner records from BPDM to OpenSearch. Only exports records which have been updated since the last export. ","type":"text/plain"},"url":{"path":["api","opensearch","business-partner"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Index new business partner records on OpenSearch - - - -Triggers an asynchronous export of business partner records from BPDM to OpenSearch. Only exports records which have been updated since the last export. - -
- -Export of records successfully - -
Schema
- -Export failed (no connection to OpenSearch or database) - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers.api.mdx deleted file mode 100644 index 5a935cac128..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: find-bpns-by-identifiers -title: "Find business partner numbers by identifiers" -description: "Find business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to ${bpdm.bpn.search-request-limit} entries." -sidebar_label: "Find business partner numbers by identifiers" -hide_title: true -hide_table_of_contents: true -api: {"tags":["bpn-controller"],"description":"Find business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to ${bpdm.bpn.search-request-limit} entries.","operationId":"findBpnsByIdentifiers","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"lsaType":{"type":"string","description":"Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported.","enum":["LEGAL_ENTITY","ADDRESS"]},"idType":{"type":"string"},"idValues":{"type":"array","items":{"type":"string"}}},"description":"Contains identifiers to search legal entities by"}}},"required":true},"responses":{"200":{"description":"Found bpn to identifier value mappings","content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"object","properties":{"idValue":{"type":"string"},"bpn":{"type":"string"}},"description":"Mapping of Business Partner Number to identifier value"}}}}},"400":{"description":"On malformed request parameters or if number of requested bpns exceeds limit"},"404":{"description":"Specified identifier type not found"}},"method":"post","path":"/api/catena/bpn/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"lsaType":"LEGAL_ENTITY","idType":"string","idValues":["string"]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Find business partner numbers by identifiers","description":{"content":"Find business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to ${bpdm.bpn.search-request-limit} entries.","type":"text/plain"},"url":{"path":["api","catena","bpn","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Find business partner numbers by identifiers - - - -Find business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to ${bpdm.bpn.search-request-limit} entries. - -
Request Body required
- -Found bpn to identifier value mappings - -
Schema array
- -On malformed request parameters or if number of requested bpns exceeds limit - -
- -Specified identifier type not found - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-address.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-address.api.mdx deleted file mode 100644 index 73db5a30d94..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-address.api.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: get-address -title: "Get address partners by bpna" -description: "Get business partners of type address by bpn-a ignoring case." -sidebar_label: "Get address partners by bpna" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Get business partners of type address by bpn-a ignoring case.","operationId":"getAddress","parameters":[{"name":"bpna","in":"path","description":"Bpn value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found address with specified bpna","content":{"application/json":{"schema":{"type":"object","properties":{"bpna":{"type":"string","description":"Business Partner Number of this address"},"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnLegalEntity":{"type":"string","description":"BPN of the related legal entity, if available"},"bpnSite":{"type":"string","description":"BPN of the related site, if available"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"isLegalAddress":{"type":"boolean","description":"Flag if this is the legal address of its related legal entity"},"isMainAddress":{"type":"boolean","description":"Flag if this is the main address of its related site"}},"description":"Logistic address "}}}},"400":{"description":"On malformed request parameters"},"404":{"description":"No address found under specified bpna"}},"method":"get","path":"/api/catena/addresses/{bpna}","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get address partners by bpna","description":{"content":"Get business partners of type address by bpn-a ignoring case.","type":"text/plain"},"url":{"path":["api","catena","addresses",":bpna"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Bpn value","type":"text/plain"},"type":"any","value":"","key":"bpna"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get address partners by bpna - - - -Get business partners of type address by bpn-a ignoring case. - -
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
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed request parameters - -
- -No address found under specified bpna - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1.api.mdx deleted file mode 100644 index 15098049d1c..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1.api.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -id: get-addresses-1 -title: "Get page of addresses matching the search criteria" -description: "This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. Note that when using search parameters the max page is 20." -sidebar_label: "Get page of addresses matching the search criteria" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. Note that when using search parameters the max page is 20.","operationId":"getAddresses_1","parameters":[{"name":"name","in":"query","description":"Filter business partners by name","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of addresses matching the search criteria, may be empty","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"score":{"type":"number","format":"float"},"address":{"type":"object","properties":{"bpna":{"type":"string","description":"Business Partner Number of this address"},"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnLegalEntity":{"type":"string","description":"BPN of the related legal entity, if available"},"bpnSite":{"type":"string","description":"BPN of the related site, if available"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"isLegalAddress":{"type":"boolean","description":"Flag if this is the legal address of its related legal entity"},"isMainAddress":{"type":"boolean","description":"Flag if this is the main address of its related site"}},"description":"Logistic address "}},"description":"Match with score for a business partner record of type address"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed search or pagination request"}},"method":"get","path":"/api/catena/addresses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get page of addresses matching the search criteria","description":{"content":"This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. Note that when using search parameters the max page is 20.","type":"text/plain"},"url":{"path":["api","catena","addresses"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter business partners by name","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of addresses matching the search criteria - - - -This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. Note that when using search parameters the max page is 20. - -
Query Parameters
- -Page of addresses matching the search criteria, may be empty - -
Schema
    content object[]
    - -Collection of results in the page - -
    address object
    - -Logistic address - -
    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
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed search or pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses.api.mdx deleted file mode 100644 index 68156583ae2..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses.api.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -id: get-addresses -title: "Get address partners of a legal entity" -description: "Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's bpn ignoring case." -sidebar_label: "Get address partners of a legal entity" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's bpn ignoring case.","operationId":"getAddresses","parameters":[{"name":"bpnl","in":"path","description":"Bpn value","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"The addresses for the specified bpn","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"bpna":{"type":"string","description":"Business Partner Number of this address"},"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnLegalEntity":{"type":"string","description":"BPN of the related legal entity, if available"},"bpnSite":{"type":"string","description":"BPN of the related site, if available"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"isLegalAddress":{"type":"boolean","description":"Flag if this is the legal address of its related legal entity"},"isMainAddress":{"type":"boolean","description":"Flag if this is the main address of its related site"}},"description":"Logistic address "}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"},"404":{"description":"No business partner found for specified bpn"}},"method":"get","path":"/api/catena/legal-entities/{bpnl}/addresses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get address partners of a legal entity","description":{"content":"Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's bpn ignoring case.","type":"text/plain"},"url":{"path":["api","catena","legal-entities",":bpnl","addresses"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Bpn value","type":"text/plain"},"type":"any","value":"","key":"bpnl"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get address partners of a legal entity - - - -Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's bpn ignoring case. - -
Path Parameters
Query Parameters
- -The addresses for the specified bpn - -
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
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed pagination request - -
- -No business partner found for specified bpn - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-business-partners.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-business-partners.api.mdx deleted file mode 100644 index ee885cb5cd1..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-business-partners.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-business-partners -title: "Fetch information about the latest OpenSearch export" -description: "Fetch information about the latest export (either ongoing or already finished)" -sidebar_label: "Fetch information about the latest OpenSearch export" -hide_title: true -hide_table_of_contents: true -api: {"tags":["open-search-controller"],"description":"Fetch information about the latest export (either ongoing or already finished)","operationId":"getBusinessPartners","responses":{"200":{"description":"Export information found","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["OPENSEARCH","SAAS_IMPORT"]},"status":{"type":"string","enum":["NOT_SYNCED","RUNNING","SUCCESS","ERROR"]},"count":{"type":"integer","format":"int32"},"progress":{"type":"number","format":"float"},"errorDetails":{"type":"string"},"startedAt":{"type":"string","format":"date-time"},"finishedAt":{"type":"string","format":"date-time"}}}}}},"500":{"description":"Fetching failed (no connection to database)"}},"method":"get","path":"/api/opensearch/business-partner","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Fetch information about the latest OpenSearch export","description":{"content":"Fetch information about the latest export (either ongoing or already finished)","type":"text/plain"},"url":{"path":["api","opensearch","business-partner"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Fetch information about the latest OpenSearch export - - - -Fetch information about the latest export (either ongoing or already finished) - -
- -Export information found - -
Schema
- -Fetching failed (no connection to database) - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries.api.mdx deleted file mode 100644 index 75f90334e54..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-changelog-entries -title: "Get business partner changelog entries from time, by BPN and/or LSA type" -description: "Get business partner changelog entries from time, by BPN and/or LSA type" -sidebar_label: "Get business partner changelog entries from time, by BPN and/or LSA type" -hide_title: true -hide_table_of_contents: true -api: {"tags":["changelog-controller"],"description":"Get business partner changelog entries from time, by BPN and/or LSA type","operationId":"getChangelogEntries","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"fromTime":{"type":"string","format":"date-time"},"bpns":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"lsaTypes":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["LEGAL_ENTITY","ADDRESS","SITE"]}}},"description":"Request for searching and filtering the business partner changelog"}}},"required":true},"responses":{"200":{"description":"The specified changelog entries","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"bpn":{"type":"string"},"changelogType":{"type":"string","enum":["CREATE","UPDATE"]},"timestamp":{"type":"string","format":"date-time"},"lsaType":{"type":"string","enum":["LEGAL_ENTITY","ADDRESS","SITE"]}},"description":"Changelog entry for a business partner"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"},"404":{"description":"No business partner found for specified bpn"}},"method":"post","path":"/api/catena/business-partners/changelog/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"fromTime":"2023-06-26","bpns":["string"],"lsaTypes":["LEGAL_ENTITY"]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get business partner changelog entries from time, by BPN and/or LSA type","description":{"content":"Get business partner changelog entries from time, by BPN and/or LSA type","type":"text/plain"},"url":{"path":["api","catena","business-partners","changelog","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get business partner changelog entries from time, by BPN and/or LSA type - - - -Get business partner changelog entries from time, by BPN and/or LSA type - -
Query Parameters
Request Body required
- -The specified changelog entries - -
Schema
    content object[]
    - -Collection of results in the page - -
- -On malformed pagination request - -
- -No business partner found for specified bpn - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-field-quality-rules.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-field-quality-rules.api.mdx deleted file mode 100644 index 5e132c461eb..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-field-quality-rules.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-field-quality-rules -title: "Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code)" -description: "List the country specific data rules for entity fields.All fields that are not in this list are considered to be forbidden." -sidebar_label: "Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code)" -hide_title: true -hide_table_of_contents: true -api: {"tags":["metadata-controller"],"description":"List the country specific data rules for entity fields.All fields that are not in this list are considered to be forbidden.","operationId":"getFieldQualityRules","parameters":[{"name":"country","in":"query","description":"ISO 3166-1 alpha-2 country code","required":true,"schema":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]}}],"responses":{"200":{"description":"List of the existing rules for the given country","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"fieldPath":{"type":"string","description":"Path to the field"},"schemaName":{"type":"string","description":"Schema name of the entity the field belongs to"},"country":{"type":"string","description":"Country for wich the rule is valid","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"qualityLevel":{"type":"string","description":"Defines the quality of an entity field.","enum":["MANDATORY","OPTIONAL","FORBIDDEN"]}},"description":"Rule for the quality level of an entity field "}}}}},"400":{"description":"On malformed request parameters"}},"method":"get","path":"/api/catena/field-quality-rules/","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code)","description":{"content":"List the country specific data rules for entity fields.All fields that are not in this list are considered to be forbidden.","type":"text/plain"},"url":{"path":["api","catena","field-quality-rules",""],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ISO 3166-1 alpha-2 country code","type":"text/plain"},"key":"country","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code) - - - -List the country specific data rules for entity fields.All fields that are not in this list are considered to be forbidden. - -
Query Parameters
- -List of the existing rules for the given country - -
Schema array
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types.api.mdx deleted file mode 100644 index dedea193063..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-identifier-types -title: "Get page of identifier types filtered by lsaType and (optionally) country (specified by its ISO 3166-1 alpha-2 country code)" -description: "Lists all matching identifier types including validity details in a paginated result" -sidebar_label: "Get page of identifier types filtered by lsaType and (optionally) country (specified by its ISO 3166-1 alpha-2 country code)" -hide_title: true -hide_table_of_contents: true -api: {"tags":["metadata-controller"],"description":"Lists all matching identifier types including validity details in a paginated result","operationId":"getIdentifierTypes","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}},{"name":"lsaType","in":"query","required":true,"schema":{"type":"string","description":"Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported.","enum":["LEGAL_ENTITY","ADDRESS"]}},{"name":"country","in":"query","required":false,"schema":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]}}],"responses":{"200":{"description":"Page of existing identifier types, may be empty","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key (in combination with lsaType) to be used as reference"},"lsaType":{"type":"string","description":"Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported.","enum":["LEGAL_ENTITY","ADDRESS"]},"name":{"type":"string","description":"Full name"},"details":{"type":"array","description":"Validity details","items":{"type":"object","properties":{"country":{"type":"string","description":"Country in which this identifier is valid, null for universal identifiers","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"mandatory":{"type":"boolean","description":"True if identifier is mandatory in this country"}},"description":"Identifier type validity details"}}},"description":"Identifier type definition for legal entity or address"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters"}},"method":"get","path":"/api/catena/identifier-types","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get page of identifier types filtered by lsaType and (optionally) country (specified by its ISO 3166-1 alpha-2 country code)","description":{"content":"Lists all matching identifier types including validity details in a paginated result","type":"text/plain"},"url":{"path":["api","catena","identifier-types"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"lsaType","value":""},{"disabled":false,"key":"country","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of identifier types filtered by lsaType and (optionally) country (specified by its ISO 3166-1 alpha-2 country code) - - - -Lists all matching identifier types including validity details in a paginated result - -
Query Parameters
- -Page of existing identifier types, may be empty - -
Schema
    content object[]
    - -Collection of results in the page - -
    details object[]
    - -Validity details - -
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities.api.mdx deleted file mode 100644 index 1562d8ad286..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities.api.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: get-legal-entities -title: "Get page of legal entity business partners matching the search criteria" -description: "This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. Note that when using search parameters the max page is 20." -sidebar_label: "Get page of legal entity business partners matching the search criteria" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. Note that when using search parameters the max page is 20.","operationId":"getLegalEntities","parameters":[{"name":"legalName","in":"query","description":"Filter legal entities by name","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of business partners matching the search criteria, may be empty","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"score":{"type":"number","format":"float"},"legalName":{"type":"string","description":"Legal name the partner goes by"},"bpnl":{"type":"string","description":"Business Partner Number of this legal entity"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"Body which issued the identifier"}},"description":"Identifier record of a legal entity"}},"legalShortName":{"type":"string","description":"Abbreviated name or shorthand"},"legalForm":{"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key to be used for reference"},"name":{"type":"string","description":"Full name of the legal form"},"abbreviation":{"type":"string","description":"Abbreviation of the legal form name"}},"description":"Legal form a business partner can have"},"states":{"type":"array","items":{"type":"object","properties":{"officialDenotation":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"classifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Name of the classification"},"code":{"type":"string","description":"Identifying code of the classification, if applicable"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["NACE","NAF","NAICS","SIC"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Classification record of a business partner"}},"relations":{"type":"array","items":{"type":"object","properties":{"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"startBpn":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpn":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The timestamp the business partner data was last indicated to be still current","format":"date-time"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"legalAddress":{"type":"object","properties":{"bpna":{"type":"string","description":"Business Partner Number of this address"},"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnLegalEntity":{"type":"string","description":"BPN of the related legal entity, if available"},"bpnSite":{"type":"string","description":"BPN of the related site, if available"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"isLegalAddress":{"type":"boolean","description":"Flag if this is the legal address of its related legal entity"},"isMainAddress":{"type":"boolean","description":"Flag if this is the main address of its related site"}},"description":"Logistic address "}},"description":"Match with score for a business partner record of type legal entity"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed search or pagination request"}},"method":"get","path":"/api/catena/legal-entities","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get page of legal entity business partners matching the search criteria","description":{"content":"This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. Note that when using search parameters the max page is 20.","type":"text/plain"},"url":{"path":["api","catena","legal-entities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter legal entities by name","type":"text/plain"},"key":"legalName","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of legal entity business partners matching the search criteria - - - -This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. Note that when using search parameters the max page is 20. - -
Query Parameters
- -Page of business partners matching the search criteria, may be empty - -
Schema
    content object[]
    - -Collection of results in the page - -
    identifiers object[]
    type object
    - -Named type uniquely identified by its technical key - -
    legalForm object
    - -Legal form a business partner can have - -
    states object[]
    type object
    - -Named type uniquely identified by its technical key - -
    classifications object[]
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    type object
    - -Named type uniquely identified by its technical key - -
    legalAddress object
    - -Logistic address - -
    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
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed search or pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity.api.mdx deleted file mode 100644 index 4450422f677..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity.api.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: get-legal-entity -title: "Get legal entity business partner by identifier" -description: "This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type." -sidebar_label: "Get legal entity business partner by identifier" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type.","operationId":"getLegalEntity","parameters":[{"name":"idValue","in":"path","description":"Identifier value","required":true,"schema":{"type":"string"}},{"name":"idType","in":"query","description":"Type of identifier to use, defaults to BPN when omitted","required":false,"schema":{"type":"string","default":"BPN"}}],"responses":{"200":{"description":"Found business partner with specified identifier","content":{"application/json":{"schema":{"type":"object","properties":{"legalName":{"type":"string","description":"Legal name the partner goes by"},"bpnl":{"type":"string","description":"Business Partner Number of this legal entity"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"Body which issued the identifier"}},"description":"Identifier record of a legal entity"}},"legalShortName":{"type":"string","description":"Abbreviated name or shorthand"},"legalForm":{"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key to be used for reference"},"name":{"type":"string","description":"Full name of the legal form"},"abbreviation":{"type":"string","description":"Abbreviation of the legal form name"}},"description":"Legal form a business partner can have"},"states":{"type":"array","items":{"type":"object","properties":{"officialDenotation":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"classifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Name of the classification"},"code":{"type":"string","description":"Identifying code of the classification, if applicable"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["NACE","NAF","NAICS","SIC"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Classification record of a business partner"}},"relations":{"type":"array","items":{"type":"object","properties":{"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"startBpn":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpn":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The timestamp the business partner data was last indicated to be still current","format":"date-time"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"legalAddress":{"type":"object","properties":{"bpna":{"type":"string","description":"Business Partner Number of this address"},"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnLegalEntity":{"type":"string","description":"BPN of the related legal entity, if available"},"bpnSite":{"type":"string","description":"BPN of the related site, if available"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"isLegalAddress":{"type":"boolean","description":"Flag if this is the legal address of its related legal entity"},"isMainAddress":{"type":"boolean","description":"Flag if this is the main address of its related site"}},"description":"Logistic address "}},"description":"Legal entity record"}}}},"400":{"description":"On malformed request parameters"},"404":{"description":"No business partner found under specified identifier or specified identifier type not found"}},"method":"get","path":"/api/catena/legal-entities/{idValue}","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get legal entity business partner by identifier","description":{"content":"This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type.","type":"text/plain"},"url":{"path":["api","catena","legal-entities",":idValue"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Type of identifier to use, defaults to BPN when omitted","type":"text/plain"},"key":"idType","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Identifier value","type":"text/plain"},"type":"any","value":"","key":"idValue"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get legal entity business partner by identifier - - - -This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type. - -
Path Parameters
Query Parameters
- -Found business partner with specified identifier - -
Schema
    identifiers object[]
    type object
    - -Named type uniquely identified by its technical key - -
    legalForm object
    - -Legal form a business partner can have - -
    states object[]
    type object
    - -Named type uniquely identified by its technical key - -
    classifications object[]
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    type object
    - -Named type uniquely identified by its technical key - -
    legalAddress object
    - -Logistic address - -
    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
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed request parameters - -
- -No business partner found under specified identifier or specified identifier type not found - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms.api.mdx deleted file mode 100644 index 9a176c23b1e..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-legal-forms -title: "Get page of legal forms" -description: "Lists all currently known legal forms in a paginated result" -sidebar_label: "Get page of legal forms" -hide_title: true -hide_table_of_contents: true -api: {"tags":["metadata-controller"],"description":"Lists all currently known legal forms in a paginated result","operationId":"getLegalForms","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of existing legal forms, may be empty","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key to be used for reference"},"name":{"type":"string","description":"Full name of the legal form"},"abbreviation":{"type":"string","description":"Abbreviation of the legal form name"}},"description":"Legal form a business partner can have"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters"}},"method":"get","path":"/api/catena/legal-forms","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get page of legal forms","description":{"content":"Lists all currently known legal forms in a paginated result","type":"text/plain"},"url":{"path":["api","catena","legal-forms"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of legal forms - - - -Lists all currently known legal forms in a paginated result - -
Query Parameters
- -Page of existing legal forms, may be empty - -
Schema
    content object[]
    - -Collection of results in the page - -
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-site.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-site.api.mdx deleted file mode 100644 index 38987906d07..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-site.api.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -id: get-site -title: "Get site partners by bpn" -description: "Get business partners of type site by bpn-s ignoring case." -sidebar_label: "Get site partners by bpn" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Get business partners of type site by bpn-s ignoring case.","operationId":"getSite","parameters":[{"name":"bpn","in":"path","description":"Bpn value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found site with specified bpn","content":{"application/json":{"schema":{"type":"object","properties":{"bpns":{"type":"string","description":"Business Partner Number, main identifier value for sites"},"name":{"type":"string","description":"Site name"},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a site"}},"bpnLegalEntity":{"type":"string","description":"Business Partner Number of the related legal entity"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"mainAddress":{"type":"object","properties":{"bpna":{"type":"string","description":"Business Partner Number of this address"},"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnLegalEntity":{"type":"string","description":"BPN of the related legal entity, if available"},"bpnSite":{"type":"string","description":"BPN of the related site, if available"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"isLegalAddress":{"type":"boolean","description":"Flag if this is the legal address of its related legal entity"},"isMainAddress":{"type":"boolean","description":"Flag if this is the main address of its related site"}},"description":"Logistic address "}},"description":"Site with legal entity reference."}}}},"400":{"description":"On malformed request parameters"},"404":{"description":"No site found under specified bpn"}},"method":"get","path":"/api/catena/sites/{bpn}","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get site partners by bpn","description":{"content":"Get business partners of type site by bpn-s ignoring case.","type":"text/plain"},"url":{"path":["api","catena","sites",":bpn"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Bpn value","type":"text/plain"},"type":"any","value":"","key":"bpn"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get site partners by bpn - - - -Get business partners of type site by bpn-s ignoring case. - -
Path Parameters
- -Found site with specified bpn - -
Schema
    states object[]
    type object
    - -Named type uniquely identified by its technical key - -
    mainAddress object
    - -Logistic address - -
    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
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed request parameters - -
- -No site found under specified bpn - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-sites.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-sites.api.mdx deleted file mode 100644 index 3209c90f9ca..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/get-sites.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: get-sites -title: "Get site partners of a legal entity" -description: "Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpnl ignoring case." -sidebar_label: "Get site partners of a legal entity" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpnl ignoring case.","operationId":"getSites","parameters":[{"name":"bpnl","in":"path","description":"Bpnl value","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"The sites for the specified bpnl","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"bpns":{"type":"string","description":"Business Partner Number, main identifier value for sites"},"name":{"type":"string","description":"Site name"},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a site"}},"bpnLegalEntity":{"type":"string","description":"Business Partner Number of the related legal entity"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"}},"description":"Site of a legal entity"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"},"404":{"description":"No business partner found for specified bpnl"}},"method":"get","path":"/api/catena/legal-entities/{bpnl}/sites","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Get site partners of a legal entity","description":{"content":"Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpnl ignoring case.","type":"text/plain"},"url":{"path":["api","catena","legal-entities",":bpnl","sites"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Bpnl value","type":"text/plain"},"type":"any","value":"","key":"bpnl"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get site partners of a legal entity - - - -Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpnl ignoring case. - -
Path Parameters
Query Parameters
- -The sites for the specified bpnl - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    type object
    - -Named type uniquely identified by its technical key - -
- -On malformed pagination request - -
- -No business partner found for specified bpnl - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses.api.mdx deleted file mode 100644 index 5157c24937a..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses.api.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: search-addresses -title: "Search address partners by BPNs and/or parent BPNs" -description: "Search business partners of type address by their BPN or their parent partners BPN (BPNLs or BPNS)." -sidebar_label: "Search address partners by BPNs and/or parent BPNs" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Search business partners of type address by their BPN or their parent partners BPN (BPNLs or BPNS).","operationId":"searchAddresses","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"legalEntities":{"type":"array","items":{"type":"string"}},"sites":{"type":"array","items":{"type":"string"}},"addresses":{"type":"array","items":{"type":"string"}}},"description":"Request for searching business partners of type address by parent BPNs"}}},"required":true},"responses":{"200":{"description":"Found sites for the specified sites and legal entities","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"bpna":{"type":"string","description":"Business Partner Number of this address"},"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnLegalEntity":{"type":"string","description":"BPN of the related legal entity, if available"},"bpnSite":{"type":"string","description":"BPN of the related site, if available"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"isLegalAddress":{"type":"boolean","description":"Flag if this is the legal address of its related legal entity"},"isMainAddress":{"type":"boolean","description":"Flag if this is the main address of its related site"}},"description":"Logistic address "}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/api/catena/addresses/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"legalEntities":["string"],"sites":["string"],"addresses":["string"]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Search address partners by BPNs and/or parent BPNs","description":{"content":"Search business partners of type address by their BPN or their parent partners BPN (BPNLs or BPNS).","type":"text/plain"},"url":{"path":["api","catena","addresses","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Search address partners by BPNs and/or parent BPNs - - - -Search business partners of type address by their BPN or their parent partners BPN (BPNLs or BPNS). - -
Query Parameters
Request Body required
- -Found sites for the specified sites and legal entities - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/search-legal-addresses.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/search-legal-addresses.api.mdx deleted file mode 100644 index 6a2ad6fcebf..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/search-legal-addresses.api.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: search-legal-addresses -title: "Search Legal Addresses" -description: "Search legal addresses of legal entities by BPNL" -sidebar_label: "Search Legal Addresses" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Search legal addresses of legal entities by BPNL","operationId":"searchLegalAddresses","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"The found legal addresses","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnLegalEntity":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"description":"Legal address for legal entity"}}}}},"400":{"description":"On malformed request parameters"}},"method":"post","path":"/api/catena/legal-entities/legal-addresses/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Search Legal Addresses","description":{"content":"Search legal addresses of legal entities by BPNL","type":"text/plain"},"url":{"path":["api","catena","legal-entities","legal-addresses","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Search Legal Addresses - - - -Search legal addresses of legal entities by BPNL - -
Request Body array required
  • string
- -The found legal addresses - -
Schema array
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/search-main-addresses.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/search-main-addresses.api.mdx deleted file mode 100644 index ef31df438a4..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/search-main-addresses.api.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: search-main-addresses -title: "Search Main Addresses" -description: "Search main addresses of site business partners by BPNS" -sidebar_label: "Search Main Addresses" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Search main addresses of site business partners by BPNS","operationId":"searchMainAddresses","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"The found main addresses","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnSite":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"description":"Main address for site"}}}}},"400":{"description":"On malformed request parameters"}},"method":"post","path":"/api/catena/sites/main-addresses/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Search Main Addresses","description":{"content":"Search main addresses of site business partners by BPNS","type":"text/plain"},"url":{"path":["api","catena","sites","main-addresses","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Search Main Addresses - - - -Search main addresses of site business partners by BPNS - -
Request Body array required
  • string
- -The found main addresses - -
Schema array
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/search-sites-1.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/search-sites-1.api.mdx deleted file mode 100644 index e2b37a56303..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/search-sites-1.api.mdx +++ /dev/null @@ -1,90 +0,0 @@ ---- -id: search-sites-1 -title: "Search legal entity partners by BPNLs" -description: "Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to ${bpdm.bpn.search-request-limit} entries." -sidebar_label: "Search legal entity partners by BPNLs" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to ${bpdm.bpn.search-request-limit} entries.","operationId":"searchSites_1","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"Found legal entites","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"legalName":{"type":"string","description":"Legal name the partner goes by"},"bpnl":{"type":"string","description":"Business Partner Number of this legal entity"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"Body which issued the identifier"}},"description":"Identifier record of a legal entity"}},"legalShortName":{"type":"string","description":"Abbreviated name or shorthand"},"legalForm":{"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key to be used for reference"},"name":{"type":"string","description":"Full name of the legal form"},"abbreviation":{"type":"string","description":"Abbreviation of the legal form name"}},"description":"Legal form a business partner can have"},"states":{"type":"array","items":{"type":"object","properties":{"officialDenotation":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"classifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Name of the classification"},"code":{"type":"string","description":"Identifying code of the classification, if applicable"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["NACE","NAF","NAICS","SIC"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Classification record of a business partner"}},"relations":{"type":"array","items":{"type":"object","properties":{"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"startBpn":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpn":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The timestamp the business partner data was last indicated to be still current","format":"date-time"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"legalAddress":{"type":"object","properties":{"bpna":{"type":"string","description":"Business Partner Number of this address"},"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnLegalEntity":{"type":"string","description":"BPN of the related legal entity, if available"},"bpnSite":{"type":"string","description":"BPN of the related site, if available"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"isLegalAddress":{"type":"boolean","description":"Flag if this is the legal address of its related legal entity"},"isMainAddress":{"type":"boolean","description":"Flag if this is the main address of its related site"}},"description":"Logistic address "}},"description":"Legal entity record"}}}}},"400":{"description":"On malformed request parameters or if number of requested bpns exceeds limit"}},"method":"post","path":"/api/catena/legal-entities/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Search legal entity partners by BPNLs","description":{"content":"Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to ${bpdm.bpn.search-request-limit} entries.","type":"text/plain"},"url":{"path":["api","catena","legal-entities","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Search legal entity partners by BPNLs - - - -Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to ${bpdm.bpn.search-request-limit} entries. - -
Request Body array required
  • string
- -Found legal entites - -
Schema array
    identifiers object[]
    type object
    - -Named type uniquely identified by its technical key - -
    legalForm object
    - -Legal form a business partner can have - -
    states object[]
    type object
    - -Named type uniquely identified by its technical key - -
    classifications object[]
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    type object
    - -Named type uniquely identified by its technical key - -
    legalAddress object
    - -Logistic address - -
    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
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed request parameters or if number of requested bpns exceeds limit - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/search-sites.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/search-sites.api.mdx deleted file mode 100644 index 96f05f38e3b..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/search-sites.api.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -id: search-sites -title: "Search site partners by BPNs and/or parent BPNs" -description: "Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities" -sidebar_label: "Search site partners by BPNs and/or parent BPNs" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities","operationId":"searchSites","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"legalEntities":{"type":"array","items":{"type":"string"}},"sites":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"Found sites that belong to specified legal entites","content":{"application/json":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"type":"object","properties":{"bpns":{"type":"string","description":"Business Partner Number, main identifier value for sites"},"name":{"type":"string","description":"Site name"},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a site"}},"bpnLegalEntity":{"type":"string","description":"Business Partner Number of the related legal entity"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"mainAddress":{"type":"object","properties":{"bpna":{"type":"string","description":"Business Partner Number of this address"},"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnLegalEntity":{"type":"string","description":"BPN of the related legal entity, if available"},"bpnSite":{"type":"string","description":"BPN of the related site, if available"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"isLegalAddress":{"type":"boolean","description":"Flag if this is the legal address of its related legal entity"},"isMainAddress":{"type":"boolean","description":"Flag if this is the main address of its related site"}},"description":"Logistic address "}},"description":"Site with legal entity reference."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters"}},"method":"post","path":"/api/catena/sites/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"legalEntities":["string"],"sites":["string"]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Search site partners by BPNs and/or parent BPNs","description":{"content":"Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities","type":"text/plain"},"url":{"path":["api","catena","sites","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Search site partners by BPNs and/or parent BPNs - - - -Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities - -
Query Parameters
Request Body required
- -Found sites that belong to specified legal entites - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    type object
    - -Named type uniquely identified by its technical key - -
    mainAddress object
    - -Logistic address - -
    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
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/set-legal-entity-currentness.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/set-legal-entity-currentness.api.mdx deleted file mode 100644 index 5347dff3d98..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/set-legal-entity-currentness.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: set-legal-entity-currentness -title: "Confirms that the data of a legal entity business partner is still up to date." -description: "Confirms that the data of a business partner is still up to date by saving the current timestamp at the time this POST-request is made as this business partner's 'currentness'. Ignores case of bpnl." -sidebar_label: "Confirms that the data of a legal entity business partner is still up to date." -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Confirms that the data of a business partner is still up to date by saving the current timestamp at the time this POST-request is made as this business partner's \"currentness\". Ignores case of bpnl.","operationId":"setLegalEntityCurrentness","parameters":[{"name":"bpnl","in":"path","description":"Bpnl value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Business partner's \"currentness\" successfully updated"},"400":{"description":"On malformed request parameters"},"404":{"description":"No business partner found for specified bpnl"}},"method":"post","path":"/api/catena/legal-entities/{bpnl}/confirm-up-to-date","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Confirms that the data of a legal entity business partner is still up to date.","description":{"content":"Confirms that the data of a business partner is still up to date by saving the current timestamp at the time this POST-request is made as this business partner's \"currentness\". Ignores case of bpnl.","type":"text/plain"},"url":{"path":["api","catena","legal-entities",":bpnl","confirm-up-to-date"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Bpnl value","type":"text/plain"},"type":"any","value":"","key":"bpnl"}]},"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Confirms that the data of a legal entity business partner is still up to date. - - - -Confirms that the data of a business partner is still up to date by saving the current timestamp at the time this POST-request is made as this business partner's "currentness". Ignores case of bpnl. - -
Path Parameters
- -Business partner's "currentness" successfully updated - -
- -On malformed request parameters - -
- -No business partner found for specified bpnl - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/sidebar.js b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/sidebar.js deleted file mode 100644 index 8dcc46b9887..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool"},{"type":"category","label":"site-controller","link":{"type":"generated-index","title":"site-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/site-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/update-site","label":"Update existing site business partners","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-site","label":"Create new site business partners","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-sites","label":"Search site partners by BPNs and/or parent BPNs","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-main-addresses","label":"Search Main Addresses","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-site","label":"Get site partners by bpn","className":"api-method get"}]},{"type":"category","label":"legal-entity-controller","link":{"type":"generated-index","title":"legal-entity-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/legal-entity-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities","label":"Get page of legal entity business partners matching the search criteria","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners","label":"Update existing legal entity business partners","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners","label":"Create new legal entity business partners","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/set-legal-entity-currentness","label":"Confirms that the data of a legal entity business partner is still up to date.","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-sites-1","label":"Search legal entity partners by BPNLs","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-legal-addresses","label":"Search Legal Addresses","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity","label":"Get legal entity business partner by identifier","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-sites","label":"Get site partners of a legal entity","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-addresses","label":"Get address partners of a legal entity","className":"api-method get"}]},{"type":"category","label":"address-controller","link":{"type":"generated-index","title":"address-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/address-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1","label":"Get page of addresses matching the search criteria","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/update-addresses","label":"Update existing address business partners","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-addresses","label":"Create new address business partners","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-addresses","label":"Search address partners by BPNs and/or parent BPNs","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-address","label":"Get address partners by bpna","className":"api-method get"}]},{"type":"category","label":"open-search-controller","link":{"type":"generated-index","title":"open-search-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/open-search-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-business-partners","label":"Fetch information about the latest OpenSearch export","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/export","label":"Index new business partner records on OpenSearch","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/clear","label":"Clear business partner index on OpenSearch","className":"api-method delete"}]},{"type":"category","label":"metadata-controller","link":{"type":"generated-index","title":"metadata-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/metadata-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms","label":"Get page of legal forms","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form","label":"Create new legal form","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types","label":"Get page of identifier types filtered by lsaType and (optionally) country (specified by its ISO 3166-1 alpha-2 country code)","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type","label":"Create new identifier type","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-field-quality-rules","label":"Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code)","className":"api-method get"}]},{"type":"category","label":"changelog-controller","link":{"type":"generated-index","title":"changelog-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/changelog-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries","label":"Get business partner changelog entries from time, by BPN and/or LSA type","className":"api-method post"}]},{"type":"category","label":"bpn-controller","link":{"type":"generated-index","title":"bpn-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/bpn-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers","label":"Find business partner numbers by identifiers","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/update-addresses.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/update-addresses.api.mdx deleted file mode 100644 index 44df5edec6d..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/update-addresses.api.mdx +++ /dev/null @@ -1,86 +0,0 @@ ---- -id: update-addresses -title: "Update existing address business partners" -description: "Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change." -sidebar_label: "Update existing address business partners" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change.","operationId":"updateAddresses","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"bpna":{"type":"string"},"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"}},"description":"Request for updating a business partner record of type address"}}}},"required":true},"responses":{"200":{"description":"The successfully updated records, possible errors are returned","content":{"application/json":{"schema":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"object","properties":{"bpna":{"type":"string","description":"Business Partner Number of this address"},"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnLegalEntity":{"type":"string","description":"BPN of the related legal entity, if available"},"bpnSite":{"type":"string","description":"BPN of the related site, if available"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"isLegalAddress":{"type":"boolean","description":"Flag if this is the legal address of its related legal entity"},"isMainAddress":{"type":"boolean","description":"Flag if this is the main address of its related site"}},"description":"Logistic address "}},"errors":{"type":"array","items":{"title":"ErrorInfo","type":"object","properties":{"errorCode":{"type":"string","description":"AddressUpdateError","enum":["AddressNotFound"]},"message":{"type":"string"},"entityKey":{"type":"string"}},"description":"Holds information about failures when creating or updating an entity"}},"errorCount":{"type":"integer","format":"int32"},"entityCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"put","path":"/api/catena/addresses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"bpna":"string","name":"string","states":[{"description":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","street":{"name":"string","houseNumber":"string","milestone":"string","direction":"string"},"administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","district":"string","companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","administrativeAreaLevel1":"string","deliveryServiceNumber":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string"}}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Update existing address business partners","description":{"content":"Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change.","type":"text/plain"},"url":{"path":["api","catena","addresses"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Update existing address business partners - - - -Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change. - -
Request Body array required
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -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
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners.api.mdx deleted file mode 100644 index 6a409556f77..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners.api.mdx +++ /dev/null @@ -1,114 +0,0 @@ ---- -id: update-business-partners -title: "Update existing legal entity business partners" -description: "Update existing business partner records of type legal entity referenced via BPNL. The endpoint expects to receive the full updated record, including values that didn't change." -sidebar_label: "Update existing legal entity business partners" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Update existing business partner records of type legal entity referenced via BPNL. The endpoint expects to receive the full updated record, including values that didn't change.","operationId":"updateBusinessPartners","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"bpnl":{"type":"string"},"legalName":{"type":"string","description":"Legal name the partner goes by"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"},"issuingBody":{"type":"string","description":"Body which issued the identifier"}},"description":"Identifier record for a legal entity"}},"legalShortName":{"type":"string","description":"Abbreviated name or shorthand"},"legalForm":{"type":"string","description":"Technical key of the legal form"},"states":{"type":"array","items":{"type":"object","properties":{"officialDenotation":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record of a legal entity"}},"classifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Name of the classification"},"code":{"type":"string","description":"Identifying code of the classification, if applicable"},"type":{"type":"string","description":"Type of specified classification","enum":["NACE","NAF","NAICS","SIC"]}},"description":"Classification record for a business partner"}},"legalAddress":{"type":"object","properties":{"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"}},"description":"Address record for a business partner"}},"description":"Request for updating a business partner record of type legal entity"}}}},"required":true},"responses":{"200":{"description":"Update legal entities request was processed successfully, possible errors are returned","content":{"application/json":{"schema":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"object","properties":{"legalName":{"type":"string","description":"Legal name the partner goes by"},"bpnl":{"type":"string","description":"Business Partner Number of this legal entity"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"Body which issued the identifier"}},"description":"Identifier record of a legal entity"}},"legalShortName":{"type":"string","description":"Abbreviated name or shorthand"},"legalForm":{"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key to be used for reference"},"name":{"type":"string","description":"Full name of the legal form"},"abbreviation":{"type":"string","description":"Abbreviation of the legal form name"}},"description":"Legal form a business partner can have"},"states":{"type":"array","items":{"type":"object","properties":{"officialDenotation":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"classifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Name of the classification"},"code":{"type":"string","description":"Identifying code of the classification, if applicable"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["NACE","NAF","NAICS","SIC"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Classification record of a business partner"}},"relations":{"type":"array","items":{"type":"object","properties":{"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"startBpn":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpn":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The timestamp the business partner data was last indicated to be still current","format":"date-time"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"legalAddress":{"type":"object","properties":{"bpna":{"type":"string","description":"Business Partner Number of this address"},"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnLegalEntity":{"type":"string","description":"BPN of the related legal entity, if available"},"bpnSite":{"type":"string","description":"BPN of the related site, if available"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"isLegalAddress":{"type":"boolean","description":"Flag if this is the legal address of its related legal entity"},"isMainAddress":{"type":"boolean","description":"Flag if this is the main address of its related site"}},"description":"Logistic address "},"index":{"type":"string"}},"description":"Created business partner of type legal entity"}},"errors":{"type":"array","items":{"title":"ErrorInfo","type":"object","properties":{"errorCode":{"type":"string","description":"LegalEntityUpdateError","enum":["LegalEntityNotFound"]},"message":{"type":"string"},"entityKey":{"type":"string"}},"description":"Holds information about failures when creating or updating an entity"}},"errorCount":{"type":"integer","format":"int32"},"entityCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"put","path":"/api/catena/legal-entities","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"bpnl":"string","legalName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"legalShortName":"string","legalForm":"string","states":[{"officialDenotation":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"classifications":[{"value":"string","code":"string","type":"NACE"}],"legalAddress":{"name":"string","states":[{"description":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","street":{"name":"string","houseNumber":"string","milestone":"string","direction":"string"},"administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","district":"string","companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","administrativeAreaLevel1":"string","deliveryServiceNumber":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string"}}}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Update existing legal entity business partners","description":{"content":"Update existing business partner records of type legal entity referenced via BPNL. The endpoint expects to receive the full updated record, including values that didn't change.","type":"text/plain"},"url":{"path":["api","catena","legal-entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Update existing legal entity business partners - - - -Update existing business partner records of type legal entity referenced via BPNL. The endpoint expects to receive the full updated record, including values that didn't change. - -
Request Body array required
    identifiers object[]
    states object[]
    classifications object[]
    legalAddress object
    - -Address record for a business partner - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -Update legal entities request was processed successfully, possible errors are returned - -
Schema
    entities object[]
    identifiers object[]
    type object
    - -Named type uniquely identified by its technical key - -
    legalForm object
    - -Legal form a business partner can have - -
    states object[]
    type object
    - -Named type uniquely identified by its technical key - -
    classifications object[]
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    type object
    - -Named type uniquely identified by its technical key - -
    legalAddress object
    - -Logistic address - -
    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
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/update-site.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/update-site.api.mdx deleted file mode 100644 index 476dd161dcf..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/Pool Api/update-site.api.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -id: update-site -title: "Update existing site business partners" -description: "Update existing business partner records of type site referenced via BPNS. The endpoint expects to receive the full updated record, including values that didn't change." -sidebar_label: "Update existing site business partners" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Update existing business partner records of type site referenced via BPNS. The endpoint expects to receive the full updated record, including values that didn't change.","operationId":"updateSite","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"bpns":{"type":"string"},"name":{"type":"string","description":"Site name"},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record of a site"}},"mainAddress":{"type":"object","properties":{"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"string","description":"The type of this specified status","enum":["ACTIVE","INACTIVE"]}},"description":"Status record for a address"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"string","description":"Technical key of the type to which this identifier belongs to"}},"description":"Identifier record for a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"}},"description":"Address record for a business partner"}},"description":"Request for updating a business partner record of type site"}}}},"required":true},"responses":{"200":{"description":"Update sites request was processed successfully, possible errors are returned","content":{"application/json":{"schema":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"object","properties":{"bpns":{"type":"string","description":"Business Partner Number, main identifier value for sites"},"name":{"type":"string","description":"Site name"},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a site"}},"bpnLegalEntity":{"type":"string","description":"Business Partner Number of the related legal entity"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"mainAddress":{"type":"object","properties":{"bpna":{"type":"string","description":"Business Partner Number of this address"},"name":{"type":"string","description":"Name of the logistic address of the business partner. This is not according to official\nregisters but according to the name the uploading sharing member chooses."},"states":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Exact, official denotation of the status"},"validFrom":{"type":"string","description":"Since when the status is/was valid","format":"date-time"},"validTo":{"type":"string","description":"Until the status was valid, if applicable","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Status record of a legal entity"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Value of the identifier"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a logistic address"}},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"street":{"type":"object","properties":{"name":{"type":"string","description":"Describes the official Name of the Street."},"houseNumber":{"type":"string","description":"Describes the House Number"},"milestone":{"type":"string","description":"The Milestone is relevant for long roads without specific house numbers."},"direction":{"type":"string","description":"Describes the direction"}},"description":"A public road in a city, town, or village, typically with houses and buildings on one or both sides."},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"administrativeAreaLevel2":{"type":"string","description":"Further possibility to describe the region/address(e.g. County/Landkreis)"},"administrativeAreaLevel3":{"type":"string","description":"Further possibility to describe the region/address(e.g. Township/Gemeinde)"},"district":{"type":"string","description":"Divides the city in several smaller areas"},"companyPostalCode":{"type":"string","description":"A separate postal code for a company, also known as postcode, PIN or ZIP Code"},"industrialZone":{"type":"string","description":"The practice of designating an area for industrial development"},"building":{"type":"string","description":"Describes a specific building within the address"},"floor":{"type":"string","description":"Describes the floor/level the delivery shall take place"},"door":{"type":"string","description":"Describes the door/room/suite on the respective floor the delivery shall take place"}},"description":"Physical Postal Address Part"},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"Geo coordinates record for an address"},"country":{"type":"string","description":"Describes the country","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"postalCode":{"type":"string","description":"A postal code, also known as postcode, PIN or ZIP Code"},"city":{"type":"string","description":"The city of the address (Synonym: Town, village, municipality)"},"administrativeAreaLevel1":{"type":"string","description":"Identifying code of the Region within the country (e.g. Bayern)"},"deliveryServiceNumber":{"type":"string","description":"Describes the PO Box or private Bag number the delivery should be placed at."},"deliveryServiceType":{"type":"string","description":"The type of this specified delivery","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"Delivery Service Qualifier"}},"description":"Alternative Postal Address Part"},"bpnLegalEntity":{"type":"string","description":"BPN of the related legal entity, if available"},"bpnSite":{"type":"string","description":"BPN of the related site, if available"},"createdAt":{"type":"string","description":"The timestamp the business partner data was created","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp the business partner data was last updated","format":"date-time"},"isLegalAddress":{"type":"boolean","description":"Flag if this is the legal address of its related legal entity"},"isMainAddress":{"type":"boolean","description":"Flag if this is the main address of its related site"}},"description":"Logistic address "},"index":{"type":"string"}},"description":"Created business partner record of type site"}},"errors":{"type":"array","items":{"title":"ErrorInfo","type":"object","properties":{"errorCode":{"type":"string","description":"SiteUpdateError","enum":["SiteNotFound"]},"message":{"type":"string"},"entityKey":{"type":"string"}},"description":"Holds information about failures when creating or updating an entity"}},"errorCount":{"type":"integer","format":"int32"},"entityCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"put","path":"/api/catena/sites","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"bpns":"string","name":"string","states":[{"description":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"mainAddress":{"name":"string","states":[{"description":"string","validFrom":"2023-06-26","validTo":"2023-06-26","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","street":{"name":"string","houseNumber":"string","milestone":"string","direction":"string"},"administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","district":"string","companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","postalCode":"string","city":"string","administrativeAreaLevel1":"string","deliveryServiceNumber":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string"}}}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0-SNAPSHOT"},"postman":{"name":"Update existing site business partners","description":{"content":"Update existing business partner records of type site referenced via BPNS. The endpoint expects to receive the full updated record, including values that didn't change.","type":"text/plain"},"url":{"path":["api","catena","sites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Update existing site business partners - - - -Update existing business partner records of type site referenced via BPNS. The endpoint expects to receive the full updated record, including values that didn't change. - -
Request Body array required
    states object[]
    mainAddress object
    - -Address record for a business partner - -
    states object[]
    identifiers object[]
    physicalPostalAddress object
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -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
    - -Logistic address - -
    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
    - -Physical Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    street object
    - -A public road in a city, town, or village, typically with houses and buildings on one or both sides. - -
    alternativePostalAddress object
    - -Alternative Postal Address Part - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/_category_.json b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/_category_.json deleted file mode 100644 index e5c5b7565a3..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Development View" -} diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/page_software-development-view.md deleted file mode 100644 index 14f0eb4fe29..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/page_software-development-view.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -id: Specification -title: Specification -description: '' -sidebar_position: 1 ---- - -![Business partner kit banner](@site/static/img/BPKitIcon.png) - -### Business Partner KIT - -## API Reference - -The BPDM is comprised of two primary services: BPDM Pool and BPDM Gate. The Swagger UI interface, which is an interactive tool for exploring and testing RESTful APIs. Swagger UI provides a user-friendly interface for interacting with APIs, allowing you to make requests, view responses, and explore different API endpoints and operations, allowing you to drill down into specific endpoints and view the associated request parameters, response schemas, and sample responses. - -The Business Partner Data Management includes the services that manages and shares business partner data with other Catena-X services. In the following sections, the available methods and different controllers of the API are explained. -More Information to the open-source repository can be found on [GitHub](https://github.com/eclipse-tractusx/bpdm) - -## BPDM Pool Api reference - -The Business Partner Data Management Pool includes the services that manages and shares business partner data with other Catena-X services. In the following sections, the available methods and different controllers of the API are explained. - -### Available Methods - -| Request Method | Request Description| -| :----------- | :------------: | -| PUT | Update. The endpoint expects to receive the full updated record, including values that didn't change.| -| POST| Search | -| GET | Search for the best match | -| DELETE | Deletes all the records in the controller, resets the timestamp| - -### 1. Site Controller - -The Site Controller is the controller that creates, updates, or retrieves business partners of type site (referenced via BPNS). There are PUT, POST and GET requests possible and api those are availble under site controller are clustered in table below. Hyperlink in each record gives you more information about api endpoint. - -| Site Controller Apis| -| :----------- | -| [Update existing site business partners](../Software%20Development%20View/Pool%20Api/update-site.api.mdx) | -| [Create new site business partners](../Software%20Development%20View/Pool%20Api/create-site.api.mdx) | -| [Search site partners by BPNs and/or parent BPNs](../Software%20Development%20View/Pool%20Api/search-sites.api.mdx) | -| [Search Main Addresses](../Software%20Development%20View/Pool%20Api/search-main-addresses.api.mdx) | -| [Get site partners by bpn](../Software%20Development%20View/Pool%20Api/get-site.api.mdx) | - -### 2. Legal Entity Controller - -The Legal Entity Controller calls, searches, creates or updates existing business partners of type legal entity (referenced via BPNL). There are PUT, POST and GET requests possible. The endpoint expects a perfect match or looks for the highest relevancy, depending on the request made. Some of the requests need a obligatory parameter, like business partner number or id value. Hyperlink in each record gives you more information about api endpoint. - -| Legal Entity Controller Apis| -| :----------- | -| [Get page of legal entity business partners matching the search criteria](../Software%20Development%20View/Pool%20Api/get-legal-entities.api.mdx) | -| [Update existing legal entity business partners](../Software%20Development%20View/Pool%20Api/update-business-partners.api.mdx) | -| [Create new legal entity business partners](../Software%20Development%20View/Pool%20Api/create-business-partners.api.mdx)| -| [Confirms that the data of a legal entity business partner is still up to date.](../Software%20Development%20View/Pool%20Api/set-legal-entity-currentness.api.mdx)| -| [Search legal entity partners by BPNLs.](../Software%20Development%20View/Pool%20Api/search-sites-1.api.mdx) | -| [Search Legal Addresses.](../Software%20Development%20View/Pool%20Api/search-legal-addresses.api.mdx)| -| [Get legal entity business partner by identifier.](../Software%20Development%20View/Pool%20Api/get-legal-entity.api.mdx) | -| [Get site partners of a legal entity.](../Software%20Development%20View/Pool%20Api/get-sites.api.mdx) | -| [Get address partners of a legal entity.](../Software%20Development%20View/Pool%20Api/get-addresses.api.mdx) | - -### 3. Address Controller - -The Address Controller is the controller that updates, creates, or retrieves business partner records of type address via BPNA. There are PUT, POST and GET requests possible. Hyperlink in each record gives you more information about api endpoint. - -| Address Controller Apis| -| :----------- | -| [Get page of addresses matching the search criteria](../Software%20Development%20View/Pool%20Api/get-addresses-1.api.mdx) | -| [Update existing address business partners](../Software%20Development%20View/Pool%20Api/update-addresses.api.mdx) | -| [Create new address business partners](../Software%20Development%20View/Pool%20Api/create-addresses.api.mdx) | -| [Search address partners by BPNs and/or parent BPNs](../Software%20Development%20View/Pool%20Api/search-addresses.api.mdx) | -| [Get address partners by bpna](../Software%20Development%20View/Pool%20Api/get-address.api.mdx) | - -### 4. Open Search Controller - -The Open Search Controller is only used by the developers on the backend of the API. They are not relevant for the API end-users. Hyperlink in each record gives you more information about api endpoint. - -| Open Search Controller Apis| -| :----------- | -| [Fetch information about the latest OpenSearch export](../Software%20Development%20View/Pool%20Api/get-business-partners.api.mdx) | -| [Index new business partner records on OpenSearch](../Software%20Development%20View/Pool%20Api/export.api.mdx) | -| [Clear business partner index on OpenSearch](../Software%20Development%20View/Pool%20Api/clear.api.mdx) | - -### 5. Metadata Controller - -The Metadata Controller can retrieve and create legal forms, new issuing bodies, identifier types and identifier statuses. There are POST and GET requests possible. Hyperlink in each record gives you more information about api endpoint. - -| Metadata Controller | -| :----------- | -| [Get page of legal forms](../Software%20Development%20View/Pool%20Api/get-legal-forms.api.mdx) | -| [Create new legal form](../Software%20Development%20View/Pool%20Api/create-legal-form.api.mdx) | -| [Get page of identifier types](../Software%20Development%20View/Pool%20Api/get-identifier-types.api.mdx) | -| [Create new identifier type](../Software%20Development%20View/Pool%20Api/create-identifier-type.api.mdx) | -| [Get all field quality rules filtered by country](../Software%20Development%20View/Pool%20Api/get-field-quality-rules.api.mdx) | - -### 6. Changelog Controller - -The changelog Controller can retrieve business partner changelog entries from time, by BPN and/or LSA type. The hyperlink in below record gives you more information about api endpoint. - -| Changelog Controller Api| -| :----------- | -| [Get business partner changelog entries from time, by BPN and/or LSA type](../Software%20Development%20View/Pool%20Api/get-changelog-entries.api.mdx) | - -### 7. BPN Controller - -The BPN Controller retrieves business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to ${bpdm.bpn.search-request-limit} entries. The hyperlink in below record gives you more information about api endpoint. - -| BPN Controller Api| -| :----------- | -| [Find business partner numbers by identifiers](../Software%20Development%20View/Pool%20Api/find-bpns-by-identifiers.api.mdx) | - -## BPDM Gate Api reference - -The Business Partner Data Management Gate includes the services that managesto share business partner data with Catena-X.In the following sections, the available methods and different controllers of the API are explained. - -### Available Methods - -| Request Method | Request Description| -| :----------- | :------------: | -| PUT | Update. The endpoint expects to receive the full updated record, including values that didn't change.| -| POST| Search | -| GET | Search for the best match | -| DELETE | Deletes all the records in the controller, resets the timestamp| - -Gate service consist of five major controllers which are listed below. - -### 1. Sharing-state Controller - -The Sharing-state Controller is the controller that updates, or retrieves business partners of any type (referenced via LSA Type or External identifiers). There are PUT and GET requests possible. - -| Sharing-state Controller Api| -| :----------- | -| [Get sharing states](../Software%20Development%20View/Gate%20Api/get-sharing-states.api.mdx) | -| [Insert/update sharing state](../Software%20Development%20View/Gate%20Api/upsert-sharing-state.api.mdx) | - -### 2. Site Controller - -The Site Controller is the controller that creates, updates, or retrieves business partners of type site (referenced via BPNS). There are PUT, POST and GET requests possible. - -| Site Controller Api| -| :----------- | -| [Create or update sites (Output)](../Software%20Development%20View/Gate%20Api/upsert-sites-output.api.mdx) | -| [Get page of sites](../Software%20Development%20View/Gate%20Api/get-sites.api.mdx) | -| [Create or update sites](../Software%20Development%20View/Gate%20Api/upsert-sites.api.mdx) | -| [Get page of sites. Can optionally be filtered by external ids](../Software%20Development%20View/Gate%20Api/get-sites-output.api.mdx) | -| [Get page of sites filtered by a collection of externalIds.](../Software%20Development%20View/Gate%20Api/get-sites-by-external-ids.api.mdx) | -| [Get site by external identifier](../Software%20Development%20View/Gate%20Api/get-site-by-external-id.api.mdx) | - -### 3. legal Entity Controller - -The Legal Entity Controller calls, searches, creates or updates existing business partners of type legal entity (referenced via BPNL). There are PUT, POST and GET requests possible. Some of the requests need a obligatory parameter, like external id. - -| legal Entity Controller | -| :----------- | -| [Create or update legal entities (Output).](../Software%20Development%20View/Gate%20Api/upsert-legal-entities-output.api.mdx) | -| [Get page of legal entities](../Software%20Development%20View/Gate%20Api/get-legal-entities.api.mdx) | -| [Create or update legal entities.](../Software%20Development%20View/Gate%20Api/upsert-legal-entities.api.mdx) | -| [Get page of legal entities. Can optionally be filtered by external ids](../Software%20Development%20View/Gate%20Api/get-legal-entities-output.api.mdx) | -| [Get page of legal-entities filtered by a collection of externalIds](../Software%20Development%20View/Gate%20Api/get-legal-entities-by-external-ids.api.mdx) | -| [Get legal entity by external identifier](../Software%20Development%20View/Gate%20Api/get-legal-entity-by-external-id.api.mdx) | - -### 4. Address Controller - -The Address Controller is the controller that updates, creates, or retrieves business partner records of type address via BPNA. There are PUT, POST and GET requests possible. - -| Address Controller | -| :----------- | -| [Create or update addresses (Output).](../Software%20Development%20View/Gate%20Api/put-addresses-output.api.mdx) | -| [Get page of addresses](../Software%20Development%20View/Gate%20Api/get-addresses.api.mdx) | -| [Create or update addresses](../Software%20Development%20View/Gate%20Api/upsert-addresses.api.mdx) | -| [Get page of addresses. Can optionally be filtered by external ids.](../Software%20Development%20View/Gate%20Api/get-addresses-output.api.mdx) | -| [Get page of addresses filtered by a collection of externalIds.](../Software%20Development%20View/Gate%20Api/get-addresses-by-external-ids.api.mdx) | -| [Get address by external identifier](../Software%20Development%20View/Gate%20Api/get-address-by-external-id.api.mdx) | - -### 5. Changelog controller - -The changelog controller is controller that gets business partner changelog entries by list of external id from timestamp. -Only two POST api's available for search of business partner changelog details for input and output respectively. - -| Changelog Controller | -| :----------- | -| [Get business partner changelog entries for changes to the business partner output data.](../Software%20Development%20View/Gate%20Api/get-output-changelog.api.mdx) | -| [Get business partner changelog entries for changes to the business partner input data.](../Software%20Development%20View/Gate%20Api/get-input-changelog.api.mdx) | - -## BPDM Bridge Dummy Api reference - -The Business Partner Data Management Bridge Dummy includes the services that sync business partner data between Gate and Pool Service. In the following sections, the available methods and different controllers of the API are explained. - -### Available Methods - -| Request Method | Request Description| -| :----------- | :------------: | -| POST| Sync between Gate and Pool | - -Bridge Dummy service consist of only one controllers which is listed below. - -### 1. Bridge Controller - -Bridge Controller is controller that perfom sync between Gate and Pool. There is only one api end point which is as mentioned below. - -| Bridge Controller API | -| :----------- | -| [Start sync between Gate and Pool](../Software%20Development%20View/Bridge%20Dummy%20Api/trigger-sync.api.mdx) | diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/page_use-cases.md b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/page_use-cases.md deleted file mode 100644 index 1a31b172851..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Software Development View/page_use-cases.md +++ /dev/null @@ -1,1755 +0,0 @@ ---- -id: Use Cases -title: Use Cases -description: '' -sidebar_position: 5 ---- - -Here we have provided detailed examples of how the BPDM services can be used. This includes step-by-step instructions for each use case and code snippets showing how to make the API calls for better performance. - -## Use case 1. Setup test data on local system - -Description: This use case provides step-by-step instructions for setting up the local environment and with instructions on getting started with all services including Gate, Pool and Bridge dummy service on local for the BPDM (Business Partner Data Management) system. By following these instructions, users can easily clone the repository, configure the necessary services using Docker, and run the all three api services on their local system. - -This use case aims to provide users with clear and concise instructions, ensuring a smooth setup process for working with the BPDM api services on their local system. - -### 1.1 Start BPDM Api Services - -1. Clone the repository: - - Go to the following GitHub repository: [https://github.com/eclipse-tractusx/bpdm](https://github.com/eclipse-tractusx/bpdm) - - Clone the repository to your local system using Git. You can use the following command: - - ```bash - git clone https://github.com/eclipse-tractusx/bpdm - ``` - - - Choose an IDE: You can use any IDE of your preference to view the code. One recommended IDE is IntelliJ IDEA as application is based on Kotlin springBoot framework. - -2. Configure local service: - - Open the docker-compose.yml file in the project. - - This file contains the configuration for running a local instance of PostgreSQL and OpenSearch. - - Make sure you have Docker installed on your system. - - If you don't have your own database, you can use Docker to create a local instance of PostgreSQL and OpenSearch. - - Run the following command from the command prompt or from the IDE's terminal to start the Docker containers: - - ```bash - docker-compose up - ``` - -3. Start the Gate API service: - - Open your IDE and navigate to the following directory within the cloned repository: bpdm/bpdm-gate. - - Navigate to Application.kt file from source directory i.e. /bpdm/bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/Application.kt. - - Run the main class Application.kt to start the Gate API service. - - The service should start and listen on the specified port i.e. by default on 8081 for local setup it will be on . - -4. Start the Pool API service: - - Open your IDE and navigate to the following directory within the cloned repository: bpdm/bpdm-pool. - - Navigate to Application.kt file from source directory i.e. /bpdm/bpdm-pool/src/main/kotlin/org/eclipse/tractusx/bpdm/pool/Application.kt. - - Run the main class Application.kt to start the Pool API service. - - The service should start and listen on the specified port i.e. by default on 8080 for local setup it will be on . - -5. Start the Bridge Dummy API service: - - Open your IDE and navigate to the following directory within the cloned repository: /bpdm/bpdm-bridge-dummy. - - Navigate to Application.kt file from source directory i.e. /bpdm/bpdm-bridge-dummy/src/main/kotlin/com/catenax/bpdm/bridge/dummy/Application.kt. - - Run the main class Application.kt to start the Bridge Dummy API service. - - The service should start and listen on the specified port i.e. by default on 8083 for local setup it will be on . - -### 1.2 Test data setup - -1. Download the Postman collection JSON files: - - You can copy collection for each service from provided hyperlink below and can download local variables from [here](../Software%20Development%20View/Local.postman_environment.json) - 1. [BPDM Bridge-Dummy service](../Software%20Development%20View/BPDM%20Bridge%20Dummy.postman_collection.json) - 2. [BPDM Gate Service](../Software%20Development%20View/BPDM%20Gate.postman_collection.json) - 3. [BPDM Pool Service](../Software%20Development%20View/BPDM%20Pool.postman_collection.json) - - Or for latest version of apis, you can navigate to the following GitHub repository path: [https://github.com/eclipse-tractusx/bpdm/tree/main/docs/postman](https://github.com/eclipse-tractusx/bpdm/tree/main/docs/postman) and locate the JSON files named as "BPDM Gate.postman_collection.json","BPDM Pool.postman_collection.json", "BPDM Bridge Dummy.postman_collection.json" and "local.postman_collection.json" click on it to view its contents. - - Click the "Raw" button to download the files or simply import jsons. - -2. Open Postman: - - If you don't have Postman installed, you can download it from the official website: [https://www.postman.com/downloads/](https://www.postman.com/downloads/) - - Open Postman on your local system. - -3. Import the collection: - - In the Postman application, click on the "Import" button located in the top left corner of the window. - - Select the "File" tab. - - Click on the "Choose Files" button and browse to the location where you downloaded the all files in step one. - - Select the JSON file and click "Open" to import them one by one. - -4. Verify the imported collection: - - After importing, you should see the "BPDM Gate", "BPDM Pool" and "BPDM Bridge Dummy" collection listed in the left sidebar of the Postman application. - - Click on the imported collection to expand it and view the available api requests and folders. - -5. Set up environment variables: - - In Postman, click on the "Manage Environments" button located in the top right corner of the window (it looks like an eye icon). - - Click on the "Add" button to create a new environment and can be done as per the variables mentioned into "local.postman_collection.json". - - Also, user can directly import "local.postman_collection.json" to update their environment variables. - -6. Explore Apis for each service: - - Api's for each service can be seen under postman collection with refernced test data. - - For more information on apis, user can refere section of [Api Reference](./page_software-development-view.md#api-reference) - -7. For Pool api service first check should be metadata availablity: - - Expand the "BPDM Pool Api" collection in the left sidebar. - - Under metadata controller, user need to check for Legal form, Identifier Type. - - Click on the "GET identifier-types" request. - - Click the "Send" button to make the request. - - Verify that the response contain the identifier types and if not present then user can hit POST request and create new identifiers as per the need. - - Similarly, repeat the above steps for Legal form as well. - - If any of the metadata is not available in the response, you can create them using the respective "POST" requests provided in the Postman collection as those are mandatory objects for golden records. - -By following above steps, user can use test data which has been created under postman collection. - -## Use Case 2. Request Legal Entity by identifier number - -Description: The Legal Entity Controller is a module within a larger system that facilitates the retrieval of information about a legal entity using their identifier number. In this use case, we are providing examples by starting services on local machine. - -The examples taken below are generic and depending on use cases, we have mentioned snippet of particular api request and response for better understanding. In this use case, consider you being user you have identifier and you want to get legal entity for same. - -### Example request call - -The request should be made first to check Catenea-X api for checking the identifier first. This request will be handled by metadata controller and will provide all available identifier type in particular enviroment with speficied business partner type and optional fields are country, pages and size. So, required field is lsaType here and can be taken considered between "LEGAL_ENTITY" and "ADDRESS". - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/identifier-types?page=0&size=100&lsaType=LEGAL_ENTITY' -``` - -Response: - -```bash -{ - "totalElements": 26, - "totalPages": 1, - "page": 0, - "contentSize": 26, - "content": [ - { - "technicalKey": "EU_VAT_ID_DE", - "lsaType": "LEGAL_ENTITY", - "name": "Value added tax identification number", - "details": [ - { - "country": "DE", - "mandatory": true - } - ] - }, - { - "technicalKey": "EU_VAT_ID_FR", - "lsaType": "LEGAL_ENTITY", - "name": "Value added tax identification number", - "details": [ - { - "country": "FR", - "mandatory": false - } - ] - }, - { - "technicalKey": "EU_VAT_ID_AT", - "lsaType": "LEGAL_ENTITY", - "name": "Value added tax identification number", - "details": [ - { - "country": "AT", - "mandatory": false - } - ] - }, - { - "technicalKey": "EU_VAT_ID_BE", - "lsaType": "LEGAL_ENTITY", - "name": "Value added tax identification number", - "details": [ - { - "country": "BE", - "mandatory": false - } - ] - }, - { - "technicalKey": "EU_VAT_ID_CH", - "lsaType": "LEGAL_ENTITY", - "name": "Value added tax identification number", - "details": [ - { - "country": "CH", - "mandatory": false - } - ] - }, - { - "technicalKey": "EU_VAT_ID_CZ", - "lsaType": "LEGAL_ENTITY", - "name": "Value added tax identification number", - "details": [ - { - "country": "CZ", - "mandatory": false - } - ] - }, - { - "technicalKey": "EU_VAT_ID_DK", - "lsaType": "LEGAL_ENTITY", - "name": "Value added tax identification number", - "details": [ - { - "country": "DK", - "mandatory": false - } - ] - }, - { - "technicalKey": "EU_VAT_ID_ES", - "lsaType": "LEGAL_ENTITY", - "name": "Value added tax identification number", - "details": [ - { - "country": "ES", - "mandatory": false - } - ] - }, - { - "technicalKey": "EU_VAT_ID_GB", - "lsaType": "LEGAL_ENTITY", - "name": "Value added tax identification number", - "details": [ - { - "country": "GB", - "mandatory": false - } - ] - }, - { - "technicalKey": "EU_VAT_ID_NO", - "lsaType": "LEGAL_ENTITY", - "name": "Value added tax identification number", - "details": [ - { - "country": "NO", - "mandatory": false - } - ] - }, - { - "technicalKey": "EU_VAT_ID_PL", - "lsaType": "LEGAL_ENTITY", - "name": "Value added tax identification number", - "details": [ - { - "country": "PL", - "mandatory": false - } - ] - }, - { - "technicalKey": "GS1_GLN", - "lsaType": "LEGAL_ENTITY", - "name": "Global Location Number", - "details": [ - { - "country": null, - "mandatory": false - } - ] - }, - { - "technicalKey": "LEI_ID", - "lsaType": "LEGAL_ENTITY", - "name": "Legal Entity Identifier", - "details": [ - { - "country": null, - "mandatory": false - } - ] - }, - { - "technicalKey": "DUNS_ID", - "lsaType": "LEGAL_ENTITY", - "name": "Data Universal Numbering System", - "details": [ - { - "country": null, - "mandatory": false - } - ] - }, - { - "technicalKey": "DE_BNUM", - "lsaType": "LEGAL_ENTITY", - "name": "Handelsregister (HRB)", - "details": [ - { - "country": "DE", - "mandatory": false - } - ] - }, - { - "technicalKey": "FR_SIREN", - "lsaType": "LEGAL_ENTITY", - "name": "Siren/Siret", - "details": [ - { - "country": "FR", - "mandatory": true - } - ] - }, - { - "technicalKey": "BR_ID_AT", - "lsaType": "LEGAL_ENTITY", - "name": "Firmenbuchnummer", - "details": [ - { - "country": "AT", - "mandatory": true - } - ] - }, - { - "technicalKey": "BE_ENT_NO", - "lsaType": "LEGAL_ENTITY", - "name": "Organisation number", - "details": [ - { - "country": "BE", - "mandatory": true - } - ] - }, - { - "technicalKey": "CH_UID", - "lsaType": "LEGAL_ENTITY", - "name": "Company Identification Number CH", - "details": [ - { - "country": "CH", - "mandatory": true - } - ] - }, - { - "technicalKey": "CZ_ICO", - "lsaType": "LEGAL_ENTITY", - "name": "Company Identification Number CZ", - "details": [ - { - "country": "CZ", - "mandatory": true - } - ] - }, - { - "technicalKey": "CVR_DK", - "lsaType": "LEGAL_ENTITY", - "name": "Business Registration Number DK", - "details": [ - { - "country": "DK", - "mandatory": true - } - ] - }, - { - "technicalKey": "CIF_ES", - "lsaType": "LEGAL_ENTITY", - "name": "Certificado de Identificación Fiscal", - "details": [ - { - "country": "ES", - "mandatory": true - } - ] - }, - { - "technicalKey": "ID_CRN", - "lsaType": "LEGAL_ENTITY", - "name": "Company Registration Number", - "details": [ - { - "country": "GB", - "mandatory": true - } - ] - }, - { - "technicalKey": "NO_ORGID", - "lsaType": "LEGAL_ENTITY", - "name": "Organization Number", - "details": [ - { - "country": "NO", - "mandatory": true - } - ] - }, - { - "technicalKey": "PL_REG", - "lsaType": "LEGAL_ENTITY", - "name": "REGON", - "details": [ - { - "country": "PL", - "mandatory": true - } - ] - }, - { - "technicalKey": "CUSTOM_ID_TYPE", - "lsaType": "LEGAL_ENTITY", - "name": "Custom Identifier Type for Testing", - "details": [ - { - "country": "DE", - "mandatory": true - } - ] - } - ] -} -``` - -The response here showing technical key for identifier type with it's name. For better understanding of this use case, we are considering identifier type i.e. CUSTOM_ID_TYPE for future examples. - -Now as per the above response, you can check your desired technical identifier which is nothing but kind of VAT number for particular legal entity. Request to the Catena-X API for legal entities with a filter on legal entity identifier i.e. 123456789 and with idType as CUSTOM_ID_TYPE. The response you received is a JSON object that contains information about the legal entity that match your query. - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/legal-entities/123456789?idType=CUSTOM_ID_TYPE' -``` - -### 2.1 Direct response - -Scenario: The user enters a valid identifier number woth idType CUSTOM_ID_TYPE and the API returns information about only one legal entity. - -Flow: - -- The user inputs a valid identification number i.e. 123456789 and idType as CUSTOM_ID_TYPE to api request. -- The Legal Entity Controller displays the information about the legal entity as a response to the request. -- Once you have legal enity shown then direct response you can get using idType as BPN value as shown in below request and response. - -Response: - -```bash -{ - "legalName": "Name of Company", - "bpnl": "BPNL000000000001", - "identifiers": [ - { - "value": "123456789", - "type": { - "technicalKey": "CUSTOM_ID_TYPE", - "name": "Custom Identifier Type for Testing" - }, - "issuingBody": "CUSTOM_ISSUE_BODY" - } - ], - "legalShortName": "NoC", - "legalForm": { - "technicalKey": "CUSTOM_LEGAL_FORM", - "name": "Custom Legal Form for Testing", - "abbreviation": null - }, - "states": [ - { - "officialDenotation": "Active", - "validFrom": "2020-12-16T05:54:48.942", - "validTo": "2023-06-05T07:31:01.213", - "type": { - "technicalKey": "ACTIVE", - "name": "Active" - } - } - ], - "classifications": [ - { - "value": "Farming of cattle, dairy farming", - "code": "01.21", - "type": { - "technicalKey": "NACE", - "name": "NACE" - } - } - ], - "relations": [], - "currentness": "2023-06-13T03:28:17.032022Z", - "createdAt": "2023-06-06T07:39:09.049097Z", - "updatedAt": "2023-06-13T03:28:17.034408Z", - "legalAddress": { - "bpna": "BPNA000000000001", - "name": "WESTERN_LATIN_STANDARD", - "states": [ - { - "description": "WESTERN_LATIN_STANDARD", - "validFrom": "2020-12-16T05:54:48.942", - "validTo": "2023-06-05T07:31:01.213", - "type": { - "technicalKey": "ACTIVE", - "name": "Active" - } - } - ], - "identifiers": [ - { - "value": "12345678910", - "type": { - "technicalKey": "CUSTOM_ID_ADD_TYPE", - "name": "Custom Identifier Type of Address for Testing" - } - } - ], - "physicalPostalAddress": { - "geographicCoordinates": { - "longitude": 0.0, - "latitude": 0.0, - "altitude": 0.0 - }, - "country": { - "technicalKey": "DE", - "name": "Germany" - }, - "postalCode": "70546", - "city": "Stuttgart", - "street": { - "name": "Stuttgarter Strasse", - "houseNumber": "1", - "milestone": "Stuttgarter Strasse 1", - "direction": "Stuttgarter Str." - }, - "administrativeAreaLevel1": null, - "administrativeAreaLevel2": "test1", - "administrativeAreaLevel3": "test2", - "district": "Stuttgart", - "companyPostalCode": "GM01", - "industrialZone": "HEADQUARTER", - "building": "Building A", - "floor": "A", - "door": "test" - }, - "alternativePostalAddress": { - "geographicCoordinates": { - "longitude": 0.0, - "latitude": 0.0, - "altitude": 0.0 - }, - "country": { - "technicalKey": "DE", - "name": "Germany" - }, - "postalCode": "1234", - "city": "Stuttgart 1", - "administrativeAreaLevel1": null, - "deliveryServiceNumber": "1234", - "type": "PO_BOX", - "deliveryServiceQualifier": "" - }, - "bpnLegalEntity": "BPNL000000000001", - "isLegalAddress": true, - "bpnSite": null, - "isMainAddress": false, - "createdAt": "2023-06-06T07:39:09.032826Z", - "updatedAt": "2023-06-06T07:39:09.057668Z" - } -} -``` - -- If user putted wrong identifier number like below which is not available in DB then response will be as below. - -Bad request: - -```bash -curl --location 'http://localhost:8080/api/catena/legal-entities/name?idType=CUSTOM_ID_TYPE' -``` - -Response: - -```bash -{ - "timestamp": "2023-05-08T12:54:07.606+00:00", - "status": 404, - "error": "Not Found", - "path": "/api/catena/legal-entities/name" -} -``` - -### 2.2 Match Response - -Scenario: To get matched response, you can use multiple key and value pair. Multiple attributes like legalName, legalForm, classification etc can be used with desired known values for them. - -#### 2.2.1 Trade Scoring with Score -> take highest ranking - -Flow: - -- The user inputs a valid name key as Name of Company to the legal entity api request. -- The Legal Entity Controller provides response with multple legal entities. -- The Legal Entity Controller uses trade scoring to determine the highest ranking legal entity. -- The legal entity that matches values getting more score ranking. -- The Legal Entity Controller displays the information about the highest ranking legal entity to the user as response. -- Those legal entities having more scroe will take precedence like BPNL000000000001 got higher precedence with score 11.198933. - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/legal-entities?legalName=Name%20of%20Company&page=0&size=10' -``` - -Response: - -```bash -{ - "totalElements": 1, - "totalPages": 1, - "page": 0, - "contentSize": 1, - "content": [ - { - "score": 7.0275493, - "legalName": "Name of Company", - "bpnl": "BPNL000000000001", - "identifiers": [ - { - "value": "123456789", - "type": { - "technicalKey": "CUSTOM_ID_TYPE", - "name": "Custom Identifier Type for Testing" - }, - "issuingBody": "CUSTOM_ISSUE_BODY" - } - ], - "legalShortName": "NoC", - "legalForm": { - "technicalKey": "CUSTOM_LEGAL_FORM", - "name": "Custom Legal Form for Testing", - "abbreviation": null - }, - "states": [ - { - "officialDenotation": "Active", - "validFrom": "2020-12-16T05:54:48.942", - "validTo": "2023-06-05T07:31:01.213", - "type": { - "technicalKey": "ACTIVE", - "name": "Active" - } - } - ], - "classifications": [ - { - "value": "Farming of cattle, dairy farming", - "code": "01.21", - "type": { - "technicalKey": "NACE", - "name": "NACE" - } - } - ], - "relations": [], - "currentness": "2023-06-13T03:28:17.032022Z", - "createdAt": "2023-06-06T07:39:09.049097Z", - "updatedAt": "2023-06-13T03:28:17.034408Z", - "legalAddress": { - "bpna": "BPNA000000000001", - "name": "WESTERN_LATIN_STANDARD", - "states": [ - { - "description": "WESTERN_LATIN_STANDARD", - "validFrom": "2020-12-16T05:54:48.942", - "validTo": "2023-06-05T07:31:01.213", - "type": { - "technicalKey": "ACTIVE", - "name": "Active" - } - } - ], - "identifiers": [ - { - "value": "12345678910", - "type": { - "technicalKey": "CUSTOM_ID_ADD_TYPE", - "name": "Custom Identifier Type of Address for Testing" - } - } - ], - "physicalPostalAddress": { - "geographicCoordinates": { - "longitude": 0.0, - "latitude": 0.0, - "altitude": 0.0 - }, - "country": { - "technicalKey": "DE", - "name": "Germany" - }, - "postalCode": "70546", - "city": "Stuttgart", - "street": { - "name": "Stuttgarter Strasse", - "houseNumber": "1", - "milestone": "Stuttgarter Strasse 1", - "direction": "Stuttgarter Str." - }, - "administrativeAreaLevel1": null, - "administrativeAreaLevel2": "test1", - "administrativeAreaLevel3": "test2", - "district": "Stuttgart", - "companyPostalCode": "GM01", - "industrialZone": "HEADQUARTER", - "building": "Building A", - "floor": "A", - "door": "test" - }, - "alternativePostalAddress": { - "geographicCoordinates": { - "longitude": 0.0, - "latitude": 0.0, - "altitude": 0.0 - }, - "country": { - "technicalKey": "DE", - "name": "Germany" - }, - "postalCode": "1234", - "city": "Stuttgart 1", - "administrativeAreaLevel1": null, - "deliveryServiceNumber": "1234", - "type": "PO_BOX", - "deliveryServiceQualifier": "" - }, - "bpnLegalEntity": "BPNL000000000001", - "isLegalAddress": true, - "bpnSite": null, - "isMainAddress": false, - "createdAt": "2023-06-06T07:39:09.032826Z", - "updatedAt": "2023-06-06T07:39:09.057668Z" - } - } - ] -} -``` - -#### 2.2.2 All scores are Equal or 0.0 -> no automatic match possible - -Flow: - -- The user inputs a valid key and vale to the legal entity api request. -- Consider use has enter key - legalForm and value - Custom Legal Form for Testing under api request shown below while quering. -- The Legal Entity Controlle API returns information about multiple legal entities. -- The Legal Entity Controller determines that all both two legal entities matching same filter. -- The Legal Entity Controller displays the information about both legal entities in response as shown in below. -- Here both legal entities i.e. BPNL000000000001 and BPNL0000000001YN are having same score which is 11.198933. -- Consider if user haven't applied any filter for attribute for this GET reuest then all legal enities will return as response and their score will be 0.0 - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/legal-entities?legalForm=company&page=0&size=10' -``` - -Response: - -```bash -{ - "totalElements": 2, - "totalPages": 1, - "page": 0, - "contentSize": 2, - "content": [ - { - "score": 0.0, - "legalName": "", - "bpnl": "BPNL0000000001YN", - "identifiers": [], - "legalShortName": "NoC", - "legalForm": { - "technicalKey": "CUSTOM_LEGAL_FORM", - "name": "Custom Legal Form for Testing", - "abbreviation": null - }, - "states": [ - { - "officialDenotation": "Active", - "validFrom": "2020-12-16T05:54:48.942", - "validTo": "2023-06-05T07:31:01.213", - "type": { - "technicalKey": "ACTIVE", - "name": "Active" - } - } - ], - "classifications": [ - { - "value": "Farming of cattle, dairy farming", - "code": "01.21", - "type": { - "technicalKey": "NACE", - "name": "NACE" - } - } - ], - "relations": [], - "currentness": "2023-06-12T05:34:47.676190Z", - "createdAt": "2023-06-12T05:34:47.705949Z", - "updatedAt": "2023-06-12T05:34:47.705957Z", - "legalAddress": { - "bpna": "BPNA0000000004WK", - "name": "WESTERN_LATIN_STANDARD", - "states": [ - { - "description": "WESTERN_LATIN_STANDARD", - "validFrom": "2020-12-16T05:54:48.942", - "validTo": "2023-06-05T07:31:01.213", - "type": { - "technicalKey": "ACTIVE", - "name": "Active" - } - } - ], - "identifiers": [], - "physicalPostalAddress": { - "geographicCoordinates": { - "longitude": 0.0, - "latitude": 0.0, - "altitude": 0.0 - }, - "country": { - "technicalKey": "DE", - "name": "Germany" - }, - "postalCode": "70546", - "city": "Stuttgart", - "street": { - "name": "Stuttgarter Strasse", - "houseNumber": "1", - "milestone": "Stuttgarter Strasse 1", - "direction": "Stuttgarter Str." - }, - "administrativeAreaLevel1": null, - "administrativeAreaLevel2": "test1", - "administrativeAreaLevel3": "test2", - "district": "Stuttgart", - "companyPostalCode": "GM01", - "industrialZone": "HEADQUARTER", - "building": "Building A", - "floor": "A", - "door": "test" - }, - "alternativePostalAddress": { - "geographicCoordinates": { - "longitude": 0.0, - "latitude": 0.0, - "altitude": 0.0 - }, - "country": { - "technicalKey": "DE", - "name": "Germany" - }, - "postalCode": "1234", - "city": "Stuttgart 1", - "administrativeAreaLevel1": null, - "deliveryServiceNumber": "1234", - "type": "PO_BOX", - "deliveryServiceQualifier": "" - }, - "bpnLegalEntity": "BPNL0000000001YN", - "isLegalAddress": true, - "bpnSite": null, - "isMainAddress": false, - "createdAt": "2023-06-12T05:34:47.698490Z", - "updatedAt": "2023-06-12T05:34:47.714935Z" - } - }, - { - "score": 0.0, - "legalName": "Name of Company1", - "bpnl": "BPNL0000000002XY", - "identifiers": [ - { - "value": "12345678910", - "type": { - "technicalKey": "CUSTOM_ID_TYPE", - "name": "Custom Identifier Type for Testing" - }, - "issuingBody": "CUSTOM_ISSUE_BODY" - } - ], - "legalShortName": "NoC", - "legalForm": { - "technicalKey": "CUSTOM_LEGAL_FORM_test1", - "name": "Custom Legal Form for Testing 1", - "abbreviation": null - }, - "states": [ - { - "officialDenotation": "Active", - "validFrom": "2020-12-16T05:54:48.942", - "validTo": "2023-06-05T07:31:01.213", - "type": { - "technicalKey": "ACTIVE", - "name": "Active" - } - } - ], - "classifications": [ - { - "value": "Farming of cattle, dairy farming", - "code": "01.21", - "type": { - "technicalKey": "NACE", - "name": "NACE" - } - } - ], - "relations": [], - "currentness": "2023-06-16T09:08:22.222993Z", - "createdAt": "2023-06-16T09:08:22.244296Z", - "updatedAt": "2023-06-16T09:08:22.244300Z", - "legalAddress": { - "bpna": "BPNA0000000007UH", - "name": "WESTERN_LATIN_STANDARD", - "states": [ - { - "description": "WESTERN_LATIN_STANDARD", - "validFrom": "2020-12-16T05:54:48.942", - "validTo": "2023-06-05T07:31:01.213", - "type": { - "technicalKey": "ACTIVE", - "name": "Active" - } - } - ], - "identifiers": [ - { - "value": "12345678910", - "type": { - "technicalKey": "CUSTOM_ID_ADD_TYPE", - "name": "Custom Identifier Type of Address for Testing" - } - } - ], - "physicalPostalAddress": { - "geographicCoordinates": { - "longitude": 0.0, - "latitude": 0.0, - "altitude": 0.0 - }, - "country": { - "technicalKey": "DE", - "name": "Germany" - }, - "postalCode": "70546", - "city": "Stuttgart", - "street": { - "name": "Stuttgarter Strasse", - "houseNumber": "1", - "milestone": "Stuttgarter Strasse 1", - "direction": "Stuttgarter Str." - }, - "administrativeAreaLevel1": null, - "administrativeAreaLevel2": "test1", - "administrativeAreaLevel3": "test2", - "district": "Stuttgart", - "companyPostalCode": "GM01", - "industrialZone": "HEADQUARTER", - "building": "Building A", - "floor": "A", - "door": "test" - }, - "alternativePostalAddress": { - "geographicCoordinates": { - "longitude": 0.0, - "latitude": 0.0, - "altitude": 0.0 - }, - "country": { - "technicalKey": "DE", - "name": "Germany" - }, - "postalCode": "1234", - "city": "Stuttgart 1", - "administrativeAreaLevel1": null, - "deliveryServiceNumber": "1234", - "type": "PO_BOX", - "deliveryServiceQualifier": "" - }, - "bpnLegalEntity": "BPNL0000000002XY", - "isLegalAddress": true, - "bpnSite": null, - "isMainAddress": false, - "createdAt": "2023-06-16T09:08:22.239413Z", - "updatedAt": "2023-06-16T09:08:22.248790Z" - } - } - ] -} -``` - -The response contains a few key fields that you can use to understand the information returned. - -- `totalElements` tells you the total number of legal entities that match your query. In this case, there are 10,978. -- `totalPages` tells you the total number of pages of legal entities. Since contentSize is set to 10, there are 1,098 pages in total.page tells you which page you are currently on. In this case, you are on the first page (page 0). -- `contentSize` tells you how many legal entities are included in the current page of results. In this case, there are 10 legal entities returned in the response. -- `content` is an array of legal entities that match your query. Each legal entity contains information about its identifiers, names, legal form, types, bank accounts, roles, and relations. - -### 2.3 Search particular legal entity - -Scenario: The user enters a valid BPN under request body and API returns information about legal entities in response. - -Flow: - -- The user inputs string in request body for api POST request call. -- If user entered value is correct i.e. if provided BPN is correct. Example in this request body provided "BPNL000000000001". -- Then Legal Entity Controller provide search result with one legal entity details. -- The Legal Entity Controller reads the BPNL (Business Partner Number List) from the API request and displays response as below. - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/legal-entities/search' \ ---header 'Content-Type: application/json' \ ---data '[ - "BPNL000000000001" -]' -``` - -Response: - -```bash -[ - { - "legalName": "Name of Company", - "bpnl": "BPNL000000000001", - "identifiers": [ - { - "value": "123456789", - "type": { - "technicalKey": "CUSTOM_ID_TYPE", - "name": "Custom Identifier Type for Testing" - }, - "issuingBody": "CUSTOM_ISSUE_BODY" - } - ], - "legalShortName": "NoC", - "legalForm": { - "technicalKey": "CUSTOM_LEGAL_FORM", - "name": "Custom Legal Form for Testing", - "abbreviation": null - }, - "states": [ - { - "officialDenotation": "Active", - "validFrom": "2020-12-16T05:54:48.942", - "validTo": "2023-06-05T07:31:01.213", - "type": { - "technicalKey": "ACTIVE", - "name": "Active" - } - } - ], - "classifications": [ - { - "value": "Farming of cattle, dairy farming", - "code": "01.21", - "type": { - "technicalKey": "NACE", - "name": "NACE" - } - } - ], - "relations": [], - "currentness": "2023-06-13T03:28:17.032022Z", - "createdAt": "2023-06-06T07:39:09.049097Z", - "updatedAt": "2023-06-13T03:28:17.034408Z", - "legalAddress": { - "bpna": "BPNA000000000001", - "name": "WESTERN_LATIN_STANDARD", - "states": [ - { - "description": "WESTERN_LATIN_STANDARD", - "validFrom": "2020-12-16T05:54:48.942", - "validTo": "2023-06-05T07:31:01.213", - "type": { - "technicalKey": "ACTIVE", - "name": "Active" - } - } - ], - "identifiers": [ - { - "value": "12345678910", - "type": { - "technicalKey": "CUSTOM_ID_ADD_TYPE", - "name": "Custom Identifier Type of Address for Testing" - } - } - ], - "physicalPostalAddress": { - "geographicCoordinates": { - "longitude": 0.0, - "latitude": 0.0, - "altitude": 0.0 - }, - "country": { - "technicalKey": "DE", - "name": "Germany" - }, - "postalCode": "70546", - "city": "Stuttgart", - "street": { - "name": "Stuttgarter Strasse", - "houseNumber": "1", - "milestone": "Stuttgarter Strasse 1", - "direction": "Stuttgarter Str." - }, - "administrativeAreaLevel1": null, - "administrativeAreaLevel2": "test1", - "administrativeAreaLevel3": "test2", - "district": "Stuttgart", - "companyPostalCode": "GM01", - "industrialZone": "HEADQUARTER", - "building": "Building A", - "floor": "A", - "door": "test" - }, - "alternativePostalAddress": { - "geographicCoordinates": { - "longitude": 0.0, - "latitude": 0.0, - "altitude": 0.0 - }, - "country": { - "technicalKey": "DE", - "name": "Germany" - }, - "postalCode": "1234", - "city": "Stuttgart 1", - "administrativeAreaLevel1": null, - "deliveryServiceNumber": "1234", - "type": "PO_BOX", - "deliveryServiceQualifier": "" - }, - "bpnLegalEntity": "BPNL000000000001", - "isLegalAddress": true, - "bpnSite": null, - "isMainAddress": false, - "createdAt": "2023-06-06T07:39:09.032826Z", - "updatedAt": "2023-06-06T07:39:09.057668Z" - } - } -] -``` - -### 2.4 Fetch sites for legal entity - -Scenario: The user enters a valid BPNL under pathparam and the API returns information about site legal entities. - -Flow: - -- The user inputs a valid BPNL in pathparam as shown in below GET api request. -- The Legal Entity Controller information about the legal entity sites as shown in response. -- The BPN in response are nothing but BPNS along with name of the site. -- The Legal Entity Controller provide details array of BPNS and name if more than one site is present. - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/legal-entities/BPNL000000000001/sites?page=0&size=10' -``` - -Response: - -```bash -{ - "totalElements": 4, - "totalPages": 1, - "page": 0, - "contentSize": 4, - "content": [ - { - "bpns": "BPNS000000000001", - "name": "Factory UT", - "states": [ - { - "description": "Baden-Wuerttemberg", - "validFrom": "2023-06-06T08:18:05.777", - "validTo": "2024-06-06T08:18:05.777", - "type": { - "technicalKey": "ACTIVE", - "name": "Active" - } - } - ], - "bpnLegalEntity": "BPNL000000000001", - "createdAt": "2023-06-06T09:50:52.720153Z", - "updatedAt": "2023-06-06T09:50:52.720155Z" - }, - { - "bpns": "BPNS0000000001YN", - "name": "Factory UT", - "states": [ - { - "description": "Baden-Wuerttemberg", - "validFrom": "2023-06-06T08:18:05.777", - "validTo": "2024-06-06T08:18:05.777", - "type": { - "technicalKey": "ACTIVE", - "name": "Active" - } - } - ], - "bpnLegalEntity": "BPNL000000000001", - "createdAt": "2023-06-06T10:00:19.733854Z", - "updatedAt": "2023-06-06T10:00:19.733858Z" - }, - { - "bpns": "BPNS0000000002XY", - "name": "Factory UT", - "states": [ - { - "description": "Baden-Wuerttemberg", - "validFrom": "2023-06-06T08:18:05.777", - "validTo": "2024-06-06T08:18:05.777", - "type": { - "technicalKey": "ACTIVE", - "name": "Active" - } - } - ], - "bpnLegalEntity": "BPNL000000000001", - "createdAt": "2023-06-13T03:24:29.981397Z", - "updatedAt": "2023-06-13T03:24:29.981400Z" - }, - { - "bpns": "BPNS0000000003X9", - "name": "Factory UT", - "states": [ - { - "description": "Baden-Wuerttemberg", - "validFrom": "2023-06-06T08:18:05.777", - "validTo": "2024-06-06T08:18:05.777", - "type": { - "technicalKey": "ACTIVE", - "name": "Active" - } - } - ], - "bpnLegalEntity": "BPNL000000000001", - "createdAt": "2023-06-13T06:01:09.734035Z", - "updatedAt": "2023-06-13T06:01:09.734039Z" - } - ] -} -``` - -### 2.5 Fetch addresses for legal entity - -Scenario: The user enters a valid BPNL under pathparam and the API returns information about address partners legal entities. - -Flow: - -- The user inputs a valid BPNL in pathparam as shown in below GET api request. -- The Legal Entity Controller information about the legal entity address as shown in response. -- The BPN in response are nothing but BPNA along with number of other fields like version, careOf, contexts, country etc. -- The Legal Entity Controller provide details array of BPNA. - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/legal-entities/BPNL000000000001/addresses?page=0&size=10' -``` - -Response: - -```bash -{ - "totalElements": 2, - "totalPages": 1, - "page": 0, - "contentSize": 2, - "content": [ - { - "bpna": "BPNA000000000001", - "name": "WESTERN_LATIN_STANDARD", - "states": [ - { - "description": "WESTERN_LATIN_STANDARD", - "validFrom": "2020-12-16T05:54:48.942", - "validTo": "2023-06-05T07:31:01.213", - "type": { - "technicalKey": "ACTIVE", - "name": "Active" - } - } - ], - "identifiers": [ - { - "value": "12345678910", - "type": { - "technicalKey": "CUSTOM_ID_ADD_TYPE", - "name": "Custom Identifier Type of Address for Testing" - } - } - ], - "physicalPostalAddress": { - "geographicCoordinates": { - "longitude": 0.0, - "latitude": 0.0, - "altitude": 0.0 - }, - "country": { - "technicalKey": "DE", - "name": "Germany" - }, - "postalCode": "70546", - "city": "Stuttgart", - "street": { - "name": "Stuttgarter Strasse", - "houseNumber": "1", - "milestone": "Stuttgarter Strasse 1", - "direction": "Stuttgarter Str." - }, - "administrativeAreaLevel1": null, - "administrativeAreaLevel2": "test1", - "administrativeAreaLevel3": "test2", - "district": "Stuttgart", - "companyPostalCode": "GM01", - "industrialZone": "HEADQUARTER", - "building": "Building A", - "floor": "A", - "door": "test" - }, - "alternativePostalAddress": { - "geographicCoordinates": { - "longitude": 0.0, - "latitude": 0.0, - "altitude": 0.0 - }, - "country": { - "technicalKey": "DE", - "name": "Germany" - }, - "postalCode": "1234", - "city": "Stuttgart 1", - "administrativeAreaLevel1": null, - "deliveryServiceNumber": "1234", - "type": "PO_BOX", - "deliveryServiceQualifier": "" - }, - "bpnLegalEntity": "BPNL000000000001", - "isLegalAddress": true, - "bpnSite": null, - "isMainAddress": false, - "createdAt": "2023-06-06T07:39:09.032826Z", - "updatedAt": "2023-06-06T07:39:09.057668Z" - }, - { - "bpna": "BPNA0000000003X9", - "name": "WESTERN_LATIN_STANDARD", - "states": [ - { - "description": "WESTERN_LATIN_STANDARD", - "validFrom": "2023-06-06T10:02:00.355", - "validTo": "2024-06-06T10:02:00.355", - "type": { - "technicalKey": "ACTIVE", - "name": "Active" - } - } - ], - "identifiers": [ - { - "value": "12345678910", - "type": { - "technicalKey": "CUSTOM_ID_ADD_TYPE", - "name": "Custom Identifier Type of Address for Testing" - } - } - ], - "physicalPostalAddress": { - "geographicCoordinates": { - "longitude": 0.0, - "latitude": 0.0, - "altitude": 0.0 - }, - "country": { - "technicalKey": "DE", - "name": "Germany" - }, - "postalCode": "70546", - "city": "Stuttgart", - "street": { - "name": "Stuttgarter Strasse", - "houseNumber": "1", - "milestone": "Stuttgarter Strasse 1", - "direction": "Stuttgarter Str." - }, - "administrativeAreaLevel1": null, - "administrativeAreaLevel2": null, - "administrativeAreaLevel3": null, - "district": "Stuttgart", - "companyPostalCode": "GM01", - "industrialZone": "HEADQUARTER", - "building": "Building A", - "floor": "A", - "door": null - }, - "alternativePostalAddress": { - "geographicCoordinates": { - "longitude": 0.0, - "latitude": 0.0, - "altitude": 0.0 - }, - "country": { - "technicalKey": "DE", - "name": "Germany" - }, - "postalCode": "1234", - "city": "Stuttgart", - "administrativeAreaLevel1": null, - "deliveryServiceNumber": "test", - "type": "PO_BOX", - "deliveryServiceQualifier": "" - }, - "bpnLegalEntity": "BPNL000000000001", - "isLegalAddress": false, - "bpnSite": null, - "isMainAddress": false, - "createdAt": "2023-06-06T10:20:48.376234Z", - "updatedAt": "2023-06-06T10:20:48.376264Z" - } - ] -} -``` - -## Use Case 3. Update data from Legal Entity and check changelog - -Description: This use case involves a user updating record for a legal entity business partner associated with a Business Partner Number (BPNL). Changelogs can be identified using changelog controller, it have one POST api request explained in below use case to show up the changelog details for provided BPN. - -The user can use an API call for the changelog controller, which retrieves the changelog for reuested BPNL. The business-partner-controller checks if there are any updates since the last update and fetches array of the updated data for the BPNL via the business partner controller if there are updates in provided date and time frame. The Legal Entity Controller can be use to update the legal entity. Similarly site controller and address controller can be used to update sites and address type business partners respectively. - -### 3.1 Get Changelog for BPNL via changelog-controller - -Scenario: The user enters a valid BPNL under request body and changelog controller api returns information about changelogs for legal entities or on specified lsaType and also filteration should be their to fetch changelog only after particular dates. - -Flow: - -- The user initiates a request to search for changelogs for a specific BPNL by providing BPN in api request body. -- Here in example request, user has putted two query params named as bpn with value BPNL000000000001. -- The changelog controller returns the changelog for the BPNL entered business partner type array value. -- Also user can be filter data based on date named as fromTime paramter, The changelog controller checks if there are any updates since the last update. -- If there are updates, the changelog controller fetches the updated data for the BPNL. - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/business-partners/changelog/search?page=0&size=10' \ ---header 'Content-Type: application/json' \ ---data '{ - "fromTime": "2023-03-21T09:00:25.298594Z", - "bpns": [ - "BPNL000000000001" - ], - "lsaTypes": [ - "LEGAL_ENTITY" - ] -}' -``` - -Response: - -```bash -{ - "totalElements": 3, - "totalPages": 1, - "page": 0, - "contentSize": 3, - "content": [ - { - "bpn": "BPNL000000000001", - "changelogType": "CREATE", - "timestamp": "2023-06-06T07:39:09.028951Z", - "lsaType": "LEGAL_ENTITY" - }, - { - "bpn": "BPNL000000000001", - "changelogType": "UPDATE", - "timestamp": "2023-06-06T07:41:00.498695Z", - "lsaType": "LEGAL_ENTITY" - }, - { - "bpn": "BPNL000000000001", - "changelogType": "UPDATE", - "timestamp": "2023-06-13T03:27:39.878101Z", - "lsaType": "LEGAL_ENTITY" - } - ] -} -``` - -### 3.2 Changelog for update on business partner - -Scenario: Apply the changes or update on business partner of type legal entity, site and address through api request. Check changelog for each business partner example using above api request. - -#### 3.2.1 Update Legal Entity - -Flow: - -- The user updates legal entity by hiting PUT api call as shown in request below. -- The legal entity controller updates business partner of type legal entity as per the provided request body. -- The Respone will be displayed to user with updated details for a message to the user that the legal entity data has been updated. - -Request: - -```bash -curl --location --request PUT 'http://localhost:8080/api/catena/legal-entities' \ ---header 'Content-Type: application/json' \ ---data '[ - { - "bpnl": "BPNL000000000001", - "legalName": "Name of Company", - "identifiers": [ - { - "value": "123456789", - "type": "CUSTOM_ID_TYPE", - "issuingBody": "CUSTOM_ISSUE_BODY" - } - ], - "legalShortName": "NoC", - "legalForm": "CUSTOM_LEGAL_FORM", - "states": [ - { - "officialDenotation": "Active", - "validFrom": "2020-12-16T05:54:48.942Z", - "validTo": "2023-06-05T07:31:01.213Z", - "type": "ACTIVE" - } - ], - "classifications": [ - { - "value": "Farming of cattle, dairy farming", - "code": "01.21", - "type": "NACE" - } - ], - "legalAddress": { - "name": "WESTERN_LATIN_STANDARD", - "states": [ - { - "description": "WESTERN_LATIN_STANDARD", - "validFrom": "2020-12-16T05:54:48.942Z", - "validTo": "2023-06-05T07:31:01.213Z", - "type": "ACTIVE" - } - ], - "identifiers": [ - { - "value": "12345678910", - "type": "CUSTOM_ID_ADD_TYPE" - } - ], - "physicalPostalAddress": { - "geographicCoordinates": { - "longitude": 0, - "latitude": 0, - "altitude": 0 - }, - "country": "DE", - "postalCode": "70546", - "city": "Stuttgart", - "street": { - "name": "Stuttgarter Strasse", - "houseNumber": "1", - "milestone": "Stuttgarter Strasse 1", - "direction": "Stuttgarter Str." - }, - "administrativeAreaLevel1": "Baden-Wuerttemberg", - "administrativeAreaLevel2": "test1", - "administrativeAreaLevel3": "test2", - "district": "Stuttgart", - "companyPostalCode": "GM01", - "industrialZone": "HEADQUARTER", - "building": "Building A", - "floor": "A", - "door": "test" - }, - "alternativePostalAddress": { - "geographicCoordinates": { - "longitude": 0, - "latitude": 0, - "altitude": 0 - }, - "country": "DE", - "postalCode": "1234", - "city": "Stuttgart 1", - "administrativeAreaLevel1": "Baden-Wuerttemberg 1", - "deliveryServiceNumber": "1234", - "deliveryServiceType": "PO_BOX", - "deliveryServiceQualifier": "test" - } - } - } -]' -``` - -#### 3.2.2 Update Site - -Flow: - -- The user updates site by hiting PUT api call as shown in request below. -- The site controller updates business partner of type site as per the provided request body. -- The Respone will be displayed to user with updated details for a message to the user that the site data has been updated. - -Request: - -```bash -curl --location --request PUT 'http://localhost:8080/api/catena/sites' \ ---header 'Content-Type: application/json' \ ---data '[ - { - "bpns": "BPNS000000000001", - "name": "Factory UT", - "states": [ - { - "description": "Baden-Wuerttemberg", - "validFrom": "2023-06-06T08:18:05.777Z", - "validTo": "2024-06-06T08:18:05.777Z", - "type": "ACTIVE" - } - ], - "mainAddress": { - "name": "WESTERN_LATIN_STANDARD", - "states": [ - { - "description": "Baden-Wuerttemberg", - "validFrom": "2023-06-06T08:18:05.777Z", - "validTo": "2024-06-06T08:18:05.777Z", - "type": "ACTIVE" - } - ], - "identifiers": [ - { - "value": "123456789", - "type": "CUSTOM_SITE_ID" - } - ], - "physicalPostalAddress": { - "geographicCoordinates": { - "longitude": 0, - "latitude": 0, - "altitude": 0 - }, - "country": "DE", - "postalCode": "70327", - "city": "Stuttgart", - "street": { - "name": "Untertuerckheim Strasse 1", - "houseNumber": "1234", - "milestone": "Untertuerckheim Strasse 1", - "direction": "Untertuerckheim Strasse 1" - }, - "administrativeAreaLevel1": "Baden-Wuerttember", - "district": "Stuttgart", - "companyPostalCode": "71034", - "industrialZone": "Sindelfinden", - "building": "Building A", - "floor": "A", - "door": "1" - }, - "alternativePostalAddress": { - "geographicCoordinates": { - "longitude": 0, - "latitude": 0, - "altitude": 0 - }, - "country": "DE", - "postalCode": "1234", - "city": "Stuttgart", - "administrativeAreaLevel1": "Stuttgart", - "deliveryServiceNumber": "Untertuerckheim Strasse 1", - "deliveryServiceType": "PO_BOX", - "deliveryServiceQualifier": "test qualifier" - } - } - } -]' -``` - -#### 3.2.3 Update Addresses - -Flow: - -- The user updates address by hiting PUT api call as shown in request below. -- The address controller updates business partner of type address as per the provided request body. -- The Respone will be displayed to user with updated details for a message to the user that the address data has been updated. - -Request: - -```bash -curl --location --request PUT 'http://localhost:8080/api/catena/addresses' \ ---header 'Content-Type: application/json' \ ---data '[ - { - "bpna": "BPNA000000000001", - "name": "WESTERN_LATIN_STANDARD", - "states": [ - { - "description": "WESTERN_LATIN_STANDARD", - "validFrom": "2020-12-16T05:54:48.942", - "validTo": "2023-06-05T07:31:01.213", - "type": "ACTIVE" - } - ], - "identifiers": [ - { - "value": "12345678910", - "type": "CUSTOM_ID_ADD_TYPE" - } - ], - "physicalPostalAddress": { - "geographicCoordinates": { - "longitude": 0, - "latitude": 0, - "altitude": 0 - }, - "country": "DE", - "postalCode": "70546", - "city": "Stuttgart", - "street": { - "name": "Stuttgarter Strasse", - "houseNumber": "1", - "milestone": "Stuttgarter Strasse 1", - "direction": "Stuttgarter Str." - }, - "administrativeAreaLevel1": null, - "administrativeAreaLevel2": "test1", - "administrativeAreaLevel3": "test2", - "district": "Stuttgart", - "companyPostalCode": "GM01", - "industrialZone": "HEADQUARTER", - "building": "Building A", - "floor": "A", - "door": "test" - }, - "alternativePostalAddress": { - "geographicCoordinates": { - "longitude": 0, - "latitude": 0, - "altitude": 0 - }, - "country": "DE", - "postalCode": "Stuttgart 1", - "city": "string", - "administrativeAreaLevel1": "test1", - "deliveryServiceNumber": "test2", - "deliveryServiceType": "PO_BOX", - "deliveryServiceQualifier": "test3" - } - } -]' -``` - -Below api reuqest from changelog controller checks changelog on each business partner type and in response controller provide either business partner newly created or updated along with timestamp with filter on provided timestamp. Here, we have added filter for business partner type which we can update in respective update flow same what we did in section 3.2 above. diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Success Stories/page_country-risk.md b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Success Stories/page_country-risk.md deleted file mode 100644 index 370a2a9964a..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/Success Stories/page_country-risk.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -id: Country Risk Score -title: Country Risk Score -description: 'Country Risk Score' -sidebar_position: 1 ---- - -BPDM (Business Partner Data Management) aims to deliver first class master data and provide additional information regarding the company's business partners. This enables to make the best decision at all times based on actual data. This is especially helpful in a tender situation, for compliance processes or even for regulatory requirements. - -Therefore, as part of the "Know Your Business Partner"-approach, the Country Risk Score Application has been developed. - -![Country Risk Service](@site/static/img/country-risk-dashboard-min.png) - -The service offers a score per country based on several, customizable ratings. This score indicates how the respective situation in the selected country is. Currently integrated sources are e.g. the Corruption Perception Index (CPI) giving the user an indication how corrupt the respective country is, as well as the Basel AML Index which provides the user with the information about money laundring and terrorism financing in the country. As an outlook there are a lot more publicly available as well as chargeable ratings to be implemented. As well as the granularity which can be increased for the future to take into account that large countries could have better or worse regions (e.g. China, USA, Russia). - -Prerequisite to use this product: The consumer has to be sharing member as a company is only allowed to view the business partners they have uploaded initially. - -The open source solution is developed according to the Catena-X consortia and eclipse guidelines and was security checked. The repositories can be found here: - -- [https://github.com/eclipse-tractusx/vas-country-risk-frontend](https://github.com/eclipse-tractusx/vas-country-risk-frontend) -- [https://github.com/eclipse-tractusx/vas-country-risk-backend](https://github.com/eclipse-tractusx/vas-country-risk-backend) - -There is one main interface used from the Golden Record Product which is the GATE API in order to retrieve company specific business partners to be displayed in the dashboard. [https://github.com/eclipse-tractusx/bpdm/tree/main/docs/api](https://github.com/eclipse-tractusx/bpdm/tree/main/docs/api). - -While currently the country risk service is a dashboard without the possibility to share data, in the future there shall be the functionality to request a country risk score from our application for a provided BPN Number. This functionality can then be used by other use cases like traceability or by the sharing member itself to integrate the data into their own proprietary systems. For this a separate API will be developed which will be extended by an EDC in order to take care of the access and usage policy of the data. - -Once this interface is implemented and the EDC is set up, it can be ensured that the data fields are understood according to the defined semantics and peer-to-peer connections and effort can be minimized after initial setup. Therefore several Country Risk Service Providers are theoretically able to provide their data via this standardized API. This leads to great flexibility for the consumer and very little connection effort. - -Stay tuned for more information! diff --git a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/page_adoption-view.mdx b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/page_adoption-view.mdx deleted file mode 100644 index 0196504c7c6..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/page_adoption-view.mdx +++ /dev/null @@ -1,90 +0,0 @@ ---- -id: Adoption View -title: Adoption View -description: 'Business Partner Kit' -sidebar_position: 2 ---- - -![Business partner kit banner](@site/static/img/BPKitIcon.png) - -# Business Partner KIT - -** Unique business partner data sets for the whole data space. ** -## Vision & Mission -** Basis for the integration of value-adding services in the area of business partner data management. ** - -The BusinessPartner Kit provides high-quality data records of business partners called golden record including a unique identifier and the business partner number (BPN). The BPN provides a standardized and unique identifier on legal entity, site and address level. The connected backend service removes duplicate data, adds missing information, and improves data quality from different data sources so-called sharing member. - -- **Legal Entity Level (BPN L)**: Search for a legal entity and get the high-quality data set. -- **Site Level (BPN S)**: Get the site information of a legal entity. A legal entity can have one or more sites. -- **Address Level (BPN A)**: Each legal entity and site has an address to find the company. - -**The Kit provides a homogeneous semantic with an open data model, enables the access to high quality data and provides one access point to the business partner data sets.** -
- -![BuildApps](@site/static/img/BPKITBuildApps.png) - -** 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.09/kits/Business Partner Kit/page_changelog.md b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/page_changelog.md deleted file mode 100644 index 0c3bdedf1af..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/page_changelog.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -id: Changelog -title: Changelog -description: 'Business Partner Kit' -sidebar_position: 1 ---- - -![Business partner kit banner](@site/static/img/BPKitIcon.png) - -### Business Partner KIT - -All notable changes to this Kit will be documented in this file. - -## [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.09/kits/Business Partner Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/page_software-operation-view.md deleted file mode 100644 index 0ac6c9e4411..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Business Partner Kit/page_software-operation-view.md +++ /dev/null @@ -1,428 +0,0 @@ ---- -id: Operation View -title: Operation View -description: 'Business Partner Kit' -sidebar_position: 3 ---- - -![Business partner kit banner](@site/static/img/BPKitIcon.png) - -### Business Partner KIT - -## Local Deployment - -BPDM is an acronym for business partner data management. This project provides core services for querying, adding and changing business partner base information in the Eclipse Tractus-X landscape. BPDM project is SpringBoot Kotlin software project managed by Maven and consists of three microservices. This section contains information on how to configure and run the BPDM application. - -This local deployment is an easy installation with helm. This setup is built to run on a kubernetes cluster. - -| Step | Action | Description | -|----------------------------------------------------------------------------------|-------------------------------------|-------------------------------------------------------------------------| -|![arrow down](@site/static/img/arrow_down.png)| **[Install the prerequisites](#step-1-prerequisites)**| Install all necessary tools for this setup | -|![vector](@site/static/img/vector.png) | **[Check out the Code](#step-2-check-out-the-code)** | Get all necessary code to deploy the service and dependencies to the kuberneetes cluster| -|![check](@site/static/img/check.png) | **[Installing the Service](#step-3-installing-the-services)**|Start cluster and interact with Services | - -### Step 1: Prerequisites - -1. [Docker](https://docs.docker.com/get-docker/) is installed and the Docker deamon is running with at least 8GB of memory -2. [helm](https://helm.sh/docs/intro/install/) is installed -3. [Minikube](https://minikube.sigs.k8s.io/docs/start/) is installed and running. - You can also use any other local Kubernetes cluster, this guide is just using Minikube as a reference. - - ```bash - minikube start --memory 8192 --cpus 2 - ``` - - _Optional_: enable minikube metrics - - ```bash - minikube addons enable metrics-server - ``` - -4. [kubectl](https://kubernetes.io/docs/tasks/tools/) is installed -5. [psql](https://www.compose.com/articles/postgresql-tips-installing-the-postgresql-client/) client is installed - -### Step 2: Check out the code - -Check out the project [BPDM](https://github.com/eclipse-tractusx/bpdm) or download a [released version](https://github.com/eclipse-tractusx/bpdm/releases) of the project. - -### Step 3: Installing the services - -#### 1. Start the cluster - -To deploy the services on kubernetes using helm charts, run - -```bash -cd local/bpdm -helm install your_namespace ./charts/bpdm/ -``` - -If postgresql is not available in your cluster then you might get following error. - -```bash -Error: INSTALLATION FAILED: An error occurred while checking for chart dependencies. You may need to run `helm dependency build` to fetch missing dependencies: found in Chart.yaml, but missing in charts/ directory: opensearch, postgresql -``` - -You can resolve it by adding dependancy to the build - -```bash -helm dependency build ./charts/bpdm/ -``` - -This can take up to **5 minutes**. - -When the deployment is finished you can expect that 3 deployments can be seen in the minikube dashboard: - -* bpdm-bridge-dummy -* bpdm-gate -* bpdm-pool - -Also in total 5 Pods are up and running. - -##### 1.1 Get the status of the deployment - -The minikube dashboard will give you feedback on how the status of the deployment currently is: - -```bash - minikube dashboard -``` - -Make sure you select the namespace **your_namespace**: - -![expected status](@site/static/img/minikube-bpdm-dashboard-overview.png) - -#### 2. Forward ports - -When the deployment has been finished, you can for port forwarding using k9s. Also, if k9s tool is not installed the you can use [installer](https://k9scli.io/topics/install/) - -```bash - -``` - -or port forwarding can also be achived kubernetes command - -```bash -kubectl port-forward : -``` - -After that you can access the: - -* **bpdm-bridge-dummy:** [http://localhost:8083](http://localhost:8083) -* **bpdm-gate:** [http://localhost:8081](http://localhost:8081) -* **bpdm-pool:** [http://localhost:8080](http://localhost:8080) - -## Deploy Individual Service - -### 1. BPDM Pool - -The [prerequisites](#step-1-prerequisites) for running this service. In an existing Kubernetes cluster the application can be deployed with the following command: - -```bash -helm install release_name ./charts/bpdm/bpdm-pool --namespace your_namespace -``` - -This will install a new release of the BPDM Pool in the given namespace.On default values this release deploys the latest image tagged as `main` from the repository's GitHub Container Registry. The application is run on default profile (without authorization). -Additionally, the Helm deployment contains a PostgreSQL database and Opensearch instance which the BPDM Pool connects to. - -On the default values deployment no further action is needed to make the BPDM Pool deployment run. -However, per default, ingress as well as authentication for endpoints are disabled. - -By giving your own values file you can configure the Helm deployment of the BPDM Pool freely: - -```bash -helm install release_name ./charts/bpdm/bpdm-pool --namespace your_namespace -f ./path/to/your/values.yaml -``` - -In the following sections you can have a look at the most important configuration options. - -#### Image Tag - -Per default, the Helm deployment references a certain BPDM Pool release version where the newest Helm release points to the newest Pool version. -This is a stable tag pointing to a fixed release version of the BPDM Pool. -For your deployment you might want to follow the latest application releases instead. - -In your values file you can overwrite the default tag: - -```yaml -image: - tag: "latest" -``` - -#### Profiles - -You can also activate Spring profiles in which the BPDM Pool should be run. -In case you want to run the Pool with authorization enabled you can write the following: - -```yaml -springProfiles: - - auth -``` - -#### Ingress - -You can specify your own ingress configuration for the Helm deployment to make the BPDM Pool available over Ingress. -Note that you need to have the appropriate Ingress controller installed in your cluster first. -For example, consider a Kubernetes cluster with an [Ingress-Nginx](https://kubernetes.github.io/ingress-nginx/) installed. -An Ingress configuration for the Pool deployment could look like this: - -```yaml -ingress: - enabled: true - annotations: - kubernetes.io/ingress.class: nginx - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - hosts: - - host: business-partners.your-domain.net - paths: - - path: /pool - pathType: Prefix -``` - -#### Pool Configuration - -The Helm deployment comes with the ability to configure the BPDM Pool application directly over the values file. -This way you are able to overwrite any configuration property of the `application.properties` and `application-auth.properties` files. -Consider that you would need to turn on `auth` profile first before overwriting any property in the corresponding properties file could take effect. -Overwriting configuration properties can be useful to connect to a remote service: - -```yaml -applicationConfig: - bpdm: - security: - auth-server-url: https://remote.keycloak.domain.com - realm: CUSTOM_REALM - client-id: POOL_CLIENT -``` - -In this example above a Pool with authenticated activated connects to a remote Keycloak instance and uses its custom realm and resource. - -Entries in the "applicationConfig" value are written directly to a configMap that is part of the Helm deployment. -This can be a problem if you want to overwrite configuration properties with secrets. -Therefore, you can specify secret configuration values in a different Helm value `applicationSecrets`. -Content of this value is written in a Kubernetes secret instead. -If you want to specify a custom database password for example: - -```yaml -applicationSecrets: - spring: - datasource: - password: your_database_secret -``` - -#### Helm Dependencies - -On default, the Helm deployment also contains a PostgreSQL and Opensearch deployment. -You can configure these deployments in your value file as well. -For this, consider the documentation of the correspondent dependency [PostgreSQL](https://artifacthub.io/packages/helm/bitnami/postgresql/11.9.13) -or [Opensearch](https://opensearch.org/docs/latest/dashboards/install/helm/). -In case you want to use an already deployed database or Opensearch instance you can also disable the respective dependency and overwrite the default host -address in the `applicationConfig`: - -```yaml -applicationConfig: - spring: - datasource: - url: jdbc:postgresql://remote.host.net:5432/bpdm -postgres: - enabled: false -``` - -### 2. BPDM Gate - -The [prerequisites](#step-1-prerequisites) for running this service is same except this service need running BPDM Pool instance. - -In an existing Kubernetes cluster the application can be deployed with the following command: - -```bash -helm install release_name ./charts/bpdm/bpdm-gate --namespace your_namespace -f /path/to/my_release-values.yaml -``` - -This will install a new release of the BPDM Gate in the given namespace. -On default values this release deploys the latest image tagged as `main` from the repository's GitHub Container Registry. -The application is run on default profile (without authorization for its own endpoints or BPDM Pool endpoints). -This deployment requires a BPDM Pool deployment to be reachable under host name `bpdm-pool` on port `8080`. - -By giving your own values file you can configure the Helm deployment of the BPDM Gate freely. -In the following sections you can have a look at the most important configuration options. - -#### Image Tag - -Per default, the Helm deployment references the latest BPDM gate release tagged as `main`. -This tag follows the latest version of the Gate and contains the newest features and bug fixes. -You might want to switch to a more stable release tag instead for your deployment. -In your values file you can overwrite the default tag: - -```yaml -image: - tag: "latest" -``` - -#### Profiles - -You can also activate Spring profiles in which the BPDM Gate should be run. -In case you want to run the Gate with authorization and oAuth Pool client enabled you can write the following: - -```yaml -springProfiles: - - auth - - pool-auth -``` - -#### Ingress - -You can specify your own ingress configuration for the Helm deployment to make the BPDM Gate available over Ingress. -Note that you need to have the appropriate Ingress controller installed in your cluster first. -For example, consider a Kubernetes cluster with an [Ingress-Nginx](https://kubernetes.github.io/ingress-nginx/) installed. -An Ingress configuration for the Gate deployment could look like this: - -```yaml -ingress: - enabled: true - annotations: - kubernetes.io/ingress.class: nginx - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - hosts: - - host: business-partners.your-domain.net - paths: - - path: /companies/test-company - pathType: Prefix -``` - -#### Gate Configuration - -For the default deployment you already need to overwrite the configuration properties of the application. -The Helm deployment comes with the ability to configure the BPDM Gate application directly over the values file. -This way you are able to overwrite any configuration property of the `application.properties`, `application-auth.properties` -and `application-pool-auth.properties` files. -Consider that you would need to turn on `auth` and `pool-auth` profile first before overwriting any property in the corresponding properties file could take -effect. -Overwriting configuration properties can be useful for connecting to a remotely hosted BPDM Pool instance: - -```yaml -applicationConfig: - bpdm: - pool: - base-url: http://remote.domain.net/api/catena -``` - -Entries in the "applicationConfig" value are written directly to a configMap that is part of the Helm deployment. -This can be a problem if you want to overwrite configuration properties with secrets. -Therefore, you can specify secret configuration values in a different Helm value `applicationSecrets`. -Content of this value is written in a Kubernetes secret instead. -If you want to specify a keycloak client secret for example: - -```yaml -applicationSecrets: - bpdm: - security: - credentials: - secret: your_client_secret -``` - -### 3. BPDM Bridge Dummy - -The [prerequisites](#step-1-prerequisites) for running this service is same. In an existing Kubernetes cluster the application can be deployed with the following command: - -```bash -helm install release_name ./charts/bpdm/bpdm-bridge-dummy --namespace your_namespace -f /path/to/my_release-values.yaml -``` - -This will install a new release of the BPDM Bridge Dummy in the given namespace. -On default values this release deploys the latest image tagged as `main` from the repository's GitHub Container Registry. - -By giving your own values file you can configure the Helm deployment of the BPDM Bridge Dummy freely. -In the following sections you can have a look at the most important configuration options. - -#### Image Tag - -Per default, the Helm deployment references the latest BPDM Bridge Dummy release tagged as `main`. -This tag follows the latest version of the Bridge Dummy and contains the newest features and bug fixes. -You might want to switch to a more stable release tag instead for your deployment. -In your values file you can overwrite the default tag: - -```yaml -image: - tag: "latest" -``` - -#### Profiles - -You can also activate Spring profiles in which the BPDM Bridge Dummy should be run. -In case you want to run the Bridge Dummy with authorization enabled you can write the following: - -```yaml -springProfiles: - - auth -``` - -#### Ingress - -You can specify your own ingress configuration for the Helm deployment to make the BPDM Bridge Dummy available over Ingress. -Note that you need to have the appropriate Ingress controller installed in your cluster first. -For example, consider a Kubernetes cluster with an [Ingress-Nginx](https://kubernetes.github.io/ingress-nginx/) installed. -An Ingress configuration for the Bridge Dummy deployment could somehow look like this: - -```yaml -ingress: - enabled: true - annotations: - kubernetes.io/ingress.class: nginx - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - hosts: - - host: business-partners.your-domain.net - paths: - - path: /bridge - pathType: Prefix -``` - -#### Bridge Dummy Configuration - -For the default deployment you already need to overwrite the configuration properties of the application. -The Helm deployment comes with the ability to configure the BPDM Bridge Dummy application directly over the values file. -This way you are able to overwrite any configuration property of the `application.properties` and `application-auth.properties` files. -Consider that you would need to turn on `auth` profile first before overwriting any property in the corresponding properties file could take -effect. -Overwriting configuration properties can be useful for connecting to a remotely hosted BPDM Gate and Pool instance: - -```yaml -applicationConfig: - bpdm: - pool: - base-url: http://remote.domain.net/api/catena - gate: - base-url: http://remote.domain.net/api/catena -``` - -Entries in the "applicationConfig" value are written directly to a configMap that is part of the Helm deployment. -This can be a problem if you want to overwrite configuration properties with secrets. -Therefore, you can specify secret configuration values in a different Helm value `applicationSecrets`. -Content of this value is written in a Kubernetes secret instead. -If you want to specify a keycloak client secret for example: - -```yaml -applicationSecrets: - bpdm: - security: - credentials: - secret: your_client_secret -``` - -## Stopping the cluster - -1. stop minikube - - ```bash - minikube stop - ``` - -2. stop the processes used for port forwarding and minikube dashboard -3. shut down the Docker daemon - -## How to debug an application in the cluster - -If you want to connect your IDE to one of the applications in the cluster, you need to enable debug mode for that application by overriding the entrypoint (using the `command` and `args` fields in the deployment resource). How to do this depends on the application. For the BPDM, as it is based on Spring Boot and Kotlin, you would need to add this flag to the start command: - -```bash --agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000 -``` - -Then you can forward the port 8000 for the BPDM deployment to your host machine and connect your IDE to that port. diff --git a/docs-kits_versioned_docs/version-23.09/kits/DCM Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-23.09/kits/DCM Kit/page_adoption-view.md deleted file mode 100644 index ddf79b27506..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/DCM Kit/page_adoption-view.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -id: adoption-view -title: Adoption View -description: 'A first impression' -sidebar_position: 2 ---- - -![DCM kit banner](@site/static/img/DCMKitLogoIcon-min.png) - -## Vision & Mission - -The Catena-X-Standards for Demand- and Capacity-Management enable participants of the automotive supply chain to become more resilient and to increase the degree of collaboration aimed at avoiding or solving production bottlenecks as well as surplus situations in a tactical horizon of 1-2 years. - -Thereby the standards empower participants to share data in a secure and sovereign way while ensuring the interoperability of the different applications involved in the process. - -## Status Quo - -**Today's challenge for automotive companies** - -Resilience has become imperative within Supply Chain Management, especially over the past years. With the growing complexity of supply chains and a rising number of global and local crises, small and medium enterprises (SMEs) as well as large enterprises (LEs) are facing an increased risk of serious disruptions in their supply chains, bullwhip effects and in the worst case even temporary production shutdowns with a high effort and costs of replanning. - -Inside the volatile and highly complex surroundings of the automotive industry nowadays, mostly tailor-made, proprietary and often fully manual IT solutions support the demand and capacity management processes along the value chain. On the one side there is no common understanding of these processes among the participants. On the other side, different data formats as well as application programming interfaces are used, which is increasing the complexity in the data exchange and which is leading to transfer problems, inconsistencies, or even loss of data. - -## Business Value - -**Why DCM KIT?** - -The purpose and focus of Demand and Capacity Management (DCM) KIT is twofold: -- Define a common understanding of the DCM process thus paving the way for more proactive and efficient collaboration. -- Establish process and application interoperability with the help of common semantics and unified interfaces for data exchange while ensuring the data sovereignty of data providers. - -Implementing the DCM standards will add the following core capabilities to business applications: -- Provisioning and consumption of material demands data in a sovereign manner. -- Provisioning and consumption of capacity data in a sovereign manner. -- Discovery of bottlenecks and surplus capacity situations by employing a unified calculation logic. - -## Standards - -The DCM standard comprises three main elements: -- **Core Business logic** – to focus on a **common understanding** of the **DCM processes** among the participants. **Version 1.0.0** (Release 3.1) [CX-0046 DCM Process & Core Business Logic](https://catena-x.net/de/standard-library) -- **Data model** – to align the structure of the shared data and enable the adoption of the core business logic without misinterpretation. **Version 1.0.0** (Release 3.1) [CX-0047 DCM Data Model Material Demand & Capacity Group](https://catena-x.net/de/standard-library) -- **APIs** – to make sure that data are transmitted and consumed properly as well as are identically interpreted across companies. **Version 1.0.0** (Release 3.1) [CX-0048 DCM API Material Demand & Capacity Group](https://catena-x.net/de/standard-library) - -**POWER of STANDARD** - -Standards create trust. Customer and Supplier can form new partnerships confidently. Knowing that integration in the network will be dramatically simplified. Standardization can help reduce costs by eliminating redundancies and streamlining processes. By adopting a common set of practices and technologies, businesses can avoid the need to develop their own proprietary systems, which can be expensive and time-consuming. - -**DATA SOVEREIGNTY in FOCUS** - -DCM KIT keeps up with Catena X commitment to data sovereignty. This KIT has the goal to always comply with the data sovereignty principle implemented by the Eclipse Dataspace Connector. That enables all participants in the supply chain to always stay in full control of their own data. - -This is how sharing data is fun. - -**INTEROPERABILITY at its BEST** - -Application and Service Provider can reduce investments to integrate DCM data models/API specification from DCM KIT. - -The Kit enables the offering of value-add services and innovation based on process description of the core business logic and how a collaborative approach is a win-win-situation for customer and supplier. - -**COLLABORATION is KEY** - -The DCM KIT enables better and faster issue resolution. We believe that collaboration is the key to creating and maintaining strong partnerships between customers and suppliers and, at the same time, enhancing problem solving to reach a more balanced and efficient supply and demand management. - -Of course, by realizing efficiency through improved collaboration all involved partners will gain competitive advantage over those that do not collaborate. - -## Semantic Models - -| Semantic Model | Link to GitHub Repository | -| ------------- | ------------- | -| WeekBasedCapacityGroup | https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.week_based_capacity_group | -| WeekBasedMaterialDemand | https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.week_based_material_demand | - -## 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 Mercedes Benz Group -- SPDX-FileCopyrightText: 2023,2023 BASF SE -- SPDX-FileCopyrightText: 2023,2023 SupplyOn AG -- SPDX-FileCopyrightText: 2023,2023 Henkel AG & Co.KGaA -- SPDX-FileCopyrightText: 2023,2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse diff --git a/docs-kits_versioned_docs/version-23.09/kits/DCM Kit/page_changelog.md b/docs-kits_versioned_docs/version-23.09/kits/DCM Kit/page_changelog.md deleted file mode 100644 index 0aed244c836..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/DCM Kit/page_changelog.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: changelog -title: Changelog -description: 'What has changed recently?' -sidebar_position: 1 ---- - -![DCM kit banner](@site/static/img/DCMKitLogoIcon-min.png) - -# DCM KIT - -All notable changes to this Kit will be documented in this file. - -## [0.1.0] - 2023-03-01 - -### Added -- Adoption View -- Development View - -### Changed -n/a - -### Removed -n/a \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/DCM Kit/page_development-view.md b/docs-kits_versioned_docs/version-23.09/kits/DCM Kit/page_development-view.md deleted file mode 100644 index f1eb941de40..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/DCM Kit/page_development-view.md +++ /dev/null @@ -1,534 +0,0 @@ ---- -id: development-view -title: Development View -description: 'What do I have to implement?' -sidebar_position: 3 ---- - -![DCM kit banner](@site/static/img/DCMKitLogoIcon-min.png) - -## DCM Development View - -This page describes the most important parts for the software implementation of the DCM standards. For the full technical specification, please refer to the standards [CX-0047 DCM Data Model Material Demand & Capacity Group](https://catena-x.net/de/standard-library) and [CX-0048 DCM API Material Demand & Capacity Group](https://catena-x.net/de/standard-library). - -## Introduction - -This document describes the `WeekBasedMaterialDemand` and `WeekBasedCapacityGroup` semantic models and the -API definitions used in the DCM Catena-X network. - -The `WeekBasedMaterialDemand` object will be send by customers to their suppliers in order to -communicate how many parts they need in which period of time. The customers of materials therefore -need to be able to create `WeekBasedMaterialDemand` objects and the suppliers need to be able to -interpret them. As most suppliers have their own suppliers, who produce materials for them, most -suppliers are therefore acting as customers as well and need to be able to also create -`WeekBasedMaterialDemand` objects on for sending them to their suppliers. - -The `WeekBasedCapacityGroup` object is sent by the suppliers to their customers to communicate which -materials are bundled together, representing a common bottleneck. And what the capacity for these -materials is, considering their common bottleneck.This information is represented as weekly buckets -within the WeekBasedCapacityGroup. Therefore, all companies, that supply materials to other -companies, need to be able to create `WeekBasedCapacityGroup` objects in a consistent and -standardized structure and send them to their customers. The customers need to be able to receive -and interpret the `WeekBasedCapacityGroup` information. - -## ASPECT MODEL "WeekBasedMaterialDemand" - -The material demand information MUST be sent from the customer to the supplier according to the [CX-0048 DCM API Material Demand & Capacity Group](https://catena-x.net/de/standard-library) standard. The data format described here MUST be followed for the exchange of the `WeekBasedMaterialDemand` information. - -The `WeekBasedMaterialDemand` data model MUST be implemented by all participants who wish to -participate in the Catena-X DCM network as a customer or supplier. - -Companies, who participate in the Catena-X Network as a supplier, MUST be able to receive material -demand information and MUST be able to send capacity group information. - -Companies, who participate in the Catena-X Network as a customer, MUST be able to send material -demand information and MUST be able to receive capacity group information. - -Companies who participate in the Catena-X Network with both roles therefore MUST be able to receive -and send both, material demand as well as capacity group information. It is recommended that -companies implement both standards. - -Every data provider of `WeekBasedMaterialDemand` data MUST provide the data conformant to the -semantic model specified in this document. - -The unique identifier of the semantic model specified in this document MUST be used by the data -provider to define the semantics of the data being transferred. - -Every certified business application relying on `WeekBasedMaterialDemand` data MUST be able to -consume data conformant to the semantic model specified in this document. - -Data consumers and data provider MUST comply with the license of the semantic model. - -In the Catena-X data space `WeekBasedMaterialDemand` data MUST be requested and exchanged via -Eclipse Dataspace Connector (EDC) conformant to [CX-0018](https://catena-x.net/de/standard-library) and [CX-0002](https://catena-x.net/de/standard-library). - -The characteristics BPNL and BPNS MUST be used according to the standard [CX-0010](https://catena-x.net/de/standard-library). - -### Sample Data - -```json -{ - "unitOfMeasure": "GRM", - "materialDescriptionCustomer": "Spark Plug", - "materialDemandId": "0157ba42-d2a8-4e28-8565-7b07830c1110", - "materialNumberSupplier": "MNR-8101-ID146955.001", - "supplier": "BPNL6666666666YY", - "changedAt": "2023-03-10T12:27:11.320Z", - "demandSeries": [ - { - "expectedSupplierLocation": "BPNS8888888888XX", - "demands": [ - { - "demand": 1, - "calendarWeek": "2022-08-01" - } - ], - "customerLocation": "BPNS8888888888XX", - "demandCategory": { - "demandCategoryCode": "0001" - } - } - ], - "materialNumberCustomer": "MNR-7307-AU340474.002", - "customer": "BPNL8888888888XX" -} -``` - -The semantic model has the unique identifier -```text - urn:bamm:io.catenax.week_based_material_demand:1.0.0 -``` -This identifier MUST be used by the data provider to define the semantics of the data being -transferred. - -The rdf turtle file, an instance of the Semantic Aspect Meta Model, is the master for generating -additional file formats and serializations. - -```text - https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.week_based_material_demand/1.0.0/WeekBasedMaterialDemand.ttl -``` - -The open source command line tool of the Eclipse Semantic Modeling Framework is used for generation -of other file formats like for example a JSON Schema, aasx for Asset Administration Shell Submodel -Template or a HTML documentation. - -## ASPECT MODEL "WeekBasedCapacityGroup" - -The capacity group information MUST be sent from the supplier to the customer according to the -[CX-0048](https://catena-x.net/de/standard-library) standard. The data format described here MUST be followed for the exchange of the capacity group information. - -The capacity group data model MUST be implemented by all participants who wish to participate in the -Catena-X DCM network as a customer or supplier. - -Companies, who participate in the Catena-X Network as a supplier, MUST be able to receive material -demand information and MUST be able to send capacity group information. - -Companies, who participate in the Catena-X Network as a customer, MUST be able to send material -demand information and MUST be able to receive capacity group information. - -Companies who participate in the Catena-X Network with both roles therefore MUST be able to receive -and send both, material demand as well as capacity group information. It is recommended that -companies implement both standards. - -Every data provider of `WeekBasedCapacityGroup` data MUST provide the data conformant to the -semantic model specified in this document. - -The unique identifier of the semantic model specified in this document MUST be used by the data -provider to define the semantics of the data being transferred. - -Every certified business application relying on `WeekBasedCapacityGroup` data MUST be able to -consume data conformant to the semantic model specified in this document. - -Data consumers and data provider MUST comply with the license of the semantic model. - -In the Catena-X data space `WeekBasedCapacityGroup` data MUST be requested and exchanged via Eclipse -Dataspace Connector (EDC) conformant to [CX-0018](https://catena-x.net/de/standard-library) and [CX-0002](https://catena-x.net/de/standard-library). - -The characteristics BPNL and BPNS MUST be used according to the standard [CX-0010](https://catena-x.net/de/standard-library). - -### Sample Data - -```json -{ - "unitOfMeasure": "GRM", - "linkedDemandSeries": [ - { - "materialNumberCustomer": "MNR-7307-AU340474.002", - "materialNumberSupplier": "MNR-8101-ID146955.001", - "customerLocation": "BPNS8888888888XX", - "demandCategory": { - "demandCategoryCode": "0001" - } - } - ], - "supplier": "BPNL6666666666YY", - "name": "Spark Plugs on drilling machine for car model XYZ", - "supplierLocations": "BPNS8888888888XX", - "capacities": [ - { - "calendarWeek": "2022-08-01", - "actualCapacity": 1, - "maximumCapacity": 2 - } - ], - "changedAt": "2023-03-10T12:27:11.320Z", - "capacityGroupId": "0157ba42-d2a8-4e28-8565-7b07830c1110", - "customer": "BPNL8888888888XX" -} -``` - -The semantic model has the unique identifier -```text - urn:bamm:io.catenax.week_based_capacity_group:1.0.0 -``` -This identifier MUST be used by the data provider to define the semantics of the data being -transferred. - -The rdf turtle file, an instance of the Semantic Aspect Meta Model, is the master for generating -additional file formats and serializations. -```text - https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.week_based_capacity_group/1.0.0/WeekBasedCapacityGroup.ttl -``` -The open source command line tool of the Eclipse Semantic Modeling Framework is used for generation -of other file formats like for example a JSON Schema, aasx for Asset Administration Shell Submodel -Template or a HTML documentation. - -## Data Exchange - -### General Overview - -The `WeekBasedMaterialDemand` as well as the `WeekBasedCapacityGroup` is a JSON -string which is sent through EDC. The JSON string is standardized in this document and contains -either `WeekBasedMaterialDemand` or `WeekBasedCapacityGroup` information. - -The standard only describes the sending and receiving of `WeekBasedMaterialDemand` and -`WeekBasedCapacityGroup` through EDC. Both objects are created and handled by applications of the -companies involved, but these applications are not part of the standard. - -### WeekBasedMaterialDemand API - -To support the exchange of `WeekBasedMaterialDemand` data, a business application MUST define a -single endpoint supporting the HTTP POST request method as described in [RFC9110](https://datatracker.ietf.org/doc/html/rfc9110.html). -The structure of the endpoint MAY be freely chosen. The address of the endpoint MUST be provided -as part of the EDC Data Asset defined in this document. - -The WeekBasedMaterialDemand data MUST be sent from the customer to the supplier using an HTTP POST -request. The data format described here MUST be followed for the exchange of the material demand -information. - -Multiple `WeekBasedMaterialDemand` aspects MAY be sent in one transfer as a JSON list. If only one -`WeekBasedMaterialDemand` aspect is transmitted, it MUST still be sent as a list with one entry. - -The serialized JSON MUST NOT be larger than 15 MiB in size. - -The `WeekBasedMaterialDemand` endpoint MUST be implemented by all participants who wish to -participate in the Catena-X DCM network as a supplier. Customers MUST be able to send material -demand objects to their suppliers. - -The data payload itself MUST be a valid JSON file. - -All attributes marked as mandatory in the standard [CX-0047](https://catena-x.net/de/standard-library) MUST be included in the dataset. Attributes marked as 'Optional' MAY be included in the data set. - -The usage of the attributes in the data model MUST follow the attribute descriptions in the definitions -in [CX-0046](https://catena-x.net/de/standard-library). While some attributes are technically a -string, not any string is valid. For example, expectedSupplierLocations MUST be formatted as a BPNS. - -The calenderWeek MUST be set to a Monday of the week for that specific demand. The date format MUST -be in accordance with ISO8601 and MUST be in the format YYYY-MM-DD (for example 2023-02-13). - -The attributes 'demandCategory' and 'unitOfMeasure' MUST be set to one of the defined values as -defined in the standard [CX-0047](https://catena-x.net/de/standard-library). - - > **Definition from [CX-0046](https://catena-x.net/de/standard-library)** (Standardized there, non-normative -quote here) _"The customer owns and MUST publish its own demand with its supplier for the future -horizon and it is highly RECOMMENDED to avoid any gaps as far as possible and to share demand data -at least till month 9, to ensure DCM participants to have also sufficient demand data to work with._ -_If more demand data is available (i.e. demand related to a horizon that spans beyond month 9), the -customer MAY ideally provide them until month 24. If a customer has even more demand data available -(i.e. demand related to a horizon that spans beyond month 24), he MAY also provide this to his -supplier._ _The data series MAY start already from week n+2._ _Although the data series MAY start -already from week n+2 and can be elaborated from a technical perspective, the DCM process have a -clear focus on the tactical mid- to long-term horizon (typically considered from month 4 to 24) to -enable a more resilient supply chain."_ - -In addition to the definitions from [CX-0046](https://catena-x.net/de/standard-library) quoted above, the following rules have to be followed: - -The data series in the `WeekBasedMaterialDemand` SHOULD start already from week _n+2_. - -The demand for the current week (_n=0_) and the next week (_n=1_) MAY be included in the dataset. -The `WeekBasedMaterialDemand` MUST include at least one week other than the current or the next week -(meaning it may not be empty). Every week MUST NOT be included multiple times in the same -`WeekBasedMaterialDemand`. - -If the demand for one of the weeks changes, the whole dataset MUST be sent to the supplier; sending -the changes only (delta update / incremental update) is not possible. By this procedure, -inconsistent or incomplete data sets are avoided. One data transfer MUST contain at least one -`WeekBasedMaterialDemand` data set. - -For the combination of the attributes supplier, customer and materialNumberCustomer in the object -`WeekBasedMaterialDemand`, there MUST NOT be more than one `WeekBasedMaterialDemand` object in -existence. This means that the customer needs to collect all demands for all factories and send them -aggregated as one `WeekBasedMaterialDemand` to the supplier. - -If the demand in a certain week has the value `0`, it MUST be explicitly included as such in the -`WeekBasedMaterialDemand`, meaning the week cannot be left out (as there is a difference between -null and 0). Weeks with an unknown demand (value `null`) SHOULD be left out. - -#### UUID generation and handling - -The UUIDv4 MUST be generated according to [RFC4122](https://www.rfc-editor.org/rfc/rfc4122). - -For technical purposes the UUID MUST be treated as unique. In order to reduce the probability of -collision as well as to eliminate certain attack vectors it MUST be treated as unique within the -supplier-customer relationship. It SHOULD NOT be treated as globally unique for the reasons stated -above. - -For the combination of attributes: supplier, customer and materialNumberCustomer in the object -`WeekBasedMaterialDemand`, there MUST be exactly one unique UUID. - -#### EDC Data Asset Structure - -The HTTP POST endpoint introduced MUST NOT be called from a supply chain partner directly. Rather, it MUST be called via an EDC communication. -Therefore, the endpoint MUST be offered as an EDC Data Asset. The latter MUST have a property -`asset:prop:dcm` with value `weekbasedmaterialdemand-endpoint`. This property SHOULD be used to -identify the asset when searching the assets catalog of a supplier. Because the asset reflects the -contractual relationship between a supplier and its customers, only one asset with the -aforementioned property MUST be visible to the customer at any time to avoid ambiguity. - -An example EDC Data Asset definition with a corresponding access / usage policy and contract -definition are shown below. - -> Note: Expressions in double curly braces {{}} must be substituted with a corresponding value. - -```json -// Asset definition -{ - "asset": { - "properties": { - "asset:prop:id": "1", - "asset:prop:dcm": "weekbasedmaterialdemand-endpoint", - "asset:prop:description": "Endpoint for provisioning of week based material demands" - } - }, - "dataAddress": { - "properties": { - "type": "HttpData", - "baseUrl": "{{ **URL-WEEKBASEDMATERIALDEMAND-ENDPOINT** }}" - } - } -} -``` - -```json -// Access and Usage Policy definition -{ - "id": "1", - "policy": { - "prohibitions": [ - ], - "obligations": [ - ], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "USE" - }, - "constraints": [ - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BusinessPartnerNumber" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "{{ **CUSTOMER-BPN** }}" - }, - "operator": "EQ" - } - ] - } - ] - } -} -``` - -```json -// Contract definition -{ - "id": "1", - "criteria": [ - { - "operandLeft": "asset:prop:id", - "operator": "=", - "operandRight": "1" - } - ], - "accessPolicyId": "1", - "contractPolicyId": "1" -} -``` - -#### Error Handling and payload validation - -For error handling and payload validation instructions please refer to the [CX-0048](https://catena-x.net/de/standard-library) standard. - -### WeekBasedCapacityGroup API - -To support the exchange of `WeekBasedCapacityGroup` data, a business application MUST define a -single endpoint supporting the HTTP POST request method as described in [RFC9110](https://datatracker.ietf.org/doc/html/rfc9110.html). The structure of the endpoint MAY be freely chosen. The address of the endpoint MUST be provided as part of the EDC Data Asset defined in this document. - -The `WeekBasedCapacityGroup` data MUST be sent from the supplier to the customer using an HTTP POST -request. The data format described here MUST be followed for the exchange of the capacity group -information. - -Multiple `WeekBasedCapacityGroup` aspects MAY be sent in one transfer as a JSON list. If only one -`WeekBasedCapacityGroup` aspect is transmitted, it MUST still be sent as a list with one entry. - -The serialized JSON MUST NOT be larger than 15 MiB in size. - -The WeekBasedCapacityGroup endpoint MUST be implemented by all participants who wish to participate -in the Catena-X DCM network as a customer. Suppliers MUST be able to send `WeekBasedCapacityGroup` -objects to their customers. - -The data payload itself MUST be a valid JSON file. - -All attributes marked as mandatory in the standard [CX-0047](https://catena-x.net/de/standard-library) MUST be -included in the dataset. Attribute marked as 'Optional' CAN be included in the data set. - -The usage of the attributes in the data model MUST follow the attribute descriptions in the standard -[CX-0047](https://catena-x.net/de/standard-library) and the definitions in [CX-0046](#41-normative-references). For example, an exact definition of the different capacities is provided there and needs to be observed. - -While some attributes are technically a string, not any string is valid. For example, supplier MUST -be formatted as a BPNL. - -The calenderWeek MUST be set to a Monday of the week for that specific `WeekBasedCapacityGroup`. The -date format MUST be in accordance with ISO8601 and MUST be in the -format YYYY-MM-DD (for example 2023-02-13). - -The data payload itself MUST be a valid JSON file. - -The attributes 'demandCategory' and 'unitOfMeasure' MUST be set to one of the defined values as -defined in the standard [CX-0047](https://catena-x.net/de/standard-library). - -The capacities for the current week (_n=0_) and the next week (_n=1_) MAY be included in the -dataset. The `WeekBasedCapacityGroup` MUST include at least one week other than the current or the -next week (meaning it may not be empty). Every week MUST NOT be included multiple times in the same -`WeekBasedCapacityGroup`. - -If the capacity for one of the weeks changes, the whole dataset MUST be sent to the customer, -sending the changes only (delta update / incremental update) is NOT possible. By this procedure, -inconsistent or incomplete data sets are avoided. One data transfer MUST contain at least one -`WeekBasedCapacityGroup` data set. - -Additional business-process related rules are specified in the 'process template', these MUST be -followed as well. For example, the 'process template' defines a capacity and how it is to be -interpreted or that a demand must be consistent with other exchanged information such as call-offs. -All `WeekBasedCapacityGroup` objects MUST only use a mutually agreed unit of measure (as defined in -the standard [CX-0046](https://catena-x.net/de/standard-library)). - -The property linkedDemandSeries is used to indicate to which `WeekBasedMaterialDemand` object a -`WeekBasedCapacityGroup` object refers to. More specifically, the linkedDemandSeries refers to a -demand for a specific demandCategory / customerLocation / materialNumberCustomer combination. - -One specific combination of demandCategory / customerLocation / materialNumberCustomer MAY be -referred to in multiple `WeekBasedCapacityGroup` objects. Therefore, one materialNumberCustomer MAY -be contained in linkedDemandSeries of several different `WeekBasedCapacityGroup` objects. - -The order of the entries listed in the linkedDemandSeries of a `WeekBasedCapacityGroup` is arbitrary -and MUST be treated as such. - -#### UUID generation and handling - -The UUIDv4 MUST be generated according to [RFC4122](https://www.rfc-editor.org/rfc/rfc4122). - -For technical purposes the UUID MUST be treated as unique. In order to reduce the probability of -collision as well as to eliminate certain attack vectors it MUST be treated as unique within the -supplier-customer relationship. It SHOULD NOT be treated as globally unique for the reasons stated -above. - -#### EDC Data Asset Structure - -The HTTP POST endpoint introduced MUST NOT be called from a supply chain partner directly. Rather, it MUST be called via an EDC communication. Therefore, the endpoint MUST be offered as an EDC Data Asset. The latter MUST have a property " **asset:prop:dcm**" with value " **weekbasedcapacitygroup-endpoint**". This property SHOULD be used to identify the asset when searching the assets catalog of a customer. Because the asset reflects -the contractual relationship between a customer and its suppliers, only one asset with the -aforementioned property MUST be visible to the supplier at any time to avoid ambiguity. - -An example EDC Data Asset definition with a corresponding access / usage policy and contract -definition are shown below. - -> Note: Expressions in double curly braces {{}} must be substituted with a corresponding value. - -```json -// Asset definition -{ - "asset": { - "properties": { - "asset:prop:id": "1", - "asset:prop:dcm": "weekbasedcapacitygroup-endpoint", - "asset:prop:description": "Endpoint for provisioning of week based capacity groups" - } - }, - "dataAddress": { - "properties": { - "type": "HttpData", - "baseUrl": "{{URL-WEEKBASEDCAPACITYGROUP-ENDPOINT}}" - } - } -} -``` - -```json -// Access and Usage Policy definition -{ - "id": "1", - "policy": { - "prohibitions": [ - ], - "obligations": [ - ], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "USE" - }, - "constraints": [ - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BusinessPartnerNumber" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "{{SUPPLIER-BPN}}" - }, - "operator": "EQ" - } - ] - } - ] - } -} -``` - -```json -// Contract definition -{ - "id": "1", - "criteria": [ - { - "operandLeft": "asset:prop:id", - "operator": "=", - "operandRight": "1" - } - ], - "accessPolicyId": "1", - "contractPolicyId": "1" -} -``` - -#### Error Handling and payload validation - -For error handling and payload validation instructions please refer to the [CX-0048](https://catena-x.net/de/standard-library) standard. \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Documentation/admin_guide.md b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Documentation/admin_guide.md deleted file mode 100644 index 870c52e0cf2..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Documentation/admin_guide.md +++ /dev/null @@ -1,721 +0,0 @@ ---- -id: irs_admin_guide -title: Administration Guide -description: 'Administration Guide' -sidebar_position: 3 ---- - -![Datachain kit banner](@site/static/img/DataChainKitIcon.png) - -### 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. - -![adminguide_000](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/adminguide/adminguide_000.png) - -## Installation - -The IRS Helm repository can be found here: - - -Use the latest release of the "irs-helm" chart. -It contains all required dependencies. - -If you also want to set up your own EDC consumer, use the "irs-edc-consumer" chart. - -Supply the required configuration properties (see chapter [Configuration](configuration.adoc#_configuration)) in a values.yaml file or override the settings directly. - -### Deployment using Helm - -Add the IRS Helm repository: - -$ helm repo add irs - -Then install the Helm chart into your cluster: - -$ helm install -f your-values.yaml irs-app irs/irs-helm - -### Deployment using ArgoCD - -Create a new Helm chart and use the IRS as a dependency. - -```yaml -dependencies: - - name: irs-helm - repository: https://eclipse-tractusx.github.io/item-relationship-service - version: 3.x.x - - name: irs-edc-consumer # optional - repository: https://eclipse-tractusx.github.io/item-relationship-service - version: 1.x.x - -``` - -Then provide your configuration as the values.yaml of that chart. - -Create a new application in ArgoCD and point it to your repository / Helm chart folder. - -## Configuration - -Take the following template and adjust the configuration parameters (<placeholders> mark the relevant spots). -You can define the URLs as well as most of the secrets yourself. - -The Keycloak, DAPS and Vault configuration / secrets depend on your setup and might need to be provided externally. - -## Spring Configuration - -The IRS application is configured using the Spring configuration mechanism. The main configuration file is the ``application.yaml``. - -```yaml -server: - port: 8080 # The port the main application API listens on - trustedPort: ${SERVER_TRUSTED_PORT:} # The port used for the unsecured, internal API - if empty, the main port is used - -spring: - application: - name: item-relationship-service - security: - oauth2: - client: - registration: - keycloak: - authorization-grant-type: client_credentials - client-id: ${KEYCLOAK_OAUTH2_CLIENT_ID} # OAuth2 client ID used to authenticate with the IAM - client-secret: ${KEYCLOAK_OAUTH2_CLIENT_SECRET} # OAuth2 client secret used to authenticate with the IAM - provider: - keycloak: - token-uri: ${KEYCLOAK_OAUTH2_CLIENT_TOKEN_URI:https://default} # OAuth2 endpoint to request tokens using the client credentials - resourceserver: - jwt: - jwk-set-uri: ${KEYCLOAK_OAUTH2_JWK_SET_URI:https://default} # OAuth2 endpoint to request the JWK set - -management: # Spring management API config, see https://spring.io/guides/gs/centralized-configuration/ - endpoints: - web: - exposure: - include: health, threaddump, loggers, prometheus, info, metrics - endpoint: - health: - probes: - enabled: true - group: - readiness: - include: readinessState, diskSpace - show-details: always - health: - livenessstate: - enabled: true - readinessstate: - enabled: true - metrics: - distribution: - percentiles-histogram: - http: true - tags: - application: ${spring.application.name} - server: - port: 4004 - -logging: - pattern: - console: "%d %-5level %logger : %msg%n" - level: - root: WARN - org.springframework: INFO - org.eclipse.tractusx.irs: INFO - -springdoc: # API docs configuration - api-docs: - path: /api/api-docs - swagger-ui: - path: /api/swagger-ui - writer-with-order-by-keys: true - -irs: # Application config - apiUrl: "${IRS_API_URL:http://localhost:8080}" # Public URL of the application, used in Swagger UI - job: - callback: - timeout: - read: PT90S # HTTP read timeout for the Job API callback - connect: PT90S # HTTP connect timeout for the Job API callback - cleanup: # Determines how often the JobStore is being cleaned up. Different schedulers for completed and failed jobs. - scheduler: - # ┌───────────── second (0-59) - # │ ┌───────────── minute (0 - 59) - # │ │ ┌───────────── hour (0 - 23) - # │ │ │ ┌───────────── day of the month (1 - 31) - # │ │ │ │ ┌───────────── month (1 - 12) (or JAN-DEC) - # │ │ │ │ │ ┌───────────── day of the week (0 - 7) - # │ │ │ │ │ │ (or MON-SUN -- 0 or 7 is Sunday) - # │ │ │ │ │ │ - completed: 0 0 * * * * # every hour - failed: 0 0 * * * * # every hour - jobstore: - ttl: # Determines how long jobs are stored in the respective state. After the TTL has expired, the job will be removed by the cleanup scheduler. - failed: P7D # ISO 8601 Duration - completed: P7D # ISO 8601 Duration - cron: - expression: "*/10 * * * * ?" # Determines how often the number of stored jobs is updated in the metrics API. - -blobstore: - endpoint: "${MINIO_URL}" # S3 compatible API endpoint (e.g. Minio) - accessKey: "${MINIO_ACCESS_KEY}" # S3 access key - secretKey: "${MINIO_SECRET_KEY}" # S3 secret key - bucketName: irsbucket # the name of the S3 bucket to be created / used by the IRS - -resilience4j: - retry: # REST client retry configuration - configs: - default: - maxAttempts: 3 # How often failed REST requests will be retried - waitDuration: 10s # How long to wait between each retry - enableExponentialBackoff: true # Whether subsequent retries will delay exponentially or not - exponentialBackoffMultiplier: 2 # Multiplier for the exponential delay - ignore-exceptions: # Do not retry on the listed exceptions - - org.springframework.web.client.HttpClientErrorException.NotFound - instances: - registry: - baseConfig: default - - -edc: - controlplane: - request-ttl: ${EDC_CONTROLPLANE_REQUEST_TTL:PT10M} # How long to wait for an async EDC negotiation request to finish, ISO 8601 Duration - endpoint: - data: ${EDC_CONTROLPLANE_ENDPOINT_DATA:} # URL of the EDC consumer controlplane data endpoint - provider-suffix: ${EDC_CONTROLPLANE_PROVIDER_SUFFIX:/api/v1/ids/data} # Suffix to add to data requests to the EDC provider controlplane - catalog-limit: ${EDC_CONTROLPLANE_CATALOG_LIMIT:1000} # Max number of items to fetch from the EDC provider catalog - catalog-page-size: ${EDC_CONTROLPLANE_CATALOG_PAGE_SIZE:50} # Number of items to fetch at one page from the EDC provider catalog when using pagination - api-key: - header: ${EDC_API_KEY_HEADER:} # API header key to use in communication with the EDC consumer controlplane - secret: ${EDC_API_KEY_SECRET:} # API header secret to use in communication with the EDC consumer controlplane - datareference: - storage: - duration: PT1H # Time after which stored data references will be cleaned up, ISO 8601 Duration - - submodel: - request-ttl: ${EDC_SUBMODEL_REQUEST_TTL:PT10M} # How long to wait for an async EDC submodel retrieval to finish, ISO 8601 Duration - path: ${EDC_SUBMODEL_PATH:/submodel} # The path to append to the submodel data reference endpoint - urn-prefix: ${EDC_SUBMODEL_URN_PREFIX:/urn} # A prefix used to identify URNs correctly in the submodel endpoint address - timeout: - read: PT90S # HTTP read timeout for the submodel client - connect: PT90S # HTTP connect timeout for the submodel client - - catalog: - cache: - enabled: true # Set to false to disable caching - ttl: P1D # Time after which a cached Item is no longer valid and the real catalog is called instead - maxCachedItems: 64000 # Maximum amount of cached catalog items - -digitalTwinRegistry: - descriptorEndpoint: ${DIGITALTWINREGISTRY_DESCRIPTOR_URL:} # The endpoint to retrieve AAS descriptors from the DTR, must contain the placeholder {aasIdentifier} - shellLookupEndpoint: ${DIGITALTWINREGISTRY_SHELL_LOOKUP_URL:} # The endpoint to lookup shells from the DTR, must contain the placeholder {assetIds} - oAuthClientId: keycloak # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client - timeout: - read: PT90S # HTTP read timeout for the digital twin registry client - connect: PT90S # HTTP connect timeout for the digital twin registry client - -semanticshub: - # The endpoint to retrieve the json schema of a model from the semantic hub. If specified, must contain the placeholder {urn}. - modelJsonSchemaEndpoint: "${SEMANTICSHUB_URL:}" - url: "" - - # Path to directory on filesystem where semantic models can be loaded from. - # The filenames inside the directory must match the Base64 encoded URNs of the models. - localModelDirectory: "" - cleanup: - # ┌───────────── second (0-59) - # │ ┌───────────── minute (0 - 59) - # │ │ ┌───────────── hour (0 - 23) - # │ │ │ ┌───────────── day of the month (1 - 31) - # │ │ │ │ ┌───────────── month (1 - 12) (or JAN-DEC) - # │ │ │ │ │ ┌───────────── day of the week (0 - 7) - # │ │ │ │ │ │ (or MON-SUN -- 0 or 7 is Sunday) - # │ │ │ │ │ │ - scheduler: 0 0 23 * * * # How often to clear the semantic model cache - defaultUrns: "${SEMANTICSHUB_DEFAULT_URNS:urn:bamm:io.catenax.serial_part_typization:1.0.0#SerialPartTypization}" # IDs of models to cache at IRS startup - oAuthClientId: keycloak # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client - timeout: - read: PT90S # HTTP read timeout for the semantic hub client - connect: PT90S # HTTP connect timeout for the semantic hub client - pageSize: "${SEMANTICSHUB_PAGE_SIZE:100}" - -bpdm: - bpnEndpoint: "${BPDM_URL:}" # Endpoint to resolve BPNs, must contain the placeholders {partnerId} and {idType} - oAuthClientId: keycloak # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client - timeout: - read: PT90S # HTTP read timeout for the bpdm client - connect: PT90S # HTTP connect timeout for the bpdm client - -apiAllowedBpn: ${API_ALLOWED_BPN:BPNL00000003CRHK} -``` - -### Helm configuration IRS (values.yaml) - -```yaml - labelSelector: - matchExpressions: - - key: app.kubernetes.io/name - operator: DoesNotExist - topologyKey: kubernetes.io/hostname - -# Following Catena-X Helm Best Practices @url: https://catenax-ng.github.io/docs/kubernetes-basics/helm -# @url: https://github.com/helm/charts/blob/master/stable/nginx-ingress/values.yaml#L210 -livenessProbe: - failureThreshold: 6 - initialDelaySeconds: 30 - periodSeconds: 10 - successThreshold: 1 - timeoutSeconds: 1 -readinessProbe: - failureThreshold: 3 - initialDelaySeconds: 30 - periodSeconds: 10 - successThreshold: 1 - timeoutSeconds: 1 - -##################### -# IRS Configuration # -##################### -irsUrl: # "https://" -ingress: - enabled: false - -digitalTwinRegistry: - url: # "https://" - descriptorEndpoint: >- - {{ tpl (.Values.digitalTwinRegistry.url | default "") . }}/registry/shell-descriptors/{aasIdentifier} - shellLookupEndpoint: >- - {{ tpl (.Values.digitalTwinRegistry.url | default "") . }}/lookup/shells?assetIds={assetIds} -semanticshub: - url: # https:// - pageSize: "100" # Number of aspect models to retrieve per page - modelJsonSchemaEndpoint: >- - {{- if .Values.semanticshub.url }} - {{- tpl (.Values.semanticshub.url | default "" ) . }}/{urn}/json-schema - {{- end }} - defaultUrns: >- - # urn:bamm:io.catenax.serial_part_typization:1.0.0#SerialPartTypization - # ,urn:bamm:com.catenax.assembly_part_relationship:1.0.0#AssemblyPartRelationship - localModels: -# Map of Base64 encoded strings of semantic models. The key must be the Base64 encoded full URN of the model. -# Example for urn:bamm:io.catenax.serial_part_typization:1.1.1#SerialPartTypization: -# dXJuOmJhbW06aW8uY2F0ZW5heC5zZXJpYWxfcGFydF90eXBpemF0aW9uOjEuMS4xI1NlcmlhbFBhcnRUeXBpemF0aW9u: ewoJIiRzY2hlbWEiOiAiaHR0cDovL2pzb24tc2NoZW1hLm9yZy9kcmFmdC0wNC9zY2hlbWEiLAoJInR5cGUiOiAib2JqZWN0IiwKCSJjb21wb25lbnRzIjogewoJCSJzY2hlbWFzIjogewoJCQkidXJuX2JhbW1faW8uY2F0ZW5heC5zZXJpYWxfcGFydF90eXBpemF0aW9uXzEuMS4xX0NhdGVuYVhJZFRyYWl0IjogewoJCQkJInR5cGUiOiAic3RyaW5nIiwKCQkJCSJwYXR0ZXJuIjogIiheWzAtOWEtZkEtRl17OH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17MTJ9JCl8KF51cm46dXVpZDpbMC05YS1mQS1GXXs4fS1bMC05YS1mQS1GXXs0fS1bMC05YS1mQS1GXXs0fS1bMC05YS1mQS1GXXs0fS1bMC05YS1mQS1GXXsxMn0kKSIKCQkJfSwKCQkJInVybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9LZXlDaGFyYWN0ZXJpc3RpYyI6IHsKCQkJCSJ0eXBlIjogInN0cmluZyIKCQkJfSwKCQkJInVybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9WYWx1ZUNoYXJhY3RlcmlzdGljIjogewoJCQkJInR5cGUiOiAic3RyaW5nIgoJCQl9LAoJCQkidXJuX2JhbW1faW8uY2F0ZW5heC5zZXJpYWxfcGFydF90eXBpemF0aW9uXzEuMS4xX0tleVZhbHVlTGlzdCI6IHsKCQkJCSJ0eXBlIjogIm9iamVjdCIsCgkJCQkicHJvcGVydGllcyI6IHsKCQkJCQkia2V5IjogewoJCQkJCQkiJHJlZiI6ICIjL2NvbXBvbmVudHMvc2NoZW1hcy91cm5fYmFtbV9pby5jYXRlbmF4LnNlcmlhbF9wYXJ0X3R5cGl6YXRpb25fMS4xLjFfS2V5Q2hhcmFjdGVyaXN0aWMiCgkJCQkJfSwKCQkJCQkidmFsdWUiOiB7CgkJCQkJCSIkcmVmIjogIiMvY29tcG9uZW50cy9zY2hlbWFzL3Vybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9WYWx1ZUNoYXJhY3RlcmlzdGljIgoJCQkJCX0KCQkJCX0sCgkJCQkicmVxdWlyZWQiOiBbCgkJCQkJImtleSIsCgkJCQkJInZhbHVlIgoJCQkJXQoJCQl9LAoJCQkidXJuX2JhbW1faW8uY2F0ZW5heC5zZXJpYWxfcGFydF90eXBpemF0aW9uXzEuMS4xX0xvY2FsSWRlbnRpZmllckNoYXJhY3RlcmlzdGljIjogewoJCQkJInR5cGUiOiAiYXJyYXkiLAoJCQkJIml0ZW1zIjogewoJCQkJCSIkcmVmIjogIiMvY29tcG9uZW50cy9zY2hlbWFzL3Vybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9LZXlWYWx1ZUxpc3QiCgkJCQl9LAoJCQkJInVuaXF1ZUl0ZW1zIjogdHJ1ZQoJCQl9LAoJCQkidXJuX2JhbW1faW8ub3Blbm1hbnVmYWN0dXJpbmdfY2hhcmFjdGVyaXN0aWNfMi4wLjBfVGltZXN0YW1wIjogewoJCQkJInR5cGUiOiAic3RyaW5nIiwKCQkJCSJwYXR0ZXJuIjogIi0/KFsxLTldWzAtOV17Myx9fDBbMC05XXszfSktKDBbMS05XXwxWzAtMl0pLSgwWzEtOV18WzEyXVswLTldfDNbMDFdKVQoKFswMV1bMC05XXwyWzAtM10pOlswLTVdWzAtOV06WzAtNV1bMC05XShcXC5bMC05XSspP3woMjQ6MDA6MDAoXFwuMCspPykpKFp8KFxcK3wtKSgoMFswLTldfDFbMC0zXSk6WzAtNV1bMC05XXwxNDowMCkpPyIKCQkJfSwKCQkJInVybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9Qcm9kdWN0aW9uQ291bnRyeUNvZGVUcmFpdCI6IHsKCQkJCSJ0eXBlIjogInN0cmluZyIsCgkJCQkicGF0dGVybiI6ICJeW0EtWl1bQS1aXVtBLVpdJCIKCQkJfSwKCQkJInVybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9NYW51ZmFjdHVyaW5nQ2hhcmFjdGVyaXN0aWMiOiB7CgkJCQkidHlwZSI6ICJvYmplY3QiLAoJCQkJInByb3BlcnRpZXMiOiB7CgkJCQkJImRhdGUiOiB7CgkJCQkJCSIkcmVmIjogIiMvY29tcG9uZW50cy9zY2hlbWFzL3Vybl9iYW1tX2lvLm9wZW5tYW51ZmFjdHVyaW5nX2NoYXJhY3RlcmlzdGljXzIuMC4wX1RpbWVzdGFtcCIKCQkJCQl9LAoJCQkJCSJjb3VudHJ5IjogewoJCQkJCQkiJHJlZiI6ICIjL2NvbXBvbmVudHMvc2NoZW1hcy91cm5fYmFtbV9pby5jYXRlbmF4LnNlcmlhbF9wYXJ0X3R5cGl6YXRpb25fMS4xLjFfUHJvZHVjdGlvbkNvdW50cnlDb2RlVHJhaXQiCgkJCQkJfQoJCQkJfSwKCQkJCSJyZXF1aXJlZCI6IFsKCQkJCQkiZGF0ZSIKCQkJCV0KCQkJfSwKCQkJInVybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9QYXJ0SWRDaGFyYWN0ZXJpc3RpYyI6IHsKCQkJCSJ0eXBlIjogInN0cmluZyIKCQkJfSwKCQkJInVybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9QYXJ0TmFtZUNoYXJhY3RlcmlzdGljIjogewoJCQkJInR5cGUiOiAic3RyaW5nIgoJCQl9LAoJCQkidXJuX2JhbW1faW8uY2F0ZW5heC5zZXJpYWxfcGFydF90eXBpemF0aW9uXzEuMS4xX0NsYXNzaWZpY2F0aW9uQ2hhcmFjdGVyaXN0aWMiOiB7CgkJCQkidHlwZSI6ICJzdHJpbmciLAoJCQkJImVudW0iOiBbCgkJCQkJInByb2R1Y3QiLAoJCQkJCSJyYXcgbWF0ZXJpYWwiLAoJCQkJCSJzb2Z0d2FyZSIsCgkJCQkJImFzc2VtYmx5IiwKCQkJCQkidG9vbCIsCgkJCQkJImNvbXBvbmVudCIKCQkJCV0KCQkJfSwKCQkJInVybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9QYXJ0VHlwZUluZm9ybWF0aW9uQ2hhcmFjdGVyaXN0aWMiOiB7CgkJCQkidHlwZSI6ICJvYmplY3QiLAoJCQkJInByb3BlcnRpZXMiOiB7CgkJCQkJIm1hbnVmYWN0dXJlclBhcnRJZCI6IHsKCQkJCQkJIiRyZWYiOiAiIy9jb21wb25lbnRzL3NjaGVtYXMvdXJuX2JhbW1faW8uY2F0ZW5heC5zZXJpYWxfcGFydF90eXBpemF0aW9uXzEuMS4xX1BhcnRJZENoYXJhY3RlcmlzdGljIgoJCQkJCX0sCgkJCQkJImN1c3RvbWVyUGFydElkIjogewoJCQkJCQkiJHJlZiI6ICIjL2NvbXBvbmVudHMvc2NoZW1hcy91cm5fYmFtbV9pby5jYXRlbmF4LnNlcmlhbF9wYXJ0X3R5cGl6YXRpb25fMS4xLjFfUGFydElkQ2hhcmFjdGVyaXN0aWMiCgkJCQkJfSwKCQkJCQkibmFtZUF0TWFudWZhY3R1cmVyIjogewoJCQkJCQkiJHJlZiI6ICIjL2NvbXBvbmVudHMvc2NoZW1hcy91cm5fYmFtbV9pby5jYXRlbmF4LnNlcmlhbF9wYXJ0X3R5cGl6YXRpb25fMS4xLjFfUGFydE5hbWVDaGFyYWN0ZXJpc3RpYyIKCQkJCQl9LAoJCQkJCSJuYW1lQXRDdXN0b21lciI6IHsKCQkJCQkJIiRyZWYiOiAiIy9jb21wb25lbnRzL3NjaGVtYXMvdXJuX2JhbW1faW8uY2F0ZW5heC5zZXJpYWxfcGFydF90eXBpemF0aW9uXzEuMS4xX1BhcnROYW1lQ2hhcmFjdGVyaXN0aWMiCgkJCQkJfSwKCQkJCQkiY2xhc3NpZmljYXRpb24iOiB7CgkJCQkJCSIkcmVmIjogIiMvY29tcG9uZW50cy9zY2hlbWFzL3Vybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9DbGFzc2lmaWNhdGlvbkNoYXJhY3RlcmlzdGljIgoJCQkJCX0KCQkJCX0sCgkJCQkicmVxdWlyZWQiOiBbCgkJCQkJIm1hbnVmYWN0dXJlclBhcnRJZCIsCgkJCQkJIm5hbWVBdE1hbnVmYWN0dXJlciIsCgkJCQkJImNsYXNzaWZpY2F0aW9uIgoJCQkJXQoJCQl9CgkJfQoJfSwKCSJwcm9wZXJ0aWVzIjogewoJCSJjYXRlbmFYSWQiOiB7CgkJCSIkcmVmIjogIiMvY29tcG9uZW50cy9zY2hlbWFzL3Vybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9DYXRlbmFYSWRUcmFpdCIKCQl9LAoJCSJsb2NhbElkZW50aWZpZXJzIjogewoJCQkiJHJlZiI6ICIjL2NvbXBvbmVudHMvc2NoZW1hcy91cm5fYmFtbV9pby5jYXRlbmF4LnNlcmlhbF9wYXJ0X3R5cGl6YXRpb25fMS4xLjFfTG9jYWxJZGVudGlmaWVyQ2hhcmFjdGVyaXN0aWMiCgkJfSwKCQkibWFudWZhY3R1cmluZ0luZm9ybWF0aW9uIjogewoJCQkiJHJlZiI6ICIjL2NvbXBvbmVudHMvc2NoZW1hcy91cm5fYmFtbV9pby5jYXRlbmF4LnNlcmlhbF9wYXJ0X3R5cGl6YXRpb25fMS4xLjFfTWFudWZhY3R1cmluZ0NoYXJhY3RlcmlzdGljIgoJCX0sCgkJInBhcnRUeXBlSW5mb3JtYXRpb24iOiB7CgkJCSIkcmVmIjogIiMvY29tcG9uZW50cy9zY2hlbWFzL3Vybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9QYXJ0VHlwZUluZm9ybWF0aW9uQ2hhcmFjdGVyaXN0aWMiCgkJfQoJfSwKCSJyZXF1aXJlZCI6IFsKCQkiY2F0ZW5hWElkIiwKCQkibG9jYWxJZGVudGlmaWVycyIsCgkJIm1hbnVmYWN0dXJpbmdJbmZvcm1hdGlvbiIsCgkJInBhcnRUeXBlSW5mb3JtYXRpb24iCgldCn0= -bpdm: - url: # https:// - bpnEndpoint: >- - {{ tpl (.Values.bpdm.url | default "") . }}/api/catena/legal-entities/{partnerId}?idType={idType} -minioUser: "minio" # -minioPassword: # -minioUrl: "http://{{ .Release.Name }}-minio:9000" -keycloak: - oauth2: - clientId: # - clientSecret: # - clientTokenUri: # - jwkSetUri: # -edc: - controlplane: - endpoint: - data: "" # - request: - ttl: PT10M # Requests to controlplane will time out after this duration (see https://en.wikipedia.org/wiki/ISO_8601#Durations) - provider: - suffix: /api/v1/ids/data - catalog: - limit: 1000 # Max number of catalog items to retrieve from the controlplane - pagesize: 50 # Number of catalog items to retrieve on one page for pagination - apikey: - header: "X-Api-Key" # Name of the EDC api key header field - secret: "" # - submodel: - request: - ttl: PT10M # Requests to dataplane will time out after this duration (see https://en.wikipedia.org/wiki/ISO_8601#Durations) - path: /submodel - urnprefix: /urn - catalog: - cache: - enabled: true # Set to false to disable caching - ttl: P1D # Time after which a cached Item is no longer valid and the real catalog is called instead - maxCachedItems: 64000 # Maximum amount of cached catalog items - -config: - # If true, the config provided below will completely replace the configmap. - # In this case, you need to provide all required config values defined above yourself! - # If false, the custom config will just be appended to the configmap. - override: false - # Provide your custom configuration here (overrides IRS Spring application.yaml) - content: - - -env: [] # You can provide your own environment variables for the IRS here. -# - name: JAVA_TOOL_OPTIONS -# value: -Dhttps.proxyHost=1.2.3.4 - - -####################### -# Minio Configuration # -####################### -minio: - enabled: true - mode: standalone - persistence: - size: 1Gi - resources: - limits: - cpu: 1 - memory: 4Gi - requests: - cpu: 0.25 - memory: 4Gi - rootUser: "minio" # - rootPassword: "minioPass" # - - environment: - MINIO_PROMETHEUS_JOB_ID: minio-actuator - MINIO_PROMETHEUS_URL: http://prometheus:9090 - - -############################ -# Prometheus Configuration # -############################ -prometheus: - enabled: false # â‘ - rbac: - create: false - alertmanager: - enabled: false - prometheus-node-exporter: - enabled: false - kubeStateMetrics: - enabled: false - prometheus-pushgateway: - enabled: false - configmapReload: - prometheus: - enabled: false - - extraScrapeConfigs: | - - job_name: 'spring-actuator' - metrics_path: '/actuator/prometheus' - scrape_interval: 5s - static_configs: - - targets: [ '{{ .Release.Name }}-irs-helm:4004' ] - - - job_name: 'minio-actuator' - metrics_path: /minio/v2/metrics/cluster - static_configs: - - targets: [ '{{ .Release.Name }}-minio:9000' ] - - -######################### -# Grafana Configuration # -######################### -grafana: - enabled: false # â‘ - rbac: - create: false - persistence: - enabled: false - - user: # -``` - -1. Use this to enable or disable the monitoring components - -#### Values explained - -##### irs-url - -The hostname where the IRS will be made available. - -##### digital-twin-registry-url - -The URL of the Digital Twin Registry. The IRS uses this service to fetch AAS shells. - -##### semantics-hub-url - -The URL of the SemanticsHub. The IRS uses this service to fetch aspect schemas for payload validation. - -##### bpdm-url - -The URL of the BPDM service. The IRS uses this service to fetch business partner information based on BPNs. - -##### keycloak-token-uri - -The URL of the Keycloak token API. Used by the IRS for token creation to authenticate with other services. - -##### keycloak-jwkset-uri - -The URL of the Keycloak JWK Set. Used by the IRS to validate tokens when the IRS API is called. - -##### grafana-url - -The hostname where Grafana will be made available. - -##### edc-controlplane-endpoint-data - -The EDC consumer controlplane endpoint URL for data management, including the protocol. -If left empty, this defaults to the internal endpoint of the controlplane provided by the irs-edc-consumer Helm chart. - -#### Semantic Model Provisioning - -The IRS can retrieve semantic models in two ways: - -1. via the Semantic Hub, if you provide the URL -2. via local schema files - -If you activate both features, IRS will first try to resolve the models via the Hub and use the -local models as a fallback. - -If you want to use local schema files, you need to provide them directly in the `values.yaml` file. Use the param `semanticsHub.localModels` to specify a map of all the local schemas. -The **key** of each entry is the `Base64` encoded URN of the model. The **value** is the `Base64` encoded content of the schema file itself. The entries will then be mounted into the IRS container and used on demand. For reference, see the example comment in the default `values.yaml`. - -### EDC consumer configuration - -If you want to provide your own EDC consumer, add the following entries to your values.yaml: - -```yaml -############################## -# EDC Postgres Configuration # -############################## -postgresql: - auth: - username: edc - database: edc - postgresPassword: - password: - -################################## -# EDC Controlplane Configuration # -################################## -edc-controlplane: - ingresses: - - enabled: true - hostname: "" - annotations: - nginx.ingress.kubernetes.io/ssl-passthrough: "false" - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - nginx.ingress.kubernetes.io/force-ssl-redirect: "true" - endpoints: - - protocol - className: "" - tls: - - hosts: - - "" - secretName: tls-secret - certManager: - issuer: "" - clusterIssuer: "" - - edc: - receiver: - callback: - url: "http://{{ .Release.Name }}-irs-helm:8181/internal/endpoint-data-reference" # IRS EDC callback URL, e.g. http://app-irs-helm:8181/internal/endpoint-data-reference - postgresql: - user: edc - password: - transfer: - proxy: - token: - verifier: - publickey: - alias: - signer: - privatekey: - alias: - api: - auth: - key: "" - controlplane: - url: "https://" - dataplane: - url: "https://" - configuration: - properties: |- - edc.oauth.client.id= - edc.oauth.private.key.alias= - edc.oauth.provider.jwks.url= - edc.oauth.certificate.alias= - edc.oauth.token.url= - edc.vault.hashicorp.url= - edc.vault.hashicorp.token= - edc.vault.hashicorp.api.secret.path= - edc.data.encryption.keys.alias= - edc.data.encryption.algorithm=NONE - -############################### -# EDC Dataplane Configuration # -############################### -edc-dataplane: - edc: - api: - auth: - key: "" - ## Ingress declaration to expose the network service. - ingresses: - - enabled: true - hostname: "" - annotations: - nginx.ingress.kubernetes.io/ssl-passthrough: "false" - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - nginx.ingress.kubernetes.io/force-ssl-redirect: "true" - endpoints: - - public - className: "nginx" - tls: - - hosts: - - "" - secretName: tls-secret - certManager: - issuer: "" - clusterIssuer: "" - - configuration: - properties: |- - edc.oauth.client.id= - edc.oauth.private.key.alias= - edc.oauth.provider.audience=idsc:IDS_CONNECTORS_ALL - edc.oauth.provider.jwks.url= - edc.oauth.certificate.alias= - edc.oauth.token.url= - edc.vault.hashicorp.url= - edc.vault.hashicorp.token= - edc.vault.hashicorp.api.secret.path= -``` - -#### Values explained - -EDC requires a DAPS instance to function correctly. For more information on this, please refer to the [DAPS](https://github.com/catenax-ng/product-DAPS) or the [EDC](https://github.com/catenax-ng/product-edc) documentation. - -##### controlplane-url - -The hostname where the EDC consumer controlplane will be made available. - -##### dataplane-url - -The hostname where the EDC consumer dataplane will be made available. - -##### vault-url - -The base URL of the Vault instance. -EDC requires a running instance of HashiCorp Vault to store the DAPS certificate and private key. - -##### vault-secret-store-path - -The path to the secret store in Vault where the DAPS certificate and key can be found. - -Example: /v1/team-name - -##### daps-certificate-name - -The name of the DAPS certificate in the Vault. - -Example: irs-daps-certificate - -##### daps-privatekey-name - -The name of the DAPS private key in the Vault. - -Example: irs-daps-private-key - -##### daps-client-id - -The DAPS client ID. - -##### daps-jwks-url - -The URL of the DAPS JWK Set. - -Example: - -##### daps-token-url - -The URL of the DAPS token API. - -Example: - -### Secrets - -This is a list of all secrets used in the deployment. - -**⚠️ WARNING**\ -Keep the values for these settings safe and do not publish them! - -#### postgres-admin-password - -Database password for the **postgres** user. To be defined by you. - -#### postgres-password - -Database password for the application user (default username: **edc**). To be defined by you. - -#### keycloak-client-id - -Client ID for Keycloak. Request this from your Keycloak operator. - -#### keycloak-client-secret - -Client secret for Keycloak. Request this from your Keycloak operator. - -#### minio-username - -Login username for Minio. To be defined by you. - -#### minio-password - -Login password for Minio. To be defined by you. - -#### edc-api-key - -An API key for the EDC API. To be defined by you. - -#### vault-token - -The access token for the HashiCorp Vault API. - -#### grafana-username - -Login username for Grafana. To be defined by you. - -#### grafana-password - -Login password for Grafana. To be defined by you. - -## Troubleshooting - -### Proxy support - -If you are using an HTTP(S) proxy for outgoing connections, you need to configure the IRS to use it. - -```bash -JAVA_TOOL_OPTIONS=-Dhttps.proxyHost=X.X.X.X -Dhttps.proxyPort=XXXX -``` - -You might need to specify both `http` and `https` options, dependending on your configuration. - -If your proxy is requiring authentication, you can use the `.proxyUser` and `.proxyPassword` properties in addition. - -### Troubleshooting FAQ - -#### Minio - -##### Error: "The specified bucket does not exist" - -IRS tries to read data from or write to the Minio storage, but no bucket exists. This can happen if Minio is running without a persistent volume and restarts, thus losing all data. -It can also happen if the persistent volume claim is deleted / recreated. - -**Proposed solution steps:** - -1. Make sure Minio is configured and running correctly. -2. Restart the IRS - this will recreate the missing bucket automatically. - -#### Different Job model versions maintenance - -Currently, the IRS only supports one version of the Job model at a time. This means that if Job model is changed, old models stored in minio will no longer be supported and returned from IRS endpoints. The IRS application will work as usual, old versions of Job can stay in the minio and don’t need to be removed - the IRS will simply ignore them. If you want to clear the minio from old models - the only way to achieve that is to delete them all and register a new Jobs. diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Documentation/arc42.md b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Documentation/arc42.md deleted file mode 100644 index da38b1af9e6..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Documentation/arc42.md +++ /dev/null @@ -1,883 +0,0 @@ ---- -id: irs_arc42 -title: Architecture documentation (arc42) - -description: 'Architecture documentation (arc42)' -sidebar_position: 3 ---- - - -![Datachain kit banner](@site/static/img/DataChainKitIcon.png) - -### Data Chain KIT - -## Introduction and goals - -This chapter gives you an overview about the goals of the service, -in which context the service runs and which stakeholders are involved. - -## Requirements overview - -### What is the Item Relationship Service? - -The IRS is a: - -* Functional federated component -* API endpoint to retrieve the tree structures in a recursive way, which data assets are distributed throughout the Catena-X network -* Reference implementation -* Data chain provider - -### Substantial Features - -* provide a top-down BoM asBuilt tree structure along the submodel "AssemblyPartRelationship" -* usage of EDC consumer for communicating with the Catena-X network -* functionality of IRS provider will be handled by providers submodel servers -* federated IRS service -* 'asBuild' BoM of serialized components -* provides endpoints for submodel-descriptors - -## Quality goals - -**❗ IMPORTANT**\ -The following table entries define overall IRS quality goals. The order of the topics do not resolve in a priority of the quality goals. - -| Quality goal | Motivation and description | -| --- | --- | -| running reference application | The IRS is built to traverse a distributed data chain across the automotive Industry. The goal for the IRS release 1 scope is to build a running solution to test the functionality of building a BoM as built of serialized components. | -| multiple async job orchestration | The IRS is built to access multiple endpoints parallel. Since the for the Endpoint it is not clear yet how long a request will take to respond. The Service is built to handle multiple asynchronous requests. | -| cloud agnostic solution | The IRS is built as reference architecture and able to run on different cloud solutions. It uses helm charts, terraform and a abstracts the storage, so that it can easily be integrated on different systems. | -| base security measures | The IRS is built with a base set of security features. | -| application reliability | The IRS architecture is set up so that the costumers can rely on reliable data chains | - -## Architecture constraints - -### Technical Constraints - -| Name | Description | -| --- | --- | -| Cloud Agnostic Architecture approach | IRS provides a reference application/implementation which is deployable on any cloud ecosystem. There is no vendor lock to any cloud vendor. | -| Spring Boot and the Spring framework is used as underlying framework for Java development. | Spring Boot and Framework is used to build an easy and production-grade based application which could be deployed without any further infrastructure components. Orchestrating application components and integrating with other libraries/frameworks. | -| Lombok | Lombok for generating boilerplate code. Keeping code concise increases quality and maintainability. | -| Kubernetes is used for Container Orchestration | Kubernetes as container orchestration system used for software deployment, scaling and management of the IRS application. This supports our software infrastructure and ensures efficient management and scalability of the IRS reference application. | -| Docker Container are used to provide a microservice oriented architecture | Deployment made on reliable production ready images. Avoiding repetitive, mundane configuration tasks for container orchestration. | -| Docker Compose is used to define and tune multi container application based on docker container technologies. | Docker container to develop independently of the underlying OS. | - -### Organizational Constraints - -| Name | Description | Comment | -| --- | --- | --- | -| CX-Services | Provide IRS as a C-X Shared Data Service. | | -| App Marketplace & API Connection | IRS Application has to be accessible for the user in the App Marketplace. | App Marketplace & API Connection | -| Federal Ministry for Economic Affairs and Energy (BMWi) promotion | The Federal Ministry for Economic Affairs and Energy (BMWi) promotes the project and provides funds for the project. | | -| Technology Readiness Level (TRL) for products developed within the CX Consortia | As IRS is a reference implementation, the Technology Readiness Level (TRL) must not be above TRL 8. | | -| Operational Readiness for Release 1 has to be fulfilled | Minimum requirements for release 1 has to be archived. Later on, the Operational Readiness for Release has to be fulfilled accordingly to the requirements of the C-X consortia. | | - -### Political constraints - -| Name | Description | -| --- | --- | -| Open Source | FOSS licenses approved by the eclipse foundation has to be used. It could represent the initial set that the CX community agrees on to regulate the content contribution under FOSS licenses. | -| Apache License 2.0 | Apache License 2.0 is one of the approved licenses which should be used to respect and guarantee Intellectual property (IP). | -| Java OpenJDK Version JDK >= 11 | IRS provides an open source application standard. OpenJDK is used, which is licensed under GNU General Public License (GNU GPL) Version 2. | - -### Development conventions - -| Name | Description | -| --- | --- | -| Architecture documentation | Architectural documentation of IRS reference application/implementation according to ARC42 template. | -| Coding guidelines | We follow the Google Java Style Guide. That is ensured by using the unified code formatter in the team and enforcing the style via Maven and Checkstyle / PMD. | -| Executable Bundle provided over the App Marketplace | As IRS is available in the App Marketplace, the application should be provided in one executable bundle. | -| Module structure | The entire build is driven from a Maven file, itself run from a single Dockerfile. | -| Code Analysis, Linting and Code Coverage | Consistent style increases readability and maintainability of the code base. Hence, we use analyzers to enforce consistency and style rules. We enforce the code style and rules in the CI to avoid merging code that does not comply with standards. | - -#### Code analysis, linting and code coverage - -| Tool | Scope | Rule | Configuration (via files / annotations) | -| --- | --- | --- | --- | -| Tidy | Enforce Maven POM Code Convention | Fail build on untidy pom.xml | N/A | -| SpotBugs | Static analysis to look for bugs in Java code. Successor of popular FindBugs tool | Fail build on violations | ci/spotbugs-excludes.xml @SuppressFBWarnings(...) | -| FindSecBugs | SpotBugs plugin adding security bugs coverage | Fail build on violations | N/A | -| Checkstyle | Enforce coding standard | Fail build on violations | ci/checkstyle-suppressions.xml @SuppressWarnings("checkstyle:XXX") | -| PMD | Source code analyzer to finds common programming flaws | Fail build on violations | ci/pmd-rules.xml @SuppressWarnings("PMD.XXX") | -| JaCoCo | Test coverage | Fail build on coverage < 80% | pom.xml @ExcludeFromCodeCoverageGeneratedReport | -| Veracode | - Scan source code for vulnerabilities (SAST) - Scan dependencies for known vulnerabilities (SCA) - Check used licenses (FOSS Licenses) | | | -| Dependabot | Automated dependency updates built into GitHub. Provided pull requests on dependency updates. | Any dependency update generates a pull request automatically. | .github/dependabot.yml | -| CodeQl | Discover vulnerabilities across a codebase. | | .github/workflows/codeql.yml | - -## System scope and context - -The IRS acts as a middleware between consumers and manufacturers. This section describes the environment of IRS. Who are its users, and with which other systems does it interact with. - -## Business context - -![arc42_000](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_000.png) - -### Consumer - -The IRS API is being consumed by the dismantler dashboard and other parties which are part of the Catena-X network. They need to provide valid credentials issued by the Catena-X IAM. Additionally, they must provide a base global asset identifier to retrieve information for as well as configuration details for the view on that information. - -### Catena-X network - -The IRS retrieves data from the Catena-X network (using the necessary infrastructure, see Technical Context), aggregates it and provides it back to the consumers. This connection is mandatory. If the Catena-X services are unavailable, the IRS cannot perform any work. - -As of now, the IRS uses its own IAM credentials to gather the required data. This might be changed to use the consumer credentials in the future. - -## Technical context - -![arc42_001](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_001.png) - -### Component overview - -#### IRS-API - -We provide a REST API that can be consumed by any system registered in the Catena-X Keycloak, e.g. the Dismantler Dashboard. The development of such a consumer service is not part of the IRS application. Each system that acts as a client to the Restful application IRS can be used instead, if it supports any REST call of the designed REST endpoints in the REST Controller of the IRS application. For communication, the transport protocol HTTP(S) should be established. - -In order to consume the Restful application IRS, the security aspect should be taken in consideration. IRS is a Spring Boot based application and is secured with the OpenID connector provider Keycloak and the OAuth2. This means for the consumers (users) that they need to authenticate themselves in order to be authorized to get access to the IRS. They generate a bearer token that they get from Keycloak and attach it to the HTTP header parameter Authorization. Certainly, both a consumer and the IRS should use the same configured Keycloak Realm. - -#### Registry API - -The IRS acts as a consumer of the component Asset Administration Shell Registry. The IRS contains a Restful client (REST template) that build a REST call to the mentioned Digital Twin Registry API based on its known URL (the AAS registry URL is configured in the IRS Restful API). The request contains the given "globalAssetId" by the consumer. Like described in the above section, the security aspect is required in order to achieve a REST call against the AAS Registry. As a response, the IRS gets the corresponding asset administration shell descriptor. The last one contains a list of submodel descriptors which can be filtered by the aspect type entered by the consumer. An aspect type like AssemblyPartRelationship, SerialPartTypization etc. And as mentioned above, the transport protocol HTTP(S) is used for the REST call communication. - -#### EDC API - -The integrated EDC client in the IRS is responsible for creating restful requests to the component EDC. The IRS application builds from the retrieved AAS Descriptor (see previous section) the corresponding submodel endpoint URLs, negotiates an EDC contract and sends via the submodel REST client requests to the EDC. The EDC responds with the corresponding submodel data. - -## Solution strategy - -### Introduction - -| Quality goal | Matching approaches in the solution | -| --- | --- | -| application reliability | - only data source is the Catena-X network, data is fetched directly from the data owner - IRS can be hosted decentralized by every participant by being an open source reference implementation | -| base security measures | - API protection using OAuth2.0/OIDC - automatic static and dynamic code analysis tools as part of the pipeline | -| cloud agnostic solution | - IRS is provided as a Docker image - Helm charts assist in deploying the application in any Kubernetes environment | -| multiple async job orchestration | - Separate job executor decouples data requests from the job status API - Multiple jobs with multiple transfer requests each can be handled in parallel, depending on the deployment resources | -| running reference application | - Working application can be used as reference by anyone due to open source publishing | - -### Technology - -The IRS is developed using Java and the Spring Boot framework. This choice was made due to the technical knowledge of the team and the widespread support of the framework. - -Hosting the application is done using Docker and Kubernetes, which is widely used and vendor-independent regarding the hosting provider (e.g. AWS, Google Cloud, Azure, ...). - -Inter-service communication is done using HTTP REST. This is the standard method in the Catena-X landscape and makes the IRS API easy to use for any third party client. - -For persistence, blob storage was chosen as the payloads retrieved for each job vary for every aspect and the format can be unknown to the application, as it’s just being tunneled through to the client. - -### Structure - -The IRS consists of 4 main components: - -1. the REST API to view and control Jobs -2. the asynchronous job processing engine -3. the job and payload persistence -4. the AAS connector - -The REST API classes are separated from the application logic and can be replaced by a different interface easily. The actual entrypoint into the application logic are the *Service classes. - -The job processing engine handles execution of the data requests for each job. It uses the AAS connector to retrieve the data and stores it into the persistence. The actual implementation of the persistence is decoupled from the logical representation and can be replaced easily as well. - -## Building block view - -## Whitebox overall system - -The interfaces show how the components interact with each other and which interfaces the IRS is providing. - -### Component diagram - -![arc42_002](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_002.png) - -### Component description - -| Components | Description | -| --- | --- | -| IRSApiConsumer | Proxy for any consumer of the IRS api. | -| IRS | The IRS consumes relationship information across the CX-Network and builds the graph view. Within this Documentation, the focus lies on the IRS | -| AAS Proxy | The AAS Proxy is a System, which enables the consumer to simplify the communication with other CX Partners. | -| EDC Consumer | The EDC Consumer Component is there to fulfill the GAIA-X and IDSA-data sovereignty principles. The EDC Consumer consists out of a control plane and a data plane. | -| EDC Provider | The EDC Provider Component connects with EDC Consumer component and forms the end point for the actual exchange of data. It handles automatic contract negotiation and the subsequent exchange of data assets for connected applications. | -| Submodel Server | The Submodel Server offers endpoints for requesting the Submodel aspects. | -| IAM/DAPS | DAPS as central Identity Provider | - -## Level 1 - -### Component diagram - -![arc42_003](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_003.png) - -### Component description - -| Components | Description | -| --- | --- | -| **IRS** | The IRS builds a digital representation of a product (digital twin) and the relationships of items the product consists of in a hierarchical structure. The result is an item graph in which each node represents a digital item of the product - this graph is called "Item Graph". | -| **IRS API** | The **IRS API** is the Interface over which the Data Consumer is communicating. | -| **IrsController** | The **IrsController** provides an REST Interface for retrieving IRS processed data and job details of the current item graph retrieval process. | -| **IrsItemGraphQueryService** | The **IrsItemGraphQueryService** implements the REST Interface of the IrsController. | -| **JobOrchestrator** | The **JobOrchestrator** is a component which manages (start, end, cancel, resume) the jobs which execute the item graph retrieval process. | -| **RecursiveJobHandler** | The **RecursiveJobHandler** handles the job execution recursively until a given abort criteria is reached or the complete item graph is build. | -| **TransferProcessManager** | The TransferProcessManager handles the outgoing requests to the AASProxy. 1. Initiation of the job and preparation of the stream of **DataRequests** 2. **RecursiveJobHandler** requesting for AAS via the Digital Twin registry. 3. Analyzing the structure of the AAS response by collecting the AssemblyPartRelationship Aspects 4. Requesting for SubmodelEndpoints for given AssemblyPartRelationship children 5. Recursively iteration over step 2-4 until an abort criterion is reached. 6. Assembles the complete item graph | -| **BlobStore** | The BlobStore is the database where the relationships and tombstones are stored for a requested item. | -| **JobStore** | The JobStore is the database where the jobs with the information about the requested item are stored. | -| **AASProxy** | The AASProxy is the interface to the EDC Network. It provides an interface for the Asset Administration Shells and for the Submodels. | - -## Level 2 - -### IRS controller - -The IRS REST controller to provide a RESTful web service. - -#### Component diagram - -![arc42_004](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_004.png) - -#### Component description - -| Components | Description | -| --- | --- | -| IrsController | Application REST controller. | -| IrsItemGraphQueryService | Service for retrieving item graph. | -| JobOrchestrator | Orchestrator service for recursive MultiTransferJobs that potentially comprise multiple transfers. | -| JobStore | Spring configuration for job-related beans. | -| BlobstorePersistence | Interface for storing data blobs. | - -### RecursiveJobHandler - -The **RecursiveJobHandler** component provide the logic to build jobs with recursive logic to retrieve items over the complete C-X network and assembles the partial results into a single item graph result. - -#### Component diagram - -![arc42_005](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_005.png) - -#### Component description - -| Components | Description | -| --- | --- | -| AASRecursiveJobHandler | Recursive job handler for AAS data | -| TreeRecursiveLogic | Retrieves item graphs from potentially multiple calls to IRS API behind multiple EDC Providers, and assembles their outputs into one overall item graph. | -| ItemTreesAssembler | Assembles multiple partial item graphs into one overall item graph. | -| BlobPersistence | Interface for storing data blobs. | - -### TransferProcessManagment - -The TransferProcessManager creates executions and provides them to the executor service. Each execution contains HTTP requests to the asset administration shell registry and to the submodel interface. - -#### Component diagram - -![arc42_006](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_006.png) - -#### Component description - -| Components | Description | -| --- | --- | -| TransferProcessManager | The TransferProcessManager manages the requests to the EDC and DigitalTwinRegistry. | -| DigitalTwinRegistryFacade | The DigitalTwinRegistryFacade calls the DigitalTwinRegistry to retrieve data form the AAS registry and transforms the response to internal data models. | -| SubmodelFacade | The SubmodelFacade calls the EDC to retrieve data from the submodel server and transforms the response to internal data models. | -| BlobStore | The BlobStore is the database where the relationships and tombstones are stored for a requested item. | -| DigitalTwinRegistry | The DigitalTwinRegistry is the central database of registered assets. | -| ExecutorService | The ExecutorService enables the simultaneous execution of requests of transfer processes. | - -## IRS API - -### References - -The Swagger documentation can be found in the local deployment of the reference application. More information can be found in the GitHub repository: - -Since we cannot rely on synchronous responses regarding the requests of submodel endpoints, we designed the IRS in a way that it will handle the job management of requesting all needed endpoints in order to build a BoM tree. - -### IRS interaction diagram - -![arc42_007](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_007.png) - -## Runtime view - -This section covers the main processes of the IRS and explains how data is transfered and processed when a job is executed. - -## Overall - -This section describes the overall flow of the IRS - -![arc42_008](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_008.png) - -### Submodel - -This section describes how the IRS fetches submodel payload. - -![arc42_009](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_009.png) - -### Job orchestration flow - -This section describes the job orchestration in IRS. - -![arc42_010](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_010.png) - -## Scenario 1: Create job - -This section describes what happens when user creates a new job. - -![arc42_011](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_011.png) - -### Overview - -If a job is registered via the IRS API, it will be persisted (with its parameters) in the JobStore, where it can be retrieved by further calls and processes. -Then, the starting item ID is extracted, and a new transfer process is handed to the ExecutorService, which will process it asynchronously (see Scenario 2: Job Execution). - -In the meantime, the JobOrchestrator returns a response to the API caller, which contains the UUID of the new job. -This UUID can then be used by the caller to retrieve information about the job via the API. -The input provided by the caller determines how the job will operate (starting point, recursion depth, aspect filter, ...). - -## Scenario 2: Job execution - -This section describes how a job is asynchronously executed inside the IRS. - -![arc42_012](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_012.png) - -### Overview - -After a job has been created (see Scenario 1: Create Job), the first transfer containing the root item ID is passed to the ExecutorService. The transfer is then started asynchronously and retrieves the necessary information from the Catena-X network, first by fetching the AAS information from the DigitalTwin registry and then calling the SubmodelProviders for the submodel payload. - -At least the aspect AssemblyPartRelationship is required for the tree to be built. If the customer that started the job provided more aspects to be fetched, they will be retrieved here too. -The result of each transfer is stored in the BlobStore. - -After the transfer process has finished, any subsequent child IDs will be extracted and new transfer processes will be scheduled for those via the ExecutorService. This cycle repeats until all leafs were reached, the specified max depth has been reached, or the job was canceled externally. - -As soon as all transfers are finished, the results will be combined and stored in the BlobStore again. The job itself will be marked as completed. - -## Scenario 3: Request for JobResponse - -![arc42_013](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_013.png) - -### Overview - -When a user requests job details, the IRS looks up the jobId in the persistent job store. If the job exists, it will proceed to fetch the job details and prepare a response object. -Only if the job is in state "COMPLETED" or if the caller has set the parameter "includePartialResults" to true, the IRS will fetch the payload data for the job (relationships, AAS shells and submodels, if applicable) and attach it to the response object. - -This will then be passed to the caller. - -## Scenario 4: Cancel job execution - -![arc42_014](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_014.png) - -### Overview - -When a user wants to cancel a job execution, the IRS will lookup that job in the persistent job store and transition it to the CANCELED state, if it exists. If a job is canceled, no further requests to the Catena-X network will be performed. - -Afterwards, the IRS will return the updated job details of the canceled job to the user. - -## Deployment view - -The deployment view shows the IRS application on ArgoCD, which is a continuous delivery tool for Kubernetes. Kubernetes manifests are specified using Helm charts. Helm is a package manager for Kubernetes. IRS is developed in a cloud-agnostic manner, so the application could be installed in any cloud infrastructure (on-premises, hybrid, or public cloud infrastructure). - -![arc42_015](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_015.png) - -### Operator - -Manual preparation is required to initially set up the ArgoCD apps and the credentials in the HashiCorp Vault. This is done by the IRS system operator. - -### ArgoCD - -Argo CD is a declarative, GitOps continuous delivery tool for Kubernetes. See - -### Vault - -HashiCorp Vault stores credentials, which are picked up by ArgoCD to deploy them to the application. - -**⚠️ WARNING**\ -Every secret information needed at runtime must be stored here and must never be part of the IRS Helm charts - -### GitHub - -GitHub contains the application source code as well as the Helm charts used for deployment. -The IRS Helm charts can be found here: - -### GitHub Container Registry (GHCR) - -When the IRS is built by GitHub Action workflows, the final image is pushed to the GHCR, where it can be picked up for deployment. - -### Kubernetes - -The kubernetes cluster manages the underlying hardware that is used to run the applications defined in the Helm charts. - -### Local deployment - -For information on how to run the application locally, please check the README documentation in GitHub: - -### View Levels - -## Level 0 - Cluster overview - -### Isolated environment - -The isolated environment contains the IRS as well as all surrounding services. - -![arc42_016](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_016.png) - -### Development environment - -The development environment contains the IRS as well as the essential surrounding services, excluding the external IAM. - -![arc42_017](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_017.png) - -### Integrated environment - -The integrated environment contains the IRS and is integrated with the rest of the Catena-X network. - -![arc42_018](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_018.png) - -## Level 1 - IRS application - -This section focuses only on the IRS itself, detached from its neighbors. It shows the resources deployed in Kubernetes for the IRS. - -![arc42_019](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_019.png) - -### Pod - -This is the actual IRS Docker image which runs as a container. The ports are only available internally and can be opened up with the Service. - -### Secrets - -The secret information (e.g. connection credentials) is stored here and provided to the Pod at runtime. - -### Service - -The service resource opens up selected ports of the Pod so that other applications in the same cluster can access it or to be used by the Ingress. - -### Ingress - -The ingress uses a reverse proxy to provide specified Service ports to the internet under a specified URL. This make the IRS API publicly available. - -## Cross-cutting concepts - -## Domain concepts - -### Domain entity model - -![arc42_020](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_020.png) - -### Domain model - -![arc42_021](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_021.png) - -### API Model - -For detailed information about the API model, please refer to the [API specification](https://eclipse-tractusx.github.io/item-relationship-service/docs/api-specification/api-specification.html). - -### JobStatus - -A job can be in one of the following states: - -| State | Description | -| --- | --- | -| UNSAVED | The job was created, but not yet stored by the system. | -| INITIAL | The job was stored by the system and is now queued for processing. | -| IN_PROGRESS | The job is currently being processed. | -| TRANSFERS_FINISHED | All transfers for the job have been finished, and it is now being finalized. | -| COMPLETED | The job has completed. See the job response for details on the data. | -| ERROR | The job could not be processed correctly by the IRS due to a technical problem. | - -![arc42_022](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_022.png) - -### Job Store Datamodel - -![arc42_023](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_023.png) - -### Job Response Datamodel - -![arc42_024](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_024.png) - -```json -{ - "job": { - "jobID": "e5347c88-a921-11ec-b909-0242ac120002", - "globalAssetId": "6c311d29-5753-46d4-b32c-19b918ea93b0", - "jobStatus": "Finished", - "createdOn": "2022-02-03T14:48:54.709Z", - "startedOn" : "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "jobFinished": "2022-02-03T14:48:54.709Z", - "requestURL": "https://api.server.test/api/../", - "owner": "", - "summary": { - "asyncFetchedItems": { - "queued": 0, - "running": 0, - "complete": 0, - "failed": 0 - }}, - "queryParameter": { - "bomLifecycle" : "asBuilt", - "aspect" : ["SerialPartTypization", "Contact"], - "depth": 4, - "direction": "downward" - }, - "exception": { - "exception": "IrsTimeoutException", - "errorDetail": "Timeout while requesting Digital Registry.", - "exceptionDate" : "2022-02-03T14:48:54.709Z", - "statusCode" : "404" - } - }, - "relationships": [ - { - "catenaXId": "d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447", - "childItem": { - "quantity": { - "quantityNumber": 1, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece", - "lexicalValue": "piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "a45a2246-f6e1-42da-b47d-5c3b58ed62e9" - } - } - ], - "shells": [ - { - "description": [ - { - "language": "en", - "text": "The shell for a vehicle" - } - ], - "globalAssetId": { - "value": [ - "a45a2246-f6e1-42da-b47d-5c3b58ed62e9" - ] - }, - "idShort": "future concept x", - "identification": "882fc530-b69b-4707-95f6-5dbc5e9baaa8", - "specificAssetIds": [ - { - "key": "engineserialid", - "value": "12309481209312" - } - ], - "submodelDescriptors": [ - { - "description": [ - { - "language": "en", - "text": "Provides base vehicle information" - } - ], - "idShort": "vehicle base details", - "identification": "4a738a24-b7d8-4989-9cd6-387772f40565", - "semanticId": { - "value": [ - "urn:bamm:com.catenax.vehicle:0.1.1" - ] - }, - "endpoints": [ - { - "interface": "HTTP", - "protocolInformation": { - "endpointAddress": "https://catena-x.net/vehicle/basedetails/", - "endpointProtocol": "HTTPS", - "endpointProtocolVersion": "1.0" - } - } - ] - }, - { - "description": [ - { - "language": "en", - "text": "Provides base vehicle information" - } - ], - "idShort": "vehicle part details", - "identification": "dae4d249-6d66-4818-b576-bf52f3b9ae90", - "semanticId": { - "value": [ - "urn:bamm:com.catenax.vehicle:0.1.1#PartDetails" - ] - }, - "endpoints": [ - { - "interface": "HTTP", - "protocolInformation": { - "endpointAddress": "https://catena-x.net/vehicle/partdetails/", - "endpointProtocol": "HTTPS", - "endpointProtocolVersion": "1.0" - } - } - ] - } - ] - } - ] - } -@endjson -``` - -## Safety and security concepts - -### Authentication / Authorization - -#### IRS API - -The IRS is secured using OAuth2.0 / Open ID Connect. Every request to the IRS API requires a valid bearer token. -JWT token should also contain two fields: - -* 'view irs' role inside resource_access claim, -* bpn claim which is equal to the configuration value from 'API_ALLOWED_BPN' property - -#### IRS as DTR client - -The IRS acts as a client for the Digital Twin Registry (DTR), which is also secured using OAuth2.0 / Open ID Connect. The IRS uses client credentials to authenticate requests to the DTR. Due to this, the IRS account needs to have access to every item in the DTR, unrelated to the permissions of the account calling the IRS API. - -#### IRS as EDC client - -The IRS accesses the Catena-X network via the EDC consumer connector. This component requires authentication via a DAPS certificate, which was provided to the IRS via the network authority. - -The DAPS certificate identifies the IRS and is used to acquire access permissions for the data transferred via EDC. - -### Credentials - -Credentials must never be stored in Git! - -## Architecture and design patterns - -### Dependency inversion - -For the IRS, we utilize the dependency inversion mechanisms provided by Spring Boot as much as possible. - -The principle says: - -High-level modules should not import anything from low-level modules. Both should depend on abstractions (e.g., interfaces). -Abstractions should not depend on details. Details (concrete implementations) should depend on abstractions. - -Adhering to this, we define clear interfaces between the different domains (e.g. job orchestration and AAS communication) in the IRS and let dependencies be injected by the framework. This improves testability of the classes as well. - -### Hexagonal architecture - -The hexagonal architecture divides a system into several loosely-coupled interchangeable components, such as the application core, the database, the user interface, test scripts and interfaces with other systems. This approach is an alternative to the traditional layered architecture. - -For the IRS, this means decoupling the application logic from components like the BLOB store, the REST API controllers or the AAS client connection. With an interface between the parts (so-called port), it is easy to switch to other implementations, e.g. if you want to change the persistence implementation. No changes to the application logic will be necessary. - -![arc42_025](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_025.png) - -## "Under-the-hood" concepts - -### Persistency - -The IRS stores two types of data in a persistent way: - -* Job metadata -* Job payloads, e.g. AAS shells or submodel data - -All of this is data is stored in an object store. The currently used implementation is Minio (Amazon S3 compatible). -This reduces the complexity in storing and retrieving data. There also is no predefined model for the data, every document can be stored as it is. -The downside of this approach is lack of query functionality, as we can only search through the keys of the entries but not based on the value data. -In the future, another approach or an additional way to to index the data might be required. - -To let the data survive system restarts, Minio needs to use a persistent volume for the data storage. A default configuration for this is provided in the Helm charts. - -### Transaction handling - -There currently is no transaction management in the IRS. - -### Session handling - -There is no session handling in the IRS, access is solely based on bearer tokens, the API is stateless. - -### Communication and integration - -All interfaces to other systems are using RESTful calls over HTTP(S). Where central authentication is required, a common Keycloak instance is used. - -For outgoing calls, the Spring RestTemplate mechanism is used and separate RestTemplates are created for the different ways of authentication. - -For incoming calls, we utilize the Spring REST Controller mechanism, annotating the interfaces accordingly and also documenting the endpoints using OpenAPI annotations. - -### Exception and error handling - -There are two types of potential errors in the IRS: - -#### Technical errors - -Technical errors occur when there is a problem with the application itself, its configuration or directly connected infrastructure, e.g. the Minio persistence. Usually, the application cannot solve these problems by itself and requires some external support (manual work or automated recovery mechanisms, e.g. Kubernetes liveness probes). - -These errors are printed mainly to the application log and are relevant for the healthchecks. - -#### Functional errors - -Functional errors occur when there is a problem with the data that is being processed or external systems are unavailable and data cannot be sent / fetched as required for the process. While the system might not be able to provide the required function at that moment, it may work with a different dataset or as soon as the external systems recover. - -These errors are reported in the Job response and do not directly affect application health. - -#### Rules for exception handling - -##### Throw or log, don't do both - -When catching an exception, either log the exception and handle the problem or rethrow it, so it can be handled at a higher level of the code. By doing both, an exception might be written to the log multiple times, which can be confusing. - -##### Write own base exceptions for (internal) interfaces - -By defining a common (checked) base exception for an interface, the caller is forced to handle potential errors, but can keep the logic simple. On the other hand, you still have the possibility to derive various, meaningful exceptions for different error cases, which can then be thrown via the API. - -Of course, when using only RuntimeExceptions, this is not necessary - but those can be overlooked quite easily, so be careful there. - -##### Central fallback exception handler - -There will always be some exception that cannot be handled inside of the code correctly - or it may just have been unforeseen. A central fallback exception handler is required so all problems are visible in the log and the API always returns meaningful responses. In some cases, this is as simple as a HTTP 500. - -##### Dont expose too much exception details over API - -It’s good to inform the user, why their request did not work, but only if they can do something about it (HTTP 4xx). So in case of application problems, you should not expose details of the problem to the caller. This way, we avoid opening potential attack vectors. - -### Parallelization and threading - -The heart of the IRS is the parallel execution of planned jobs. As almost each job requires multiple calls to various endpoints, those are done in parallel as well to reduce the total execution time for each job. - -Tasks execution is orchestrated by the JobOrchestrator class. It utilizes a cental ExecutorService, which manages the number of threads and schedules new Task as they come in. - -### Plausibility checks and validation - -Data validation happens at two points: - -* IRS API: the data sent by the client is validated to match the model defined in the IRS. If the validation fails, the IRS sends a HTTP 400 response and indicates the problem to the caller. -* Submodel payload: each time a submodel payload is requested from via EDC, the data is validated against the model defined in the SemanticHub for the matching aspect type. - -### Caching - -The IRS caches data provided externally to avoid unnecessary requests and reduce execution time. - -Caching is implemented for the following services: - -#### BPDM - -Whenever a BPN is resolved via BPDM, the partner name is cached on IRS side, as this data does not change. - -#### Semantics Hub - -Whenever a semantic model schema is requested from the Semantic Hub, it is stored locally until the cache is evicted (configurable). The IRS can preload configured schema models on startup to reduce on demand call times. - -Additionally, models can be deployed with the system as a backup to the real Semantic Hub service. - -## Development concepts - -### Build, test, deploy - -The IRS is built using Maven and utilizes all the standard concepts of it. Test execution is part of the build process and a minimum test coverage of 80% is enforced. - -The project setup contains a multi-module Maven build. Commonly used classes (like the IRS data model) should be extracted into a separate submodule and reused across the project. However, this is not a "one-size-fits-all" solution. New submodules should be created with care and require a review by the team. - -The Maven build alone only leads up to the JAR artifact of the IRS. Do create Docker images, the Docker build feature is used. This copies all resources into a builder image, builds the software and creates a final Docker image at the end that can then be deployed. - -Although the Docker image can be deployed in various ways, the standard solution are the provided Helm charts, which describe the required components as well. - -### Code generation - -There are two methods of code generation in the IRS: - -#### Lombok - -The Lombok library is heavily used to generate boilerplate code (like Constructors, Getters, Setters, Builders...). -This way, code can be written faster and this boilerplate code is excluded from test coverage, which keeps the test base lean. - -#### Swagger / OpenAPI - -The API uses OpenAPI annotations to describe the endpoints with all necessary information. The annotations are then used to automatically generate the OpenAPI specification file, which can be viewed in the Swagger UI that is deployed with the application. - -The generated OpenAPI specification file is automatically compared to a fixed, stored version of it to avoid unwanted changes of the API. - -### Migration - -There currently is no data migration mechanism for the IRS. -In case the model of the persisted data (Jobs) changes, data is dropped and Jobs will need to be recreated. - -### Configurability - -The IRS utilizes the configuration mechanism provided by Spring Boot. Configuration properties can be defined in the file `src/main/resources/application.yml` - -For local testing purposes, there is an additional configuration file called `application-local.yml`. Values can be overriden there to support the local dev environment. - -Other profiles should be avoided. Instead, any value that might need to change in a runtime environment must be overridable using environment variables. The operator must have total control over the configuration of the IRS. - -## Operational concepts - -### Administration - -#### Configuration - -The IRS can be configured using two mechanisms: - -##### application.yml - -If you build the IRS yourself, you can modify the application.yml config that is shipped with the IRS. This file contains all possible config entries for the application. -Once the Docker image has been built, these values can only be overwritten using the Spring external config mechanism (see e.g. by mounting a config file in the right path or using environment variables. - -##### Helm Chart - -The most relevant config properties are exposed as environment variables and must be set in the Helm chart so the application can run at all. Check the IRS Helm chart in Git for all available variables. - -### Disaster-Recovery - -#### Ephemeral components - -All components in the IRS deployment not listed in the persistent components section below are considered ephemeral and are easily replaced in a disaster scenario. -All deployment components are described using Helm charts, which can be used to restore the deployment with the Docker images. -Should the Docker images go missing, they can be restored by executing the build pipelines for the corresponding version tag of the component. - -#### Persistent components - -These components utilize data persistence, which needs to be backed up separately by the operator. - -* **Minio persistent volume**: Contains the stored Job information. In case of data loss, Jobs can be started again to retrieve the data from the network. -* **Prometheus persistent volume**: Contains the monitoring data of the IRS. In case of data loss, no analysis can be done for past timeframes. -* **Vault secrets**: In case of data loss, the credentials stored in the Vault need to be recreated manually. See the deployment view for an overview. - -### Scaling - -If the number of consumers raises, the IRS can be scaled up by using more resources for the Deployment Pod. Those resources can be used to utilize more parallel threads to handle Job execution. - -### Clustering - -The IRS can run in clustered mode, as each running job is only present in one pod at a time. -Note: as soon as a resume feature is implemented, this needs to be addressed here. - -### Logging - -Logs are being written directly to stdout and are picked up by the cluster management. - -### Monitoring - -The application can be monitored using Prometheus and Grafana. Both systems are defined in the Helm charts with a default setup. -A number of Grafana dashboards are deployed automatically, to display data about: - -* Pod / JVM resources -* API metrics -* Functional information about IRS Jobs - -## Quality requirements - -The quality scenarios in this section depict the fundamental quality goals as well as other required quality properties. They allow the evaluation of decision alternatives. - -* **Quality attribute**: A characteristic of software, or a generic term applying to quality factors, quality subfactors, or metric values. -* **Quality factor**: A management-oriented attribute of software that contributes to its quality. -* **Quality subfactor**: A decomposition of a quality factor or quality subfactor to its technical components. -* **Metric value**: A metric output or an element that is from the range of a metric. -* **Software quality metric**: A function whose inputs are software data and whose output is a single numerical value that can be interpreted as the degree to which software possesses a given attribute that affects its quality. - -**Source**: IEEE standard 1061 "Standard for a Software Quality Metrics Methodology" - -### List of requirements - -This section will be filled soon. - -## Glossary - -| Term | Description | -| --- | --- | -| AAS | Asset Administration Shell (Industry 4.0) | -| Aspect servers (submodel endpoints) | Companies participating in the interorganizational data exchange provides their data over aspect servers. The so called "submodel-descriptors" in the AAS shells are pointing to these AspectServers which provide the data-assets of the participating these companies in Catena-X. | -| BoM | Bill of Materials | -| Edge | see Traversal Aspect | -| IRS | Item Relationship Service | -| Item Graph | The result returned via the IRS. This corresponds to a tree structure in which each node represents a part of a virtual asset. | -| MTPDC | Formerly known Service Name: Multi Tier Parts Data Chain | -| PRS | Formerly known Service Name: Parts Relationship Name | -| Traversal Aspect | aka Edge: Aspect which the IRS uses for traversal through the data chain. Identified by a parent-child or a child-parent relationship. Samples: SingleLevelBomAsPlanned, AssemblyPartRelationship and SingleLevelUsageAsBuilt | diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/cancel-batch-order.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/cancel-batch-order.api.mdx deleted file mode 100644 index 690c82f726f..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/cancel-batch-order.api.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: cancel-batch-order -title: "Cancel a batch order for a given orderId." -description: "Cancel a batch order for a given orderId." -sidebar_label: "Cancel a batch order for a given orderId." -hide_title: true -hide_table_of_contents: true -api: {"description":"Cancel a batch order for a given orderId.","operationId":"cancelBatchOrder","parameters":[{"description":"Id of the order.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"orderId","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"batchChecksum":1,"batches":[{"batchId":"f253718e-a270-4367-901b-9d50d9bd8462","batchNumber":1,"batchProcessingState":"PARTIAL","batchUrl":"https://../irs/orders/f253718e-a270-4367-901b-9d50d9bd8462/batches/f253718e-a270-4367-901b-9d50d9bd8462","jobsInBatchChecksum":1}],"orderId":"f253718e-a270-4367-901b-9d50d9bd8462","state":"COMPLETED"}}},"schema":{"type":"object","additionalProperties":false,"description":"BatchOrderAck Payload Response.","properties":{"batchChecksum":{"type":"integer","format":"int32","description":"Expected number of batches in order."},"batches":{"type":"array","description":"Array of batches.","items":{"type":"object","additionalProperties":false,"description":"Batch model.","properties":{"batchId":{"type":"string","format":"uuid","description":"Id of the batch.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"batchNumber":{"type":"integer","format":"int32","description":"Sequential number begins with first (1.) batch."},"batchProcessingState":{"type":"string","description":"The state of the batch.","enum":["INITIALIZED","COMPLETED","PROCESSING","PARTIAL","ERROR"]},"batchTotal":{"type":"integer","format":"int32","description":"The total number of batches."},"completedOn":{"type":"string","format":"date-time"},"jobs":{"type":"array","description":"Array of jobs.","items":{"type":"object","additionalProperties":false,"properties":{"completedOn":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]}}},"maxItems":2147483647},"jobsInBatchChecksum":{"type":"integer","format":"int32","description":"Expected number of jobs in batch."},"orderId":{"type":"string","format":"uuid","description":"Id of the order.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"startedOn":{"type":"string","format":"date-time"},"totalJobs":{"type":"integer","format":"int32","description":"Total amount of jobs inside the order."}}},"maxItems":2147483647},"orderId":{"type":"string","format":"uuid","description":"Id of the order.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"state":{"type":"string","description":"The state of the order.","enum":["INITIALIZED","COMPLETED","PROCESSING","PARTIAL","ERROR"]}}}}},"description":"Cancel a batch order for a given orderId."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return Batch Order failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Batch Order with the requested orderId not found."}},"security":[{"oAuth2":["profile email"]}],"tags":["Item Relationship Service"],"method":"put","path":"/irs/orders/{orderId}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Cancel a batch order for a given orderId.","description":{"content":"Cancel a batch order for a given orderId.","type":"text/plain"},"url":{"path":["irs","orders",":orderId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the order.","type":"text/plain"},"type":"any","value":"","key":"orderId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Cancel a batch order for a given orderId. - - - -Cancel a batch order for a given orderId. - -
Path Parameters
- -Cancel a batch order for a given orderId. - -
Schema
    batches object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Array of batches. - -
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    jobs object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Array of jobs. - -
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
- -Return Batch Order failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- -Batch Order with the requested orderId not found. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/cancel-job-by-job-id.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/cancel-job-by-job-id.api.mdx deleted file mode 100644 index 61208afcc46..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/cancel-job-by-job-id.api.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: cancel-job-by-job-id -title: "Cancel job for requested jobId." -description: "Cancel job for requested jobId." -sidebar_label: "Cancel job for requested jobId." -hide_title: true -hide_table_of_contents: true -api: {"description":"Cancel job for requested jobId.","operationId":"cancelJobByJobId","parameters":[{"description":"Id of the job.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"completedOn":"2022-02-03T14:48:54.709Z","globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","id":"6c311d29-5753-46d4-b32c-19b918ea93b0","lastModifiedOn":"2022-02-03T14:48:54.709Z","startedOn":"2022-02-03T14:48:54.709Z","state":"CANCELED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Executable unit with meta information and item graph result.","properties":{"completedOn":{"type":"string","format":"date-time"},"createdOn":{"type":"string","format":"date-time"},"exception":{"type":"object","additionalProperties":false,"description":"Job error details.","properties":{"errorDetail":{"type":"string","description":"Detailed exception information.","maxLength":4000},"exception":{"type":"string","description":"Exception name.","maxLength":100},"exceptionDate":{"type":"string","format":"date-time","description":"Datetime error occurs."}}},"globalAssetId":{"type":"string","description":"Part global unique id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"id":{"type":"string","format":"uuid","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"lastModifiedOn":{"type":"string","format":"date-time"},"owner":{"type":"string","description":"The IRS api consumer."},"parameter":{"type":"object","additionalProperties":false,"description":"Job parameter of job processing.","properties":{"aspects":{"type":"string"},"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"callbackUrl":{"type":"string"},"collectAspects":{"type":"boolean"},"depth":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0},"direction":{"type":"string","description":"Item graph traversal direction.","enum":["upward","downward"]},"lookupBPNs":{"type":"boolean"}}},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]},"summary":{"type":"object","additionalProperties":false,"description":"Summary of the job with statistics of the job processing.","properties":{"asyncFetchedItems":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}},"bpnLookups":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}}}}},"required":["globalAssetId","id","state"]}}},"description":"Job with requested jobId canceled."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Cancel job failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Job for requested jobId not found."}},"security":[{"oAuth2":["profile email"]}],"tags":["Item Relationship Service"],"method":"put","path":"/irs/jobs/{id}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Cancel job for requested jobId.","description":{"content":"Cancel job for requested jobId.","type":"text/plain"},"url":{"path":["irs","jobs",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the job.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Cancel job for requested jobId. - - - -Cancel job for requested jobId. - -
Path Parameters
- -Job with requested jobId canceled. - -
Schema
    exception object
    - -Job error details. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>= 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    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
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-all-aspect-models.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-all-aspect-models.api.mdx deleted file mode 100644 index ef29eea466c..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-all-aspect-models.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-all-aspect-models -title: "Get all available aspect models from semantic hub or local models." -description: "Get all available aspect models from semantic hub or local models." -sidebar_label: "Get all available aspect models from semantic hub or local models." -hide_title: true -hide_table_of_contents: true -api: {"description":"Get all available aspect models from semantic hub or local models.","operationId":"getAllAspectModels","responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"lastUpdated":"2023-02-13T08:18:11.990659500Z","models":[{"urn":"urn:bamm:io.catenax.assembly_part_relationship:1.1.1#AssemblyPartRelationship","name":"AssemblyPartRelationship","status":"RELEASED","type":"BAMM","version":"1.1.1"},{"urn":"urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization","name":"SerialPartTypization","status":"RELEASED","type":"BAMM","version":"1.1.0"}]}}},"schema":{"type":"object","additionalProperties":false,"properties":{"lastUpdated":{"type":"string"},"models":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"urn":{"type":"string"},"version":{"type":"string"}}}}}}}},"description":"Returns all available aspect models."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":["profile email"]}],"tags":["Aspect Models"],"method":"get","path":"/irs/aspectmodels","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Get all available aspect models from semantic hub or local models.","description":{"content":"Get all available aspect models from semantic hub or local models.","type":"text/plain"},"url":{"path":["irs","aspectmodels"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get all available aspect models from semantic hub or local models. - - - -Get all available aspect models from semantic hub or local models. - -
- -Returns all available aspect models. - -
Schema
    models object[]
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-batch-order.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-batch-order.api.mdx deleted file mode 100644 index dce10243886..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-batch-order.api.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: get-batch-order -title: "Get a batch order for a given orderId." -description: "Get a batch order for a given orderId." -sidebar_label: "Get a batch order for a given orderId." -hide_title: true -hide_table_of_contents: true -api: {"description":"Get a batch order for a given orderId.","operationId":"getBatchOrder","parameters":[{"description":"Id of the order.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"orderId","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"batchChecksum":1,"batches":[{"batchId":"f253718e-a270-4367-901b-9d50d9bd8462","batchNumber":1,"batchProcessingState":"PARTIAL","batchUrl":"https://../irs/orders/f253718e-a270-4367-901b-9d50d9bd8462/batches/f253718e-a270-4367-901b-9d50d9bd8462","jobsInBatchChecksum":1}],"orderId":"f253718e-a270-4367-901b-9d50d9bd8462","state":"COMPLETED"}}},"schema":{"type":"object","additionalProperties":false,"description":"BatchOrderAck Payload Response.","properties":{"batchChecksum":{"type":"integer","format":"int32","description":"Expected number of batches in order."},"batches":{"type":"array","description":"Array of batches.","items":{"type":"object","additionalProperties":false,"description":"Batch model.","properties":{"batchId":{"type":"string","format":"uuid","description":"Id of the batch.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"batchNumber":{"type":"integer","format":"int32","description":"Sequential number begins with first (1.) batch."},"batchProcessingState":{"type":"string","description":"The state of the batch.","enum":["INITIALIZED","COMPLETED","PROCESSING","PARTIAL","ERROR"]},"batchTotal":{"type":"integer","format":"int32","description":"The total number of batches."},"completedOn":{"type":"string","format":"date-time"},"jobs":{"type":"array","description":"Array of jobs.","items":{"type":"object","additionalProperties":false,"properties":{"completedOn":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]}}},"maxItems":2147483647},"jobsInBatchChecksum":{"type":"integer","format":"int32","description":"Expected number of jobs in batch."},"orderId":{"type":"string","format":"uuid","description":"Id of the order.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"startedOn":{"type":"string","format":"date-time"},"totalJobs":{"type":"integer","format":"int32","description":"Total amount of jobs inside the order."}}},"maxItems":2147483647},"orderId":{"type":"string","format":"uuid","description":"Id of the order.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"state":{"type":"string","description":"The state of the order.","enum":["INITIALIZED","COMPLETED","PROCESSING","PARTIAL","ERROR"]}}}}},"description":"Get a batch order for a given orderId."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return Batch Order failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Batch Order with the requested orderId not found."}},"security":[{"oAuth2":["profile email"]}],"tags":["Item Relationship Service"],"method":"get","path":"/irs/orders/{orderId}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Get a batch order for a given orderId.","description":{"content":"Get a batch order for a given orderId.","type":"text/plain"},"url":{"path":["irs","orders",":orderId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the order.","type":"text/plain"},"type":"any","value":"","key":"orderId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get a batch order for a given orderId. - - - -Get a batch order for a given orderId. - -
Path Parameters
- -Get a batch order for a given orderId. - -
Schema
    batches object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Array of batches. - -
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    jobs object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Array of jobs. - -
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
- -Return Batch Order failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- -Batch Order with the requested orderId not found. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-batch.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-batch.api.mdx deleted file mode 100644 index 0b56af79336..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-batch.api.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: get-batch -title: "Get a batch with a given batchId for a given orderId." -description: "Get a batch with a given batchId for a given orderId." -sidebar_label: "Get a batch with a given batchId for a given orderId." -hide_title: true -hide_table_of_contents: true -api: {"description":"Get a batch with a given batchId for a given orderId.","operationId":"getBatch","parameters":[{"description":"Id of the order.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"orderId","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}},{"description":"Id of the batch.","example":"4bce40b8-64c7-41bf-9ca3-e9432c7fef98","in":"path","name":"batchId","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"batchId":"f253718e-a270-4367-901b-9d50d9bd8462","batchNumber":1,"batchProcessingState":"COMPLETED","batchTotal":1,"completedOn":"2022-02-03T14:48:54.709Z","jobs":[{"completedOn":"2022-02-03T14:48:54.709Z","id":"6c311d29-5753-46d4-b32c-19b918ea93b0","startedOn":"2022-02-03T14:48:54.709Z","state":"COMPLETED"}],"jobsInBatchChecksum":1,"orderId":"f253718e-a270-4367-901b-9d50d9bd8462","startedOn":"2022-02-03T14:48:54.709Z","totalJobs":1}}},"schema":{"type":"object","additionalProperties":false,"description":"Batch model.","properties":{"batchId":{"type":"string","format":"uuid","description":"Id of the batch.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"batchNumber":{"type":"integer","format":"int32","description":"Sequential number begins with first (1.) batch."},"batchProcessingState":{"type":"string","description":"The state of the batch.","enum":["INITIALIZED","COMPLETED","PROCESSING","PARTIAL","ERROR"]},"batchTotal":{"type":"integer","format":"int32","description":"The total number of batches."},"completedOn":{"type":"string","format":"date-time"},"jobs":{"type":"array","description":"Array of jobs.","items":{"type":"object","additionalProperties":false,"properties":{"completedOn":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]}}},"maxItems":2147483647},"jobsInBatchChecksum":{"type":"integer","format":"int32","description":"Expected number of jobs in batch."},"orderId":{"type":"string","format":"uuid","description":"Id of the order.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"startedOn":{"type":"string","format":"date-time"},"totalJobs":{"type":"integer","format":"int32","description":"Total amount of jobs inside the order."}}}}},"description":"Get a batch with a given batchId for a given orderId."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return batch failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Batch with the requested orderId and batchId not found."}},"security":[{"oAuth2":["profile email"]}],"tags":["Item Relationship Service"],"method":"get","path":"/irs/orders/{orderId}/batches/{batchId}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Get a batch with a given batchId for a given orderId.","description":{"content":"Get a batch with a given batchId for a given orderId.","type":"text/plain"},"url":{"path":["irs","orders",":orderId","batches",":batchId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the order.","type":"text/plain"},"type":"any","value":"","key":"orderId"},{"disabled":false,"description":{"content":"(Required) Id of the batch.","type":"text/plain"},"type":"any","value":"","key":"batchId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get a batch with a given batchId for a given orderId. - - - -Get a batch with a given batchId for a given orderId. - -
Path Parameters
- -Get a batch with a given batchId for a given orderId. - -
Schema
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    jobs object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Array of jobs. - -
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
- -Return batch failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- -Batch with the requested orderId and batchId not found. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-bpn-investigation.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-bpn-investigation.api.mdx deleted file mode 100644 index 04a84ee20fb..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-bpn-investigation.api.mdx +++ /dev/null @@ -1,142 +0,0 @@ ---- -id: get-bpn-investigation -title: "Return job with additional supplyChainImpacted information." -description: "Return job with additional supplyChainImpacted information." -sidebar_label: "Return job with additional supplyChainImpacted information." -hide_title: true -hide_table_of_contents: true -api: {"description":"Return job with additional supplyChainImpacted information.","operationId":"getBPNInvestigation","parameters":[{"description":"Id of the job.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"bpns":[{"manufacturerId":"BPNL00000003AYRE","manufacturerName":"OEM A"}],"job":{"completedOn":"2022-02-03T14:48:54.709Z","createdOn":"2022-02-03T14:48:54.709Z","exception":{"errorDetail":"Timeout while requesting Digital Registry","exception":"IrsTimeoutException","exceptionDate":"2022-02-03T14:48:54.709Z"},"globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","id":"e5347c88-a921-11ec-b909-0242ac120002","lastModifiedOn":"2022-02-03T14:48:54.709Z","owner":"","parameter":{"aspects":["SerialPartTypization","AddressAspect"],"bomLifecycle":"asBuilt","collectAspects":false,"depth":1,"direction":"downward","lookupBPNs":false},"startedOn":"2022-02-03T14:48:54.709Z","state":"COMPLETED","summary":{"asyncFetchedItems":{"completed":0,"failed":0,"running":0}}},"relationships":[{"catenaXId":"urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447","linkedItem":{"assembledOn":"2022-02-03T14:48:54.709Z","childCatenaXId":"urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9","lastModifiedOn":"2022-02-03T14:48:54.709Z","lifecycleContext":"asBuilt","quantity":{"measurementUnit":{"datatypeURI":"urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece","lexicalValue":"piece"},"quantityNumber":1}}}],"shells":[{"description":[{"language":"en","text":"The shell for a vehicle"}],"globalAssetId":{"value":["urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9"]},"idShort":"future concept x","identification":"882fc530-b69b-4707-95f6-5dbc5e9baaa8","specificAssetIds":[{"key":"engineserialid","value":"12309481209312"}],"submodelDescriptors":[{"description":[{"language":"en","text":"Provides base vehicle information"}],"endpoints":[{"interface":"HTTP","protocolInformation":{"endpointAddress":"https://catena-x.net/vehicle/basedetails/","endpointProtocol":"HTTPS","endpointProtocolVersion":"1.0"}}],"idShort":"vehicle base details","identification":"4a738a24-b7d8-4989-9cd6-387772f40565","semanticId":{"value":["urn:bamm:com.catenax.vehicle:0.1.1"]}},{"description":[{"language":"en","text":"Provides base vehicle information"}],"endpoints":[{"interface":"HTTP","protocolInformation":{"endpointAddress":"https://catena-x.net/vehicle/partdetails/","endpointProtocol":"HTTPS","endpointProtocolVersion":"1.0"}}],"idShort":"vehicle part details","identification":"dae4d249-6d66-4818-b576-bf52f3b9ae90","semanticId":{"value":["urn:bamm:com.catenax.vehicle:0.1.1#PartDetails"]}}]}],"submodels":[{"aspectType":"urn:bamm:io.catenax.assembly_part_relationship:1.0.0","identification":"urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff","payload":{"catenaXId":"urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447","childParts":[{"createdOn":"2022-02-03T14:48:54.709Z","childCatenaXId":"urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447","lastModifiedOn":"2022-02-03T14:48:54.709Z","lifecycleContext":"AsBuilt","quantity":{"measurementUnit":{"datatypeURI":"urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece","lexicalValue":"piece"},"quantityNumber":1}}]}}],"tombstones":[{"catenaXId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","endpointURL":"https://catena-x.net/vehicle/partdetails/","processingError":{"errorDetail":"Details to reason of Failure","lastAttempt":"2022-02-03T14:48:54.709Z","processStep":"SchemaValidation","retryCounter":0}}]}}},"schema":{"type":"object","additionalProperties":false,"description":"Container for a job with item graph.","properties":{"bpns":{"type":"array","description":"Collection of bpn mappings","items":{"type":"object","additionalProperties":false,"description":"Business partner id with name","properties":{"manufacturerId":{"type":"string"},"manufacturerName":{"type":"string"}}},"maxItems":2147483647,"uniqueItems":true},"job":{"type":"object","additionalProperties":false,"description":"Executable unit with meta information and item graph result.","properties":{"completedOn":{"type":"string","format":"date-time"},"createdOn":{"type":"string","format":"date-time"},"exception":{"type":"object","additionalProperties":false,"description":"Job error details.","properties":{"errorDetail":{"type":"string","description":"Detailed exception information.","maxLength":4000},"exception":{"type":"string","description":"Exception name.","maxLength":100},"exceptionDate":{"type":"string","format":"date-time","description":"Datetime error occurs."}}},"globalAssetId":{"type":"string","description":"Part global unique id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"id":{"type":"string","format":"uuid","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"lastModifiedOn":{"type":"string","format":"date-time"},"owner":{"type":"string","description":"The IRS api consumer."},"parameter":{"type":"object","additionalProperties":false,"description":"Job parameter of job processing.","properties":{"aspects":{"type":"string"},"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"callbackUrl":{"type":"string"},"collectAspects":{"type":"boolean"},"depth":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0},"direction":{"type":"string","description":"Item graph traversal direction.","enum":["upward","downward"]},"lookupBPNs":{"type":"boolean"}}},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]},"summary":{"type":"object","additionalProperties":false,"description":"Summary of the job with statistics of the job processing.","properties":{"asyncFetchedItems":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}},"bpnLookups":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}}}}},"required":["globalAssetId","id","state"]},"relationships":{"type":"array","description":"Relationships between parent and child items.","items":{"type":"object","additionalProperties":false,"description":"Relationships between parent and child items.","properties":{"aspectType":{"type":"string"},"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"linkedItem":{"type":"object","additionalProperties":false,"description":"Set of child parts the parent object is assembled by (one structural level down).","properties":{"assembledOn":{"type":"string","format":"date-time","description":"Datetime of assembly."},"childCatenaXId":{"type":"string","description":"CatenaX child global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"lastModifiedOn":{"type":"string","format":"date-time","description":"Last datetime item was modified."},"lifecycleContext":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"quantity":{"type":"object","additionalProperties":false,"description":"Quantity component.","properties":{"measurementUnit":{"type":"object","additionalProperties":false,"properties":{"datatypeURI":{"type":"string"},"lexicalValue":{"type":"string"}}},"quantityNumber":{"type":"number","format":"double","maximum":2147483647,"minimum":0}}}}}}},"maxItems":2147483647},"shells":{"type":"array","description":"AAS shells.","items":{"type":"object","additionalProperties":false,"description":"AAS shells.","properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string"},"text":{"type":"string"}}},"maxItems":2147483647},"globalAssetId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"idShort":{"type":"string"},"identification":{"type":"string"},"specificAssetIds":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"subjectId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"value":{"type":"string"}}},"maxItems":2147483647},"submodelDescriptors":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string"},"text":{"type":"string"}}},"maxItems":2147483647},"endpoints":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"interface":{"type":"string"},"protocolInformation":{"type":"object","additionalProperties":false,"properties":{"endpointAddress":{"type":"string"},"endpointProtocol":{"type":"string"},"endpointProtocolVersion":{"type":"string"},"subprotocol":{"type":"string"},"subprotocolBody":{"type":"string"},"subprotocolBodyEncoding":{"type":"string"}}}}},"maxItems":2147483647},"idShort":{"type":"string"},"identification":{"type":"string"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}}}},"maxItems":2147483647}}},"maxItems":2147483647},"submodels":{"type":"array","description":"Collection of requested Submodels","items":{"type":"object","additionalProperties":false,"description":"Submodel with identification of SubmodelDescriptor, aspect type and payload as String","properties":{"aspectType":{"type":"string"},"identification":{"type":"string"},"payload":{"type":"object","additionalProperties":{"type":"object"}}}},"maxItems":2147483647},"tombstones":{"type":"array","description":"Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL.","items":{"type":"object","additionalProperties":false,"description":"Tombstone with information about request failure","properties":{"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"endpointURL":{"type":"string"},"processingError":{"type":"object","additionalProperties":false,"properties":{"errorDetail":{"type":"string"},"lastAttempt":{"type":"string","format":"date-time"},"processStep":{"type":"string","enum":["SubmodelRequest","DigitalTwinRequest","SchemaValidation","SchemaRequest","BpdmRequest","BpdmValidation","UsagePolicyValidation"]},"retryCounter":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0}}}}},"maxItems":2147483647}}}}},"description":"Return job with item graph for the requested id."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return job failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Job with the requested jobId not found."}},"security":[{"oAuth2":["profile email"]}],"tags":["Environmental- and Social Standards"],"method":"get","path":"/ess/bpn/investigations/{id}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Return job with additional supplyChainImpacted information.","description":{"content":"Return job with additional supplyChainImpacted information.","type":"text/plain"},"url":{"path":["ess","bpn","investigations",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the job.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Return job with additional supplyChainImpacted information. - - - -Return job with additional supplyChainImpacted information. - -
Path Parameters
- -Return job with item graph for the requested id. - -
Schema
    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. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>= 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    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. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    linkedItem object
    - -Set of child parts the parent object is assembled by (one structural level down). - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    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
  • property name* object
    • tombstones object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    processingError object
- -Return job failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- -Job with the requested jobId not found. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-job-for-job-id.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-job-for-job-id.api.mdx deleted file mode 100644 index 39db9ce2f3d..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-job-for-job-id.api.mdx +++ /dev/null @@ -1,238 +0,0 @@ ---- -id: get-job-for-job-id -title: "Return job with optional item graph result for requested id." -description: "Return job with optional item graph result for requested id." -sidebar_label: "Return job with optional item graph result for requested id." -hide_title: true -hide_table_of_contents: true -api: {"description":"Return job with optional item graph result for requested id.","operationId":"getJobForJobId","parameters":[{"description":"Id of the job.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}},{"description":" Return job with current processed item graph. Return job with item graph if job is in state , otherwise job.","in":"query","name":"returnUncompletedJob","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"bpns":[{"manufacturerId":"BPNL00000003AYRE","manufacturerName":"OEM A"}],"job":{"completedOn":"2022-02-03T14:48:54.709Z","createdOn":"2022-02-03T14:48:54.709Z","exception":{"errorDetail":"Timeout while requesting Digital Registry","exception":"IrsTimeoutException","exceptionDate":"2022-02-03T14:48:54.709Z"},"globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","id":"e5347c88-a921-11ec-b909-0242ac120002","lastModifiedOn":"2022-02-03T14:48:54.709Z","owner":"","parameter":{"aspects":["SerialPartTypization","AddressAspect"],"bomLifecycle":"asBuilt","collectAspects":false,"depth":1,"direction":"downward","lookupBPNs":false},"startedOn":"2022-02-03T14:48:54.709Z","state":"COMPLETED","summary":{"asyncFetchedItems":{"completed":0,"failed":0,"running":0}}},"relationships":[{"catenaXId":"urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447","linkedItem":{"assembledOn":"2022-02-03T14:48:54.709Z","childCatenaXId":"urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9","lastModifiedOn":"2022-02-03T14:48:54.709Z","lifecycleContext":"asBuilt","quantity":{"measurementUnit":{"datatypeURI":"urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece","lexicalValue":"piece"},"quantityNumber":1}}}],"shells":[{"description":[{"language":"en","text":"The shell for a vehicle"}],"globalAssetId":{"value":["urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9"]},"idShort":"future concept x","identification":"882fc530-b69b-4707-95f6-5dbc5e9baaa8","specificAssetIds":[{"key":"engineserialid","value":"12309481209312"}],"submodelDescriptors":[{"description":[{"language":"en","text":"Provides base vehicle information"}],"endpoints":[{"interface":"HTTP","protocolInformation":{"endpointAddress":"https://catena-x.net/vehicle/basedetails/","endpointProtocol":"HTTPS","endpointProtocolVersion":"1.0"}}],"idShort":"vehicle base details","identification":"4a738a24-b7d8-4989-9cd6-387772f40565","semanticId":{"value":["urn:bamm:com.catenax.vehicle:0.1.1"]}},{"description":[{"language":"en","text":"Provides base vehicle information"}],"endpoints":[{"interface":"HTTP","protocolInformation":{"endpointAddress":"https://catena-x.net/vehicle/partdetails/","endpointProtocol":"HTTPS","endpointProtocolVersion":"1.0"}}],"idShort":"vehicle part details","identification":"dae4d249-6d66-4818-b576-bf52f3b9ae90","semanticId":{"value":["urn:bamm:com.catenax.vehicle:0.1.1#PartDetails"]}}]}],"submodels":[{"aspectType":"urn:bamm:io.catenax.assembly_part_relationship:1.0.0","identification":"urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff","payload":{"catenaXId":"urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447","childParts":[{"createdOn":"2022-02-03T14:48:54.709Z","childCatenaXId":"urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447","lastModifiedOn":"2022-02-03T14:48:54.709Z","lifecycleContext":"AsBuilt","quantity":{"measurementUnit":{"datatypeURI":"urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece","lexicalValue":"piece"},"quantityNumber":1}}]}}],"tombstones":[{"catenaXId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","endpointURL":"https://catena-x.net/vehicle/partdetails/","processingError":{"errorDetail":"Details to reason of Failure","lastAttempt":"2022-02-03T14:48:54.709Z","processStep":"SchemaValidation","retryCounter":0}}]}}},"schema":{"type":"object","additionalProperties":false,"description":"Container for a job with item graph.","properties":{"bpns":{"type":"array","description":"Collection of bpn mappings","items":{"type":"object","additionalProperties":false,"description":"Business partner id with name","properties":{"manufacturerId":{"type":"string"},"manufacturerName":{"type":"string"}}},"maxItems":2147483647,"uniqueItems":true},"job":{"type":"object","additionalProperties":false,"description":"Executable unit with meta information and item graph result.","properties":{"completedOn":{"type":"string","format":"date-time"},"createdOn":{"type":"string","format":"date-time"},"exception":{"type":"object","additionalProperties":false,"description":"Job error details.","properties":{"errorDetail":{"type":"string","description":"Detailed exception information.","maxLength":4000},"exception":{"type":"string","description":"Exception name.","maxLength":100},"exceptionDate":{"type":"string","format":"date-time","description":"Datetime error occurs."}}},"globalAssetId":{"type":"string","description":"Part global unique id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"id":{"type":"string","format":"uuid","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"lastModifiedOn":{"type":"string","format":"date-time"},"owner":{"type":"string","description":"The IRS api consumer."},"parameter":{"type":"object","additionalProperties":false,"description":"Job parameter of job processing.","properties":{"aspects":{"type":"string"},"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"callbackUrl":{"type":"string"},"collectAspects":{"type":"boolean"},"depth":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0},"direction":{"type":"string","description":"Item graph traversal direction.","enum":["upward","downward"]},"lookupBPNs":{"type":"boolean"}}},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]},"summary":{"type":"object","additionalProperties":false,"description":"Summary of the job with statistics of the job processing.","properties":{"asyncFetchedItems":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}},"bpnLookups":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}}}}},"required":["globalAssetId","id","state"]},"relationships":{"type":"array","description":"Relationships between parent and child items.","items":{"type":"object","additionalProperties":false,"description":"Relationships between parent and child items.","properties":{"aspectType":{"type":"string"},"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"linkedItem":{"type":"object","additionalProperties":false,"description":"Set of child parts the parent object is assembled by (one structural level down).","properties":{"assembledOn":{"type":"string","format":"date-time","description":"Datetime of assembly."},"childCatenaXId":{"type":"string","description":"CatenaX child global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"lastModifiedOn":{"type":"string","format":"date-time","description":"Last datetime item was modified."},"lifecycleContext":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"quantity":{"type":"object","additionalProperties":false,"description":"Quantity component.","properties":{"measurementUnit":{"type":"object","additionalProperties":false,"properties":{"datatypeURI":{"type":"string"},"lexicalValue":{"type":"string"}}},"quantityNumber":{"type":"number","format":"double","maximum":2147483647,"minimum":0}}}}}}},"maxItems":2147483647},"shells":{"type":"array","description":"AAS shells.","items":{"type":"object","additionalProperties":false,"description":"AAS shells.","properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string"},"text":{"type":"string"}}},"maxItems":2147483647},"globalAssetId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"idShort":{"type":"string"},"identification":{"type":"string"},"specificAssetIds":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"subjectId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"value":{"type":"string"}}},"maxItems":2147483647},"submodelDescriptors":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string"},"text":{"type":"string"}}},"maxItems":2147483647},"endpoints":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"interface":{"type":"string"},"protocolInformation":{"type":"object","additionalProperties":false,"properties":{"endpointAddress":{"type":"string"},"endpointProtocol":{"type":"string"},"endpointProtocolVersion":{"type":"string"},"subprotocol":{"type":"string"},"subprotocolBody":{"type":"string"},"subprotocolBodyEncoding":{"type":"string"}}}}},"maxItems":2147483647},"idShort":{"type":"string"},"identification":{"type":"string"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}}}},"maxItems":2147483647}}},"maxItems":2147483647},"submodels":{"type":"array","description":"Collection of requested Submodels","items":{"type":"object","additionalProperties":false,"description":"Submodel with identification of SubmodelDescriptor, aspect type and payload as String","properties":{"aspectType":{"type":"string"},"identification":{"type":"string"},"payload":{"type":"object","additionalProperties":{"type":"object"}}}},"maxItems":2147483647},"tombstones":{"type":"array","description":"Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL.","items":{"type":"object","additionalProperties":false,"description":"Tombstone with information about request failure","properties":{"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"endpointURL":{"type":"string"},"processingError":{"type":"object","additionalProperties":false,"properties":{"errorDetail":{"type":"string"},"lastAttempt":{"type":"string","format":"date-time"},"processStep":{"type":"string","enum":["SubmodelRequest","DigitalTwinRequest","SchemaValidation","SchemaRequest","BpdmRequest","BpdmValidation","UsagePolicyValidation"]},"retryCounter":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0}}}}},"maxItems":2147483647}}}}},"description":"Return job with item graph for the requested id."},"206":{"content":{"application/json":{"examples":{"complete":{"value":{"bpns":[],"job":{"completedOn":"2022-02-03T14:48:54.709Z","createdOn":"2022-02-03T14:48:54.709Z","exception":{"errorDetail":"Timeout while requesting Digital Registry","exception":"IrsTimeoutException","exceptionDate":"2022-02-03T14:48:54.709Z"},"globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","id":"e5347c88-a921-11ec-b909-0242ac120002","lastModifiedOn":"2022-02-03T14:48:54.709Z","owner":"","parameter":{"aspects":["SerialPartTypization","AddressAspect"],"bomLifecycle":"asBuilt","collectAspects":false,"depth":1,"direction":"downward","lookupBPNs":false},"startedOn":"2022-02-03T14:48:54.709Z","state":"RUNNING","summary":{"asyncFetchedItems":{"completed":0,"failed":0,"running":0}}},"relationships":[],"submodels":[],"tombstones":[]}}},"schema":{"type":"object","additionalProperties":false,"description":"Container for a job with item graph.","properties":{"bpns":{"type":"array","description":"Collection of bpn mappings","items":{"type":"object","additionalProperties":false,"description":"Business partner id with name","properties":{"manufacturerId":{"type":"string"},"manufacturerName":{"type":"string"}}},"maxItems":2147483647,"uniqueItems":true},"job":{"type":"object","additionalProperties":false,"description":"Executable unit with meta information and item graph result.","properties":{"completedOn":{"type":"string","format":"date-time"},"createdOn":{"type":"string","format":"date-time"},"exception":{"type":"object","additionalProperties":false,"description":"Job error details.","properties":{"errorDetail":{"type":"string","description":"Detailed exception information.","maxLength":4000},"exception":{"type":"string","description":"Exception name.","maxLength":100},"exceptionDate":{"type":"string","format":"date-time","description":"Datetime error occurs."}}},"globalAssetId":{"type":"string","description":"Part global unique id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"id":{"type":"string","format":"uuid","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"lastModifiedOn":{"type":"string","format":"date-time"},"owner":{"type":"string","description":"The IRS api consumer."},"parameter":{"type":"object","additionalProperties":false,"description":"Job parameter of job processing.","properties":{"aspects":{"type":"string"},"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"callbackUrl":{"type":"string"},"collectAspects":{"type":"boolean"},"depth":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0},"direction":{"type":"string","description":"Item graph traversal direction.","enum":["upward","downward"]},"lookupBPNs":{"type":"boolean"}}},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]},"summary":{"type":"object","additionalProperties":false,"description":"Summary of the job with statistics of the job processing.","properties":{"asyncFetchedItems":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}},"bpnLookups":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}}}}},"required":["globalAssetId","id","state"]},"relationships":{"type":"array","description":"Relationships between parent and child items.","items":{"type":"object","additionalProperties":false,"description":"Relationships between parent and child items.","properties":{"aspectType":{"type":"string"},"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"linkedItem":{"type":"object","additionalProperties":false,"description":"Set of child parts the parent object is assembled by (one structural level down).","properties":{"assembledOn":{"type":"string","format":"date-time","description":"Datetime of assembly."},"childCatenaXId":{"type":"string","description":"CatenaX child global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"lastModifiedOn":{"type":"string","format":"date-time","description":"Last datetime item was modified."},"lifecycleContext":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"quantity":{"type":"object","additionalProperties":false,"description":"Quantity component.","properties":{"measurementUnit":{"type":"object","additionalProperties":false,"properties":{"datatypeURI":{"type":"string"},"lexicalValue":{"type":"string"}}},"quantityNumber":{"type":"number","format":"double","maximum":2147483647,"minimum":0}}}}}}},"maxItems":2147483647},"shells":{"type":"array","description":"AAS shells.","items":{"type":"object","additionalProperties":false,"description":"AAS shells.","properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string"},"text":{"type":"string"}}},"maxItems":2147483647},"globalAssetId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"idShort":{"type":"string"},"identification":{"type":"string"},"specificAssetIds":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"subjectId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"value":{"type":"string"}}},"maxItems":2147483647},"submodelDescriptors":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string"},"text":{"type":"string"}}},"maxItems":2147483647},"endpoints":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"interface":{"type":"string"},"protocolInformation":{"type":"object","additionalProperties":false,"properties":{"endpointAddress":{"type":"string"},"endpointProtocol":{"type":"string"},"endpointProtocolVersion":{"type":"string"},"subprotocol":{"type":"string"},"subprotocolBody":{"type":"string"},"subprotocolBodyEncoding":{"type":"string"}}}}},"maxItems":2147483647},"idShort":{"type":"string"},"identification":{"type":"string"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}}}},"maxItems":2147483647}}},"maxItems":2147483647},"submodels":{"type":"array","description":"Collection of requested Submodels","items":{"type":"object","additionalProperties":false,"description":"Submodel with identification of SubmodelDescriptor, aspect type and payload as String","properties":{"aspectType":{"type":"string"},"identification":{"type":"string"},"payload":{"type":"object","additionalProperties":{"type":"object"}}}},"maxItems":2147483647},"tombstones":{"type":"array","description":"Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL.","items":{"type":"object","additionalProperties":false,"description":"Tombstone with information about request failure","properties":{"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"endpointURL":{"type":"string"},"processingError":{"type":"object","additionalProperties":false,"properties":{"errorDetail":{"type":"string"},"lastAttempt":{"type":"string","format":"date-time"},"processStep":{"type":"string","enum":["SubmodelRequest","DigitalTwinRequest","SchemaValidation","SchemaRequest","BpdmRequest","BpdmValidation","UsagePolicyValidation"]},"retryCounter":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0}}}}},"maxItems":2147483647}}}}},"description":"Return job with current processed item graph for the requested id."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return job failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Job with the requested jobId not found."}},"security":[{"oAuth2":["profile email"]}],"tags":["Item Relationship Service"],"method":"get","path":"/irs/jobs/{id}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Return job with optional item graph result for requested id.","description":{"content":"Return job with optional item graph result for requested id.","type":"text/plain"},"url":{"path":["irs","jobs",":id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":" Return job with current processed item graph. Return job with item graph if job is in state , otherwise job.","type":"text/plain"},"key":"returnUncompletedJob","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the job.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Return job with optional item graph result for requested id. - - - -Return job with optional item graph result for requested id. - -
Path Parameters
Query Parameters
    Return job with current processed item graph. Return job with item graph if job is in state , otherwise job.","in":"query","name":"returnUncompletedJob","required":false,"schema":{"type":"boolean","default":true}}}>
- -Return job with item graph for the requested id. - -
Schema
    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. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>= 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    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. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    linkedItem object
    - -Set of child parts the parent object is assembled by (one structural level down). - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    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
  • property name* object
    • tombstones object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    processingError object
- -Return job with current processed item graph for the requested id. - -
Schema
    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. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>= 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    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. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    linkedItem object
    - -Set of child parts the parent object is assembled by (one structural level down). - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    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
  • property name* object
    • tombstones object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    processingError object
- -Return job failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- -Job with the requested jobId not found. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-jobs-by-job-states.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-jobs-by-job-states.api.mdx deleted file mode 100644 index 0232e3c6e3f..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/get-jobs-by-job-states.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-jobs-by-job-states -title: "Returns paginated jobs with state and execution times." -description: "Returns paginated jobs with state and execution times." -sidebar_label: "Returns paginated jobs with state and execution times." -hide_title: true -hide_table_of_contents: true -api: {"description":"Returns paginated jobs with state and execution times.","operationId":"getJobsByJobStates","parameters":[{"description":"Requested job states.","explode":false,"in":"query","name":"states","required":false,"schema":{"type":"array","items":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]},"maxItems":2147483647}},{"description":"Zero-based page index (0..N)","in":"query","name":"page","schema":{"type":"integer","default":0}},{"description":"The size of the page to be returned","in":"query","name":"size","schema":{"type":"integer","default":20}},{"description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","in":"query","name":"sort","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"content":[{"completedOn":"2022-02-03T14:48:54.709Z","id":"6c311d29-5753-46d4-b32c-19b918ea93b0","startedOn":"2022-02-03T14:48:54.709Z","state":"COMPLETED"}],"pageCount":1,"pageNumber":0,"pageSize":10,"totalElements":1}}},"schema":{"type":"object","additionalProperties":false,"properties":{"content":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"completedOn":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]}}}},"pageCount":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"}}}}},"description":"Paginated list of jobs with state and execution times for requested job states."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return jobs for requested job states failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":["profile email"]}],"tags":["Item Relationship Service"],"method":"get","path":"/irs/jobs","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Returns paginated jobs with state and execution times.","description":{"content":"Returns paginated jobs with state and execution times.","type":"text/plain"},"url":{"path":["irs","jobs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Requested job states.","type":"text/plain"},"key":"states","value":""},{"disabled":false,"description":{"content":"Zero-based page index (0..N)","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"The size of the page to be returned","type":"text/plain"},"key":"size","value":""},{"disabled":false,"description":{"content":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","type":"text/plain"},"key":"sort","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns paginated jobs with state and execution times. - - - -Returns paginated jobs with state and execution times. - -
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
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx deleted file mode 100644 index 6c253a8234b..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: irs-api -title: "IRS API" -description: "The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners." -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: 2.0 - -# IRS API - - - -The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners. - -

Authentication

Security Scheme Type:oauth2
clientCredentials OAuth Flow:

Token URL: https://localhost

Scopes:
  • profile email:
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/receive-edc-notification.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/receive-edc-notification.api.mdx deleted file mode 100644 index f6c7fc32643..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/receive-edc-notification.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: receive-edc-notification -title: "Accepts notifications sent via EDC." -description: "Accepts notifications via EDC. Notifications are filtered by their type and processed accordingly." -sidebar_label: "Accepts notifications sent via EDC." -hide_title: true -hide_table_of_contents: true -api: {"description":"Accepts notifications via EDC. Notifications are filtered by their type and processed accordingly.","operationId":"receiveEdcNotification","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"content":{"type":"object","additionalProperties":{"type":"object"}},"header":{"type":"object","additionalProperties":false,"description":"EDC notification header information","properties":{"notificationId":{"type":"string"},"notificationType":{"type":"string"},"originalNotificationId":{"type":"string"},"recipientBpn":{"type":"string"},"replyAssetId":{"type":"string"},"replyAssetSubPath":{"type":"string"},"senderBpn":{"type":"string"},"senderEdc":{"type":"string"}},"required":["notificationId","notificationType","recipientBpn","senderBpn"]}},"required":["content","header"]}}},"required":true},"responses":{"200":{"description":"Notification received successfully."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Notification malformed."}},"tags":["Environmental- and Social Standards"],"method":"post","path":"/ess/notification/receive","servers":[{"url":"http://localhost:8080"}],"security":[{"oAuth2":["profile email"]}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"jsonRequestBodyExample":{"content":{},"header":{"notificationId":"string","notificationType":"string","originalNotificationId":"string","recipientBpn":"string","replyAssetId":"string","replyAssetSubPath":"string","senderBpn":"string","senderEdc":"string"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Accepts notifications sent via EDC.","description":{"content":"Accepts notifications via EDC. Notifications are filtered by their type and processed accordingly.","type":"text/plain"},"url":{"path":["ess","notification","receive"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Accepts notifications sent via EDC. - - - -Accepts notifications via EDC. Notifications are filtered by their type and processed accordingly. - -
Request Body required
    content object required
  • property name* object
    • header object required
    - -EDC notification header information - -
- -Notification received successfully. - -
- -Notification malformed. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/register-bpn-investigation.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/register-bpn-investigation.api.mdx deleted file mode 100644 index 677d992d508..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/register-bpn-investigation.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: register-bpn-investigation -title: "Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId." -description: "Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId." -sidebar_label: "Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId." -hide_title: true -hide_table_of_contents: true -api: {"description":"Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.","operationId":"registerBPNInvestigation","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"description":"The requested job definition.","properties":{"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"callbackUrl":{"type":"string","description":"Callback url to notify requestor when job processing is finished. There are two uri variable placeholders that can be used: jobId and jobState.","example":"https://hostname.com/callback?jobId={jobId}&jobState={jobState}"},"globalAssetId":{"type":"string","description":"Id of global asset.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"incidentBpns":{"type":"array","items":{"type":"string"},"maxItems":2147483647}},"required":["globalAssetId","incidentBpns"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"complete":{"value":{"id":"6c311d29-5753-46d4-b32c-19b918ea93b0"}}},"schema":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"uuid","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"}}}}},"description":"Returns id of registered job."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Job registration failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":["profile email"]}],"tags":["Environmental- and Social Standards"],"method":"post","path":"/ess/bpn/investigations","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"jsonRequestBodyExample":{"bomLifecycle":"asBuilt","callbackUrl":"https://hostname.com/callback?jobId={jobId}&jobState={jobState}","globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","incidentBpns":["string"]},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.","description":{"content":"Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.","type":"text/plain"},"url":{"path":["ess","bpn","investigations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId. - - - -Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId. - -
Request Body required
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
- -Returns id of registered job. - -
Schema
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
- -Job registration failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/register-job-for-global-asset-id.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/register-job-for-global-asset-id.api.mdx deleted file mode 100644 index b24de18dd6d..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/register-job-for-global-asset-id.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: register-job-for-global-asset-id -title: "Register an IRS job to retrieve an item graph for given {globalAssetId}." -description: "Register an IRS job to retrieve an item graph for given {globalAssetId}." -sidebar_label: "Register an IRS job to retrieve an item graph for given {globalAssetId}." -hide_title: true -hide_table_of_contents: true -api: {"description":"Register an IRS job to retrieve an item graph for given {globalAssetId}.","operationId":"registerJobForGlobalAssetId","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"description":"The requested job definition.","properties":{"aspects":{"type":"array","items":{"type":"string"},"maxItems":2147483647},"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"callbackUrl":{"type":"string","description":"Callback url to notify requestor when job processing is finished. There are two uri variable placeholders that can be used: id and state.","example":"https://hostname.com/callback?id={id}&state={state}"},"collectAspects":{"type":"boolean","description":"Flag to specify whether aspects should be requested and collected. Default is false."},"depth":{"type":"integer","format":"int32","description":"Max depth of the item graph returned. If no depth is set item graph with max depth is returned.","maximum":100,"minimum":1},"direction":{"type":"string","default":"downward","description":"Item graph traversal direction.","enum":["upward","downward"]},"globalAssetId":{"type":"string","description":"Id of global asset.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"lookupBPNs":{"type":"boolean","description":"Flag to specify whether BPNs should be collected and resolved via the configured BPDM URL. Default is false."}},"required":["globalAssetId"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"complete":{"value":{"id":"6c311d29-5753-46d4-b32c-19b918ea93b0"}}},"schema":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"uuid","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"}}}}},"description":"Returns id of registered job."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Job registration failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":["profile email"]}],"tags":["Item Relationship Service"],"method":"post","path":"/irs/jobs","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"jsonRequestBodyExample":{"aspects":["string"],"bomLifecycle":"asBuilt","callbackUrl":"https://hostname.com/callback?id={id}&state={state}","collectAspects":true,"depth":0,"direction":"downward","globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","lookupBPNs":true},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Register an IRS job to retrieve an item graph for given {globalAssetId}.","description":{"content":"Register an IRS job to retrieve an item graph for given {globalAssetId}.","type":"text/plain"},"url":{"path":["irs","jobs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Register an IRS job to retrieve an item graph for given {globalAssetId}. - - - -Register an IRS job to retrieve an item graph for given {globalAssetId}. - -
Request Body required
    = 1` and `<= 100`"} defaultValue={undefined}>= 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
- -Returns id of registered job. - -
Schema
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
- -Job registration failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/register-order.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/register-order.api.mdx deleted file mode 100644 index d48f33af0ae..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/register-order.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: register-order -title: "Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches." -description: "Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches." -sidebar_label: "Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches." -hide_title: true -hide_table_of_contents: true -api: {"description":"Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches.","operationId":"registerOrder","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"description":"Request body for registering a new Batch Order.","properties":{"aspects":{"type":"array","items":{"type":"string"},"maxItems":2147483647},"batchSize":{"type":"integer","format":"int32","default":20,"description":"Size of the batch.","maximum":100,"minimum":10},"batchStrategy":{"type":"string","description":"The strategy how the batch is processed internally in IRS.","enum":["PRESERVE_BATCH_JOB_ORDER","PRESERVE_JOB_ORDER","PRESERVE_BATCH_ORDER"]},"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"callbackUrl":{"type":"string","description":"Callback url to notify requestor when job processing is finished. There are four uri variable placeholders that can be used: orderId, batchId, orderState and batchState.","example":"https://hostname.com/callback?orderId={orderId}&batchId={batchId}&orderState={orderState}&batchState={batchState}"},"collectAspects":{"type":"boolean","description":"Flag to specify whether aspects should be requested and collected. Default is false."},"depth":{"type":"integer","format":"int32","description":"Max depth of the item graph returned. If no depth is set item graph with max depth is returned.","maximum":100,"minimum":1},"direction":{"type":"string","default":"downward","description":"Item graph traversal direction.","enum":["upward","downward"]},"globalAssetIds":{"type":"array","items":{"type":"string"},"maxItems":2147483647},"jobTimeout":{"type":"integer","format":"int32","default":3600,"description":"Timeout in seconds for each job processing inside the complete order.","maximum":7200,"minimum":60},"lookupBPNs":{"type":"boolean","description":"Flag to specify whether BPNs should be collected and resolved via the configured BPDM URL. Default is false."},"timeout":{"type":"integer","format":"int32","default":43200,"description":"Timeout in seconds for the complete batch order processing.","maximum":86400,"minimum":60}},"required":["globalAssetIds"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"complete":{"value":{"id":"6c311d29-5753-46d4-b32c-19b918ea93b0"}}},"schema":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"uuid","description":"Id of the Batch Order."}}}}},"description":"Returns orderId of registered Batch order."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Batch Order registration failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":["profile email"]}],"tags":["Item Relationship Service"],"method":"post","path":"/irs/orders","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"jsonRequestBodyExample":{"aspects":["string"],"batchSize":20,"batchStrategy":"PRESERVE_BATCH_JOB_ORDER","bomLifecycle":"asBuilt","callbackUrl":"https://hostname.com/callback?orderId={orderId}&batchId={batchId}&orderState={orderState}&batchState={batchState}","collectAspects":true,"depth":0,"direction":"downward","globalAssetIds":["string"],"jobTimeout":3600,"lookupBPNs":true,"timeout":43200},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches.","description":{"content":"Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches.","type":"text/plain"},"url":{"path":["irs","orders"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches. - - - -Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches. - -
Request Body required
    = 10` and `<= 100`"} defaultValue={20}>= 1` and `<= 100`"} defaultValue={undefined}>= 60` and `<= 7200`"} defaultValue={3600}>= 60` and `<= 86400`"} defaultValue={43200}>
- -Returns orderId of registered Batch order. - -
Schema
- -Batch Order registration failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js deleted file mode 100644 index c072d04232a..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/irs-api"},{"type":"category","label":"Environmental- and Social Standards","link":{"type":"generated-index","title":"Environmental- and Social Standards","slug":"/category/kits/Data Chain Kit/Software Development View/Job Api/environmental-and-social-standards"},"items":[{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/register-bpn-investigation","label":"Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.","className":"api-method post"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-bpn-investigation","label":"Return job with additional supplyChainImpacted information.","className":"api-method get"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/receive-edc-notification","label":"Accepts notifications sent via EDC.","className":"api-method post"}]},{"type":"category","label":"Item Relationship Service","link":{"type":"generated-index","title":"Item Relationship Service","slug":"/category/kits/Data Chain Kit/Software Development View/Job Api/item-relationship-service"},"items":[{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-jobs-by-job-states","label":"Returns paginated jobs with state and execution times.","className":"api-method get"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/register-job-for-global-asset-id","label":"Register an IRS job to retrieve an item graph for given {globalAssetId}.","className":"api-method post"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-job-for-job-id","label":"Return job with optional item graph result for requested id.","className":"api-method get"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/cancel-job-by-job-id","label":"Cancel job for requested jobId.","className":"api-method put"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/register-order","label":"Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches.","className":"api-method post"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-batch-order","label":"Get a batch order for a given orderId.","className":"api-method get"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/cancel-batch-order","label":"Cancel a batch order for a given orderId.","className":"api-method put"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-batch","label":"Get a batch with a given batchId for a given orderId.","className":"api-method get"}]},{"type":"category","label":"Aspect Models","link":{"type":"generated-index","title":"Aspect Models","slug":"/category/kits/Data Chain Kit/Software Development View/Job Api/aspect-models"},"items":[{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-all-aspect-models","label":"Get all available aspect models from semantic hub or local models.","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/_category_.json b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/_category_.json deleted file mode 100644 index e5c5b7565a3..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Development View" -} diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/page_software-development-view.md deleted file mode 100644 index 8ac78963676..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Software Development View/page_software-development-view.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -id: Specification -title: Specification -sidebar_position: 2 ---- - -![Datachain kit banner](@site/static/img/DataChainKitIcon.png) - -### Data Chain KIT - -## IRS REST API - -The IRS Rest API provides an easy to use Interface for applications to access cross company data chains. - -## IRS REST API Standard - -The IRS REST API is standardized through the Catena-X e.V. and can be found here: - -- [> CX-0005 Item Relationship Service API](https://catena-x.net/de/standard-library) - -Comming Soon: - -- CX-0045 Data Chain Template diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Success Stories/page_ce_circularity_dashboard_story.md b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Success Stories/page_ce_circularity_dashboard_story.md deleted file mode 100644 index 704aa69a6d9..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Success Stories/page_ce_circularity_dashboard_story.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -id: Circularity Dashboard Sucess Story -title: Circularity Dashboard Sucess Story -description: 'Data Chain Kit' -sidebar_position: 1 ---- - -Due to the large number of producers and consumers, however, the implementation of the circular economy is challenging: Information on the individual lifecycles is mostly only available locally and therefore does not provide any meaningful assessment of reuse, recycling or remanufacturing. - -![success](@site/static/img/irs-circularity-dashboard-successstory.png) - -Therefore, the circularity dashboard, gives the user information about materials of the product and of all their composites. This is only possible, if participants of the supply chain, the direct manufactures of the composites of a vehicle are sharing information about the materials used. -The ability to access provided data in the Catena-X network could be done in two different ways. Way one is to handle each request separately, or use the IRS, which manages the retrieval of digital twins, checks and validates the results against the semantics and provides an easy-to-use API to interact with the decentral stored data. -In the SAP Industry Network for Automotive, circularity cockpit API specification and IRS implementation are serving as a reference. Thus, we were able to develop IRS functionality to best fit the SAP tech stack, which we decided to use for the circularity cockpit. -This enables us, to have a controlled access to distributed data in an interoperable setup to access data chains. To abstract the data consumption layer brings benefits in stability and resiliency to our application, because we could easily change to different providers or services of a IRS implementation. diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Success Stories/page_trace-x_story.mdx b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Success Stories/page_trace-x_story.mdx deleted file mode 100644 index 7e07727a49e..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Success Stories/page_trace-x_story.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: Trace-X Sucess Story -title: Trace-X Sucess Story -description: 'Data Chain Kit' -sidebar_position: 1 ---- - -import Image from "@site/static/img/Group31.png" - - -
-

Trace-X

-
-

Trace-X empowers all companies from SMEs to large OEMs to participate in parts traceability with an Open-Source solution.

- -![Trace-X-Screenshot](@site/static/img/Trace-X/Trace-X_App-mypartsview.png) - -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. - -![success2](@site/static/img/IRS2.png) - -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 beneficial 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, Keycloak 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 -
-
- -![Trace-XScreenshot1](@site/static/img/Trace-X/01.png) -![Trace-XScreenshot2](@site/static/img/Trace-X/02.png) -![Trace-XScreenshot3](@site/static/img/Trace-X/03.png) -![Trace-XScreenshot4](@site/static/img/Trace-X/04.png) - diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Success Stories/success_stories.mdx b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Success Stories/success_stories.mdx deleted file mode 100644 index 5ddcd49d879..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/Success Stories/success_stories.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -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.09/kits/Data Chain Kit/arc/page_documentation.md b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/arc/page_documentation.md deleted file mode 100644 index 3502407f2fd..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/arc/page_documentation.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: documentation -title: Documentation -description: 'Data Chain Kit' -sidebar_position: 3 ---- - -![Datachain kit banner](@site/static/img/doc-datachain_header-minified.png) - -## 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.09/kits/Data Chain Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/page_adoption-view.md deleted file mode 100644 index 003089efaf2..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/page_adoption-view.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -id: Adoption View Data Chain Kit -title: Adoption View -description: 'Data Chain Kit' -sidebar_position: 1 ---- - -![Datachain kit banner](@site/static/img/DataChainKitIcon.png) - -### 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 - -## Logic & Schema - -### Building Block Architecture Overview - -![Building Block View](@site/static/img/irs_buidling_block_decentral.svg) - -#### IRS Components - -| Components | Description | -|:----------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| IRS | The IRS builds a digital representation of a product (digital twin) and the relationships of items the product consists of in a hierarchical structure. The result is an item graph in which each node represents a digital item of the product - this graph is called "Item Graph". | -| IRS API | The IRS API is the Interface over which the Data Consumer is communicating. | -| IrsController | The IrsController provides a REST Interface for retrieving IRS processed data and job details of the current item graph retrieval process. | -| IrsItemGraphQueryService | The IrsItemGraphQueryService implements the REST Interface of the IrsController. | -| JobOrchestrator | The JobOrchestrator is a component which manages (start, end, cancel, resume) the jobs which execute the item graph retrieval process. | -| RecursiveJobHandler | The RecursiveJobHandler handles the job execution recursively until a given abort criteria is reached or the complete item graph is build. | -| TransferProcessManager | The TransferProcessManager handles the outgoing requests to the various data services. | -| Policy Store | The Policy Store provides an Interface for getting, adding and deleting accepted IRS EDC policies. These policies will be used to validate EDC contract offers. | -| BlobStore | The BlobStore is the database where the relationships and tombstones are stored for a requested item. | -| JobStore | The JobStore is the database where the jobs with the information about the requested item are stored. | -| Digital Twin Registry Client | The Digital Twin Registry Client is the interface to the Digital Twin Registry. It provides an interface for the Asset Administration Shells. | -| Decentralized Digital Twin Client | In a decentralized network, the Digital Twin Client connects to the EDC which then proxies the requests to the digital twin registry on provider side. | -| EDC Client | The EDC Client is used to communicate with the EDC network, negotiate contracts and retrieve submodel data. | - -#### Catena-X Core Services - -| Subsystem | Description | -|:-----------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Digital Twin Registry | The Digital Twin Registry acts as an address book for Digital Twins. Data Providers register their Digital Twins in the Digital Twin Registry. Data consumers query the Digital Twin Registry to find Digital Twins and interact with them further. A Digital Twin contains endpoint references to submodel endpoints. Calling a submodel endpoint returns data compliant to a semantic model. A semantic model describes the data that a Submodel endpoint returns. [Repository of the Digital Twin Registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry). | -| Eclipse Dataspace Connector (EDC) | The Eclipse Dataspace Connector provides a framework for sovereign, inter-organizational data exchange. It will implement 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. [Repository of the Catena-X specific EDC](https://github.com/eclipse-tractusx/tractusx-edc). | -| Discovery Service | The Discovery Service interface is a CX network public available endpoint which can get used to retrieve EDC Discovery Service or BPN Discovery Services via a given type. | -| Portal | The Catena-X Portal and Marketplace is the heart of Catena-X and the entry point for all activities in the automotive network/value chain. Every user of the automotive value chain, no matter if it is a consumer, app provider, IT administrator or IT support will connect via the portal to the value bringing services. The whole eco-system on the automotive value chain is connected at one place. | | -| EDC Discovery Finder | The EDC dataspace discovery interface is a CX network public available endpoint which can get used to retrieve edc endpoints and the related BPNs, as well as search for endpoints via the BPN | - -## Business Process - -The DataChainKit acts as a middleware between consumers and manufacturers. This section describes the Business Process of DataChainKit. Who are its users, and with which other systems does it interact with. - -### Consumer - -The DataChainKit by IRS API is the essential component of the business app Trace-X FOSS to be able to build data chains in upwards and downwards direction for BOM lifecycles asBuilt and asPlanned. -The DataChainKit by IRS API is being consumed by the dismantler dashboard and other parties which are part of the Catena-X network. They need to provide valid credentials issued by the Catena-X Portal/IdP. Additionally, they must provide a base global asset identifier to retrieve information for as well as configuration details for the view on that information. - -### Catena-X network - -The IRS retrieves data from the Catena-X network (using the necessary infrastructure, see Technical Context), aggregates it and provides it back to the consumers. This connection is mandatory. If the Catena-X services are unavailable, the IRS cannot perform any work. - -As of now, the IRS uses technical user credentials provided by the portal to gather the required data. This might be changed to use the consumer credentials in the future. - -## Standards - -Our relevant standards can be downloaded from the official [Catena-X Standard Library](https://catena-x.net/de/standard-library) - -- [CX - 0005 Item Relationship Service API](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Archiv/Update_Juli_23_R_3.2/CX-0005-ItemRelationshipServiceApi-v1.1.1.pdf) -- [CX - 0045 Aspect Model Template Data Chain](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Archiv/Update_Juli_23_R_3.2/CX-0045-AspectModelDataChainTemplate-v1.1.1.pdf) - - -## Why Data Chain Kit - -What is in for you to use the Data Chain Kit. On what is it built on. - -![Why use Datachain Kit](@site/static/img/why_data_chain-minified.png) - -## IRS Iterative - -The IRS iterative iterates through the different digital twin aspects, which are representing a relationship. For Release 3.2 this is the SingleLevelBOMasBuilt aspect, which connects serialized parts. This service can access the digital twins for which an EDC policy and a data contract exists. In this case the consumer needs a contract which each participant of the data chain. - -![IRS iterative diagram](@site/static/img/irs-minified.svg) - -The following general conditions apply: -- Access control through policies and contracts is done by the EDC -- Direct data exchange between supply-chain partners -- Catena-X partners of the accessible value chain are known to the data-consumer - -## IRS Recursive - -The IRS recursive works different as the IRS iterative. It does not consume the digital twins of the partners in the supply chain in a direct way, it triggers the IRS of a partner to start a IRS job to retrieve data of the sub-partners. This is done to keep the structure below intransparent to the value chain above, even though it is still possible to aggregate results; pass information along the value chain. - -The following general conditions apply: - -- The IRS recursive is for use-cases, which want to apply business logic with data along the value chain. For example, to summarize, or check for existence of values or certificates. -- Each participant has the possibility to check their values, before passing them to next in line -- Access control through policies and contracts is done by the EDC -- Direct data exchange between supply-chain partners -- Business logic is being applied with an extension concept - -The recursive approach is based on a decentralized network in which only the next level of a relationship between two companies (one level down approach) is known. (Relationship: Customer - Supplier) -1. Company OEM initiate request using a consumer application. -2. Company (supplier) is identified on the next lower level - then a message is sent to the IRS instance of this supplier. -3. After receiving the message on supplier level, the IRS determines the suppliers on the next lower level and also sends a message to the IRS instances of the suppliers. -4. This is repeated until a leaf node (a company has no more suppliers or the company is not part of the C-X network) is reached. -5. In this case the leaf node is responding with a message to the customer company. -6. The IRS on customer company level receives and aggregates the messages from all requested suppliers and responds again to the customer until OEM level is reached. -7. OEM shows result of recursive investigation according to the given use case in consumer application. diff --git a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/page_changelog.md b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/page_changelog.md deleted file mode 100644 index bae7a8065b3..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/page_changelog.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: data chain kit changelog -title: Changelog -description: 'Data Chain Kit Changelog' -sidebar_position: 10 ---- - -![Datachain kit banner](@site/static/img/DataChainKitIcon.png) - -### Data Chain KIT - -All notable changes to this Kit will be documented in this file. - - -## [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.09/kits/Data Chain Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/page_software-operation-view.md deleted file mode 100644 index 71ebe03e70e..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Data Chain Kit/page_software-operation-view.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -id: Operation View -title: Operation View -description: 'Data Chain Kit' -sidebar_position: 2 ---- - -![Datachain kit banner](@site/static/img/DataChainKitIcon.png) - -### Data Chain KIT - -## Local Deployment - -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 | -|----------------------------------------------------------------------------------|-------------------------------------|-------------------------------------------------------------------------| -|![arrow down](@site/static/img/arrow_down.png)| **[Install the prerequisites](#step-1-prerequisites)**| Install all necessary tools for this setup | -|![vector](@site/static/img/vector.png) | **[Check out the Code](#step-2-check-out-the-code)** | Get all necessary code to deploy the service and dependencies to the kuberneetes cluster| -|![check](@site/static/img/check.png) | **[Installing the Service](#step-3-installing-the-services)**|Start cluster and interact with 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 - -### 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**: - -![expected status](@site/static/img/minikube-dashboard-overview.png) - -#### 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.** - -![irs-login](@site/static/img/irs-login.png) - -## 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 - ![irs-new-job](@site/static/img/irs-new-job.png) -3. **click** 'Build Data Chain' to start a new IRS job -4. **click** 'Visualization' to see the result of the job - ![irs-job-list](@site/static/img/irs-job-list.png) - -### Step 2: Verify Results - -The following example shows a visual overview of all retrieved data assets and digital twins of a data chain. -![irs-login](@site/static/img/irs-vis-overview.png) -_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. - -![irs-login](@site/static/img/irs-vis-clickable.png) -_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.09/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.09/kits/Digital Twin Kit/Software Development View/API AAS Discovery/dotaas-part-2-http-rest-discovery-service-specification.info.mdx deleted file mode 100644 index 08dea9e47f6..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/Software Development View/API AAS Discovery/dotaas-part-2-http-rest-discovery-service-specification.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: dotaas-part-2-http-rest-discovery-service-specification -title: "DotAAS Part 2 | HTTP/REST | Discovery Service Specification" -description: "The entire Full Profile of the Discovery Service Specification as part of Details of the Asset Administration Shell Part 2. Publisher: Industrial Digital Twin Association (IDTA) 2023" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: V3.0_SSP-001 - -# DotAAS Part 2 | HTTP/REST | Discovery Service Specification - - - -The entire Full Profile of the Discovery Service Specification as part of Details of the Asset Administration Shell Part 2. Publisher: Industrial Digital Twin Association (IDTA) 2023 - -

Contact

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

License

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

Contact

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

License

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

Authentication

Contact

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

Authentication

Contact

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

Contact

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

License

CC BY 4.0
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/Software Development View/API Submodel/get-description.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/Software Development View/API Submodel/get-description.api.mdx deleted file mode 100644 index 340110b9c46..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/Software Development View/API Submodel/get-description.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-description -title: "Returns the self-describing information of a network resource (ServiceDescription)" -description: "Returns the self-describing information of a network resource (ServiceDescription)" -sidebar_label: "Returns the self-describing information of a network resource (ServiceDescription)" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Description API"],"operationId":"GetDescription","responses":{"200":{"description":"Requested Description","content":{"application/json":{"schema":{"type":"object","properties":{"profiles":{"minItems":1,"type":"array","items":{"type":"string","enum":["https://admin-shell.io/aas/API/3/0/AssetAdministrationShellServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/AssetAdministrationShellServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-003","https://admin-shell.io/aas/API/3/0/AasxFileServerServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/DiscoveryServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRepositoryServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRepositoryServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-003","https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-004","https://admin-shell.io/aas/API/3/0/ConceptDescriptionServiceSpecification/SSP-001"]}}},"description":"The Description object enables servers to present their capabilities to the clients, in particular which profiles they implement. At least one defined profile is required. Additional, proprietary attributes might be included. Nevertheless, the server must not expect that a regular client understands them.","example":"{\n \"profiles\": [\n \"https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-002\",\n \"https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-002\"\n ]\n}"}}}},"401":{"description":"Unauthorized, e.g. the server refused the authorization attempt.","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\\.[0-9]+)?)|24:00:00(\\.0+)?)(Z|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\\.[0-9]+)?)|24:00:00(\\.0+)?)(Z|\\+00:00|-00:00)$","type":"string"}}}}}}}}}},"x-semanticIds":["https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0"],"description":"Returns the self-describing information of a network resource (ServiceDescription)","method":"get","path":"/description","servers":[{"url":"{protocol}://{host_name}:{port}/api/{version_prefix}","variables":{"protocol":{"description":"Allows access through http and https (recommended)","default":"https","enum":["http","https"]},"host_name":{"description":"Hostname of server hosting the api","default":"admin-shell.io"},"port":{"description":"80 is default for http, 443 for https","default":"443","enum":["80","443"]},"version_prefix":{"default":"v3.0","enum":["v3.0"]}}}],"info":{"title":"DotAAS Part 2 | HTTP/REST | Submodel Service Specification","description":"The Value Profile of the Submodel Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](http://industrialdigitaltwin.org/en/content-hub). \nPublisher: Industrial Digital Twin Association (IDTA) April 2023","contact":{"name":"Industrial Digital Twin Association (IDTA)","email":"info@idtwin.org"},"license":{"name":"CC BY 4.0","url":"https://creativecommons.org/licenses/by/4.0/"},"version":"V3.0.1_SSP-003"},"postman":{"name":"Returns the self-describing information of a network resource (ServiceDescription)","description":{"type":"text/plain"},"url":{"path":["description"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Submodel//dotaas-part-2-http-rest-submodel-service-specification -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns the self-describing information of a network resource (ServiceDescription) - - - -Returns the self-describing information of a network resource (ServiceDescription) - -
- -Requested Description - -
Schema
    = 1`"} defaultValue={undefined}>
- -Unauthorized, e.g. the server refused the authorization attempt. - -
Schema
    messages object[]
- -Forbidden - -
Schema
    messages object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/Software Development View/API Submodel/get-submodel-value-only.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/Software Development View/API Submodel/get-submodel-value-only.api.mdx deleted file mode 100644 index ab00e898fd2..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/Software Development View/API Submodel/get-submodel-value-only.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: get-submodel-value-only -title: "Returns the Submodel in the ValueOnly representation" -description: "Returns the Submodel in the ValueOnly representation" -sidebar_label: "Returns the Submodel in the ValueOnly representation" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Submodel API"],"operationId":"GetSubmodel-ValueOnly","parameters":[{"name":"level","in":"query","description":"Determines the structural depth of the respective resource content","required":false,"schema":{"type":"string","default":"deep","enum":["deep"]}},{"name":"extent","in":"query","description":"Determines to which extent the resource is being serialized","required":false,"schema":{"type":"string","default":"withoutBlobValue","enum":["withBlobValue"]}}],"responses":{"200":{"description":"ValueOnly representation of the Submodel","content":{"application/json":{"schema":{"properties":{"submodelElements":{"minItems":1,"type":"array","items":{"allOf":[{"allOf":[{"type":"object","properties":{"extensions":{"minItems":1,"type":"array","items":{"allOf":[{"type":"object","properties":{"semanticId":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticIds":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}},{"required":["name"],"properties":{"name":{"maxLength":128,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueType":{"type":"string","enum":["xs:anyURI","xs:base64Binary","xs:boolean","xs:byte","xs:date","xs:dateTime","xs:decimal","xs:double","xs:duration","xs:float","xs:gDay","xs:gMonth","xs:gMonthDay","xs:gYear","xs:gYearMonth","xs:hexBinary","xs:int","xs:integer","xs:long","xs:negativeInteger","xs:nonNegativeInteger","xs:nonPositiveInteger","xs:positiveInteger","xs:short","xs:string","xs:time","xs:unsignedByte","xs:unsignedInt","xs:unsignedLong","xs:unsignedShort"]},"value":{"type":"string"},"refersTo":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}}]}}}},{"required":["modelType"],"properties":{"category":{"maxLength":128,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"idShort":{"type":"string","allOf":[{"maxLength":128,"minLength":1},{"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"},{"pattern":"^[a-zA-Z][a-zA-Z0-9_]*$"}]},"displayName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":128}}}]}},"description":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":1023}}}]}},"modelType":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataSpecificationIec61360","Entity","File","MultiLanguageProperty","Operation","Property","Range","ReferenceElement","RelationshipElement","Submodel","SubmodelElementCollection","SubmodelElementList"]}}}]},{"type":"object","properties":{"semanticId":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticIds":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}},{"required":["modelType"],"type":"object","properties":{"qualifiers":{"minItems":1,"type":"array","items":{"allOf":[{"type":"object","properties":{"semanticId":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticIds":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}},{"required":["type","valueType"],"properties":{"kind":{"type":"string","enum":["ConceptQualifier","TemplateQualifier","ValueQualifier"]},"type":{"maxLength":128,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueType":{"type":"string","enum":["xs:anyURI","xs:base64Binary","xs:boolean","xs:byte","xs:date","xs:dateTime","xs:decimal","xs:double","xs:duration","xs:float","xs:gDay","xs:gMonth","xs:gMonthDay","xs:gYear","xs:gYearMonth","xs:hexBinary","xs:int","xs:integer","xs:long","xs:negativeInteger","xs:nonNegativeInteger","xs:nonPositiveInteger","xs:positiveInteger","xs:short","xs:string","xs:time","xs:unsignedByte","xs:unsignedInt","xs:unsignedLong","xs:unsignedShort"]},"value":{"type":"string"},"valueId":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}]}},"modelType":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataSpecificationIec61360","Entity","File","MultiLanguageProperty","Operation","Property","Range","ReferenceElement","RelationshipElement","Submodel","SubmodelElementCollection","SubmodelElementList"]}}},{"type":"object","properties":{"embeddedDataSpecifications":{"minItems":1,"type":"array","items":{"required":["dataSpecification","dataSpecificationContent"],"type":"object","properties":{"dataSpecification":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"dataSpecificationContent":{"oneOf":[{"allOf":[{"required":["modelType"],"type":"object","properties":{"modelType":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataSpecificationIec61360","Entity","File","MultiLanguageProperty","Operation","Property","Range","ReferenceElement","RelationshipElement","Submodel","SubmodelElementCollection","SubmodelElementList"]}}},{"required":["preferredName"],"properties":{"preferredName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":255}}}]}},"shortName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":18}}}]}},"unit":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"unitId":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"sourceOfDefinition":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"symbol":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"dataType":{"type":"string","enum":["BLOB","BOOLEAN","DATE","FILE","HTML","INTEGER_COUNT","INTEGER_CURRENCY","INTEGER_MEASURE","IRDI","IRI","RATIONAL","RATIONAL_MEASURE","REAL_COUNT","REAL_CURRENCY","REAL_MEASURE","STRING","STRING_TRANSLATABLE","TIME","TIMESTAMP"]},"definition":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":1023}}}]}},"valueFormat":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueList":{"required":["valueReferencePairs"],"type":"object","properties":{"valueReferencePairs":{"minItems":1,"type":"array","items":{"required":["value","valueId"],"type":"object","properties":{"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueId":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}}}},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"levelType":{"required":["max","min","nom","typ"],"type":"object","properties":{"min":{"type":"boolean"},"nom":{"type":"boolean"},"typ":{"type":"boolean"},"max":{"type":"boolean"}}},"modelType":{"pattern":"DataSpecificationIec61360","type":"string"}}}]}]}}}}}}]}}}}}}},"400":{"description":"Bad Request, e.g. the request parameters of the format of the request body is wrong.","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\\.[0-9]+)?)|24:00:00(\\.0+)?)(Z|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"401":{"description":"Unauthorized, e.g. the server refused the authorization attempt.","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\\.[0-9]+)?)|24:00:00(\\.0+)?)(Z|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\\.[0-9]+)?)|24:00:00(\\.0+)?)(Z|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\\.[0-9]+)?)|24:00:00(\\.0+)?)(Z|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"default":{"description":"Default error handling for unmentioned status codes","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\\.[0-9]+)?)|24:00:00(\\.0+)?)(Z|\\+00:00|-00:00)$","type":"string"}}}}}}}}}},"x-semanticIds":["https://admin-shell.io/aas/API/GetSubmodelById/3/0"],"description":"Returns the Submodel in the ValueOnly representation","method":"get","path":"/submodel/$value","servers":[{"url":"{protocol}://{host_name}:{port}/api/{version_prefix}","variables":{"protocol":{"description":"Allows access through http and https (recommended)","default":"https","enum":["http","https"]},"host_name":{"description":"Hostname of server hosting the api","default":"admin-shell.io"},"port":{"description":"80 is default for http, 443 for https","default":"443","enum":["80","443"]},"version_prefix":{"default":"v3.0","enum":["v3.0"]}}}],"info":{"title":"DotAAS Part 2 | HTTP/REST | Submodel Service Specification","description":"The Value Profile of the Submodel Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](http://industrialdigitaltwin.org/en/content-hub). \nPublisher: Industrial Digital Twin Association (IDTA) April 2023","contact":{"name":"Industrial Digital Twin Association (IDTA)","email":"info@idtwin.org"},"license":{"name":"CC BY 4.0","url":"https://creativecommons.org/licenses/by/4.0/"},"version":"V3.0.1_SSP-003"},"postman":{"name":"Returns the Submodel in the ValueOnly representation","description":{"type":"text/plain"},"url":{"path":["submodel","$value"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Determines the structural depth of the respective resource content","type":"text/plain"},"key":"level","value":""},{"disabled":false,"description":{"content":"Determines to which extent the resource is being serialized","type":"text/plain"},"key":"extent","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Submodel//dotaas-part-2-http-rest-submodel-service-specification -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns the Submodel in the ValueOnly representation - - - -Returns the Submodel in the ValueOnly representation - -
Query Parameters
- -ValueOnly representation of the Submodel - -
Schema
    = 1`"} defaultValue={undefined}>
- -Bad Request, e.g. the request parameters of the format of the request body is wrong. - -
Schema
    messages object[]
- -Unauthorized, e.g. the server refused the authorization attempt. - -
Schema
    messages object[]
- -Forbidden - -
Schema
    messages object[]
- -Internal Server Error - -
Schema
    messages object[]
- -Default error handling for unmentioned status codes - -
Schema
    messages object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/Software Development View/API Submodel/sidebar.js b/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/Software Development View/API Submodel/sidebar.js deleted file mode 100644 index b0e1ee3922f..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/Software Development View/API Submodel/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Submodel//dotaas-part-2-http-rest-submodel-service-specification"},{"type":"category","label":"Submodel API","link":{"type":"generated-index","title":"Submodel API","slug":"/category/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Submodel/submodel-api"},"items":[{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Submodel//get-submodel-value-only","label":"Returns the Submodel in the ValueOnly representation","className":"api-method get"}]},{"type":"category","label":"Description API","link":{"type":"generated-index","title":"Description API","slug":"/category/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Submodel/description-api"},"items":[{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Submodel//get-description","label":"Returns the self-describing information of a network resource (ServiceDescription)","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/Software Development View/_category_.json b/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/Software Development View/_category_.json deleted file mode 100644 index e5c5b7565a3..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/Software Development View/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Development View" -} diff --git a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/Software Development View/page_software-development-view.md deleted file mode 100644 index 7d7ecc49f5f..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/Software Development View/page_software-development-view.md +++ /dev/null @@ -1,367 +0,0 @@ ---- -id: Specification Digital Twin KIT -title: Developing with the DT KIT -description: 'Digital Twin KIT' -sidebar_position: 4 ---- - - - - -![DT Kit Pictotogram](../assets/img/DTKIT_pictogram_blue.png) - -### Digital Twin KIT - - -## API Specifications - -All openAPI-specifications for the Digital Twin Kit services are rendered in the section [of these docs](API%20AAS%20Discovery/dotaas-part-2-http-rest-discovery-service-specification.info.mdx) - -### Asset Administration Shell - -The Asset Administration Shell (AAS) is a specification that is released by the Industrial Digital Twin Association -[(IDTA)](https://industrialdigitaltwin.org/) with a perspective to be adopted by the International Electrotechnical -Commission [(IEC)](https://www.iec.ch/homepage). -Its mission is defining how “information about assets […] can be exchanged in a meaningful way between partners in a value -creation network”. As such, it is well-suited to contribute to the toolbox of Catena-X. While the Spec offers an extensive -suite of meta-model elements and APIs, Catena-X only uses a small subset. What exactly is defined in the Catena-X standard -CX - 0002. - -#### Submodels - -An Asset Administration Shell is organized in Submodels. Each Submodel represents a self-contained aspect of an asset - -typical examples are the Nameplate or SingleLevelBomAsBuilt (which denotes the hierarchical composition of parts into -a whole). As different aspects of an Asset may be known to different parties on the value-chain, Submodels for a single asset -must be capable to run independently of each other. The specification explicitly allows this, enabling easy cross-company -data integration. - -Recognizing that not all use-cases require the full functionality of the AAS-Spec, Catena-X demands that Data -Providers offer only a subset of the SubmodelServiceSpecification - namely the `$value` serialization. This is an abbreviated -notation of an AAS-Submodel that is focused on data instead of context. While it is advisable to expose Submodels with help of -a full-fletched AAS-server SDK that provides the content-modifiers and API-endpoints out-of-the-box, this is not yet -mandatory. - -#### Digital Twin Registry - -What Catena-X calls the "Digital Twin Registry" (DTR) is actually the union of two different services that the AAS specification -has specified. For the sake of simplicity, they are both defined in a single service. The DTR serves a similar function as the -index in a book: When trying to discover information, it's convenient to have an overview WHAT one will find and HOW to -access it. The registry caters exactly that information: For every asset it knows, it holds a number of Submodel Descriptors and in -these, a consumer app will find information WHAT it will find (via the semanticId) and how to access the information (endpoint, -security setup etc.). As the information contained in the DTR may be sensitive and not be trusted with a central entity, -every data provider must offer his own DTR as an EDC Data Asset. While it is only mandatory to implement the GET endpoints -as specified in the [Development View](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/Specification%20Digital%20Twin%20Kit), -data providers may find it useful to implement POST requests for registration on top. Either way, they are free to populate -their DTR in any way they desire. - -### Catena-X specific Services - -DTRs hold sensitive information: a SubmodelDescriptor may not give access to the actual Submodel-data but all in cumulo hint at -production volumes as each Twin represents an asset. Therefore, Catena-X implements decentral DTRs (DDTR), each running with a -business partner. [In an IDTA-Whitepaper](https://industrialdigitaltwin.org/en/wp-content/uploads/sites/2/2023/06/Decentralized-Registries-Taxonomy-of-decentralized-registries-and-an-architectural-overview_.pdf ), -several high-level concepts for DDTRs are introduced. The AAS-specification remains agnostic to the approaches and endorses -none of them. Catena-X must deal with the additional complexity that stems from the interaction with the EDC. - -Leveraging the native capabilities of the EDC and the EDC Discovery Service, Catena-X uses a discovery pattern that has the -same capability as a central [Digital Twin Registry](#digital-twin-registry): It allows to start a Discovery Process with only an AssetId and -As none of the options fit the data-space-specific requirements of Catena-X entirely, yet a different approach is implemented: -However, in Catena-X some of the data is deemed so sensitive that a central authority can't be -trusted with it. Thus, each Data Provider will run their own DTR which poses a challenge for discovery. After all, a -Data Consumer must still find out the address where to fetch the data from. That's why Catena-X has introduced a -three-step discovery pattern made up of the central microservices Discovery Finder, BPN Discovery (or several of them) -and finally the EDC discovery that is part of the CX-Portal. They are also part of this Kit. - -## Discovery Sequence - -The services that make up the Digital Twin Kit partly rely on each other. Executing them in the right sequence allows -a Data Consumer to get access to data whose location was previously unknown. However, this discovery process relies on a -set of assumptions. Most relevant is the presence of the discovery services defined in CX - 0053 ([Discovery Finder](./API%20Discovery%20Finder/discovery-finder.info.mdx), -[BPN Discovery](./API%20BPN%20Discovery/bpn-discovery-service.info.mdx)) and CX - 0001 ([EDC Discovery](./API%20EDC%20Discovery/post-list-of-bpns-or-an-empty-array-to-retrieve-available-company-connector-authorization-required-roles-view-connectors.api.mdx)). -As portrayed in the [Operation View](../page_software-operation-view.md), these -discovery services are assumed to run centrally in a data space. A concept for decentralization will be validated in the -future. - -Apart from their presence, the discovery services also must be populated with data by the data providers. This process -is portrayed in the "setup of registration" section of the diagram below (steps 1-5). They describe the assumed calls -that have been made prior to consumer-side discovery. While step 1 was completed during onboarding of a company to the -Catena-X network, step 2 was executed by the operating company offering the BPN-Discovery Service. Step 3-5 are in the -responsibility of each Data Provider. - -In steps 6-17, the consumer fetches the previously registered data from the central services and initiates data access. -Please note that especially steps 12 & 13 (negotiation at EDC) are simplified in this figure as they are explained in the -Connector Kit already. The discovery sequence ends with step 17, after which the data consumer can make a request for the -data that he set out to find. - -![DT Kit Discovery Sequence](../assets/img/DTKIT_discovery_seq.svg) - -Some use-cases assume that a consumer has prior knowledge of an asset's location in a provider's infrastructure. That's -why data on a new asset will not necessarily be obtained by executing the whole discovery sequence above. For example, -a consumer may know not only the assetId but also the provider's BPN, allowing him to enter the sequence at step 10. -If this prior knowledge is given under all circumstances, registration steps 2-3 can be skipped provider-side. - - -## Sample Data - -Generic sample data for relevant data objects is contained in the openAPI-specs of the respective services. This chapter -contains data structures that are more specifically designed for use in the Digital Twin Kit. They are compliant with -the base-specifications (like AAS) but restrict the application even further for use in this dataspace. - -### Registration at EDC - -While the exact AAS-EDC-integration is at the discretion of each Kit and use case, there are good practices -that are likely to be standardized on the level of CX-0002 in the future. One relevant question is how the EDC-shielded services -of this Kit should register with the Asset endpoint of the EDC Management API. The following recommendations follow -the data structure expected from tractusx-edc v0.4.1 onwards. It demands a json-ld structure. - -Json-ld is a serialization for RDF graphs (see [Resource Description Framework](https://www.w3.org/RDF/)). The json-ld -`@context` section can declare the namespaces that resources explicitly mentioned in the rest of the document belong to. -It may also define default namespace with `@vocab` for resources without explicitly stated namespaces. Outside of -the "@context" section, the "@type" property always defines the class that an object belongs to. -As stated in the openAPI-specification of the EDC Management API's relevant endpoint, all entries in the `asset/properties` -object and the `privateProperties` object can be chosen freely. The section on the `dataAddress` is structured depending -on the `edc:type` property. The example below is determined by the [HttpDataAddress](https://github.com/eclipse-edc/Connector/blob/main/spi/common/core-spi/src/main/java/org/eclipse/edc/spi/types/domain/HttpDataAddress.java) -class. Other implementations may require different parameters. - -For successful discovery of Digital Twins, it is critical to register Submodels and Digital-Twin-Registries in a -harmonized way. The following overview shall explain how the `asset/properties` section could be used. Bear in mind that -this is a non-normative example. - -- `asset:prop:type` (mandatory as per CX-0002): denotes the type of Asset that is registered. For all AAS-registries -this property must be set to `data.core.digitalTwinRegistry`. -- `rdfs:label` (optional): short name for asset. -- `rdfs:comment` (optional): free text property for human consumption. -- `dcat:version` (optional): version-string of the registered resource. Please note that the version of the AAS-spec is - already considered in the `aas`-namespace. - -The top-level `@id` field denotes the identifier of the resource that is being registered. - -#### Digital Twin Registry as EDC Data Asset - -The top-level `@id` field is mandatory but can (for a DTR) be chosen freely at registration since a DTR usually has no unique -identifier. Please note that the dataAddress field `edc:baseUrl` ends before the URL-segments`/shell-descriptors/` and -`/lookup/`. Those must be added by the data consumer. The segments in the baseUrl are purely at the discretion of the data -provider as they are not specified by CX-0018 (and thus by the underlying IDTA-Standard). - -```json -{ - "@context": { - "@base": "http://myCompany.org/identifiers/", - "edc": "https://w3id.org/edc/v0.0.1/ns/", - "dcat": "https://www.w3.org/ns/dcat/", - "rdfs": "http://www.w3.org/2000/01/rdf-schema#" - }, - "edc:asset": { - "@type": "Asset", - "@id": "04a0993c-aa76-446f-a026-cb2ed62ea03f", - "edc:properties": { - "asset:prop:type": "data.core.digitalTwinRegistry", - "rdfs:label": "Digital Twin Registry", - "rdfs:comment": "DTR Endpoint of provider Processor_BackendIntegrationTests", - "dcat:version": "0.0.1" - }, - "edc:privateProperties": null - }, - "edc:dataAddress": { - "@type": "DataAddress", - "edc:type": "edc:HttpData", - "edc:baseUrl": "https://mycompany.com/dtr/api/v3/", - "edc:authKey": "Authorization", - "edc:authCode": "Basic XXX", - "edc:proxyBody": "true", - "edc:proxyPath": "true", - "edc:proxyQueryParams": "true", - "edc:proxyMethod": "true", - "edc:contentType": "application/json" - } -} -``` - - -#### Submodel as EDC Data Asset - -Registering a Submodel as Asset with the EDC Management API is at the discretion of each Data Provider. - -She may createone entry per Submodel or bundle them into one - yielding a smaller catalogue hence better performance. -This may seem strange because unharmonized Asset Registration does not allow a Data Consumer to systematically find all -EDC-Assets of type "Submodel". The discovery-sequence, however, is still intact since a Data Consumer will always know the -Data Plane and Control Plane of a Submodel from its [Submodel Descriptor in the Digital Twin Registry](#registration-at-digital-twin-registry). - -The following shows an example for registration of an AAS-Submodel as EDC Data Asset. The basic structure lends a type to -the asset and additionally holds `hasSemantics:semanticId`. It is recommended and shall signify the meaning of the -Submodel's payload. - -The top-level `@id` field should be equivalent to the id of the Submodel. -```json -{ - "@context": { - "@base": "http://myCompany.org/identifiers/", - "rdfs": "http://www.w3.org/2000/01/rdf-schema#", - "edc": "https://w3id.org/edc/v0.0.1/ns/", - "aas": "https://admin-shell.io/aas/API/3/0/", - "aas-submodel": "aas:SubmodelServiceSpecification/", - "aas-semantics": "aas:hasSemantics/" - }, - "edc:asset": { - "@id": "urn:uuid:ca180cf7-7ed6-4f53-b32f-d072d4cad834", - "@type": "Asset", - "edc:properties": { - "asset:prop:type": ["aas-submodel:SSP001"], - "rdfs:label": "PCF Data", - "rdfs:comment": "Endpoint for PCF data", - "aas-semantics:semanticId": "urn:bamm:io:pcf:4.0.1:Pcf", - "edc:contentType": "application/json" - }, - "edc:privateProperties": null, - "edc:dataAddress": { - "@type": "DataAddress", - "edc:type": "edc:HttpData", - "edc:baseUrl": "https://data.plane", - "edc:authKey": "Authorization", - "edc:authCode": "Basic XXX", - "edc:proxyBody": "true", - "edc:proxyPath": "false", - "edc:proxyQueryParams": "true", - "edc:proxyMethod": "true", - "edc:contentType": "application/json" - } - } -} -``` - -### Registration at Digital Twin Registry - -#### Example for AAS-Registration - -```json -{ - "id": "urn:uuid:e5c96ab5-896a-1234-8761-efd74777ca97", - "idShort": "myAas", - "specificAssetIds": [ - { - "name": "manufacturerPartId", - "value": "BPN:123-345-567103", - "externalSubjectId": { - "type": "ExternalReference", - "keys": [ - { - "type": "GlobalReference", - "value": "BPNL:someBpnOfAssetOwner" - } - ] - } - } - ], - "submodelDescriptors": [ - { - "id": "e5c96ab5-896a-482c-8761-efd74777ca97", - "semanticId": { - "type": "ExternalReference", - "keys": [ - { - "type": "GlobalReference", - "value": "urn:bamm:io.catenax.material_for_recycling:1.1.0#MaterialForRecycling" - } - ] - }, - "endpoints": [ - { - "interface": "SUBMODEL-3.0", - "protocolInformation": { - "href": "https://edc.data.plane/mypath/submodel", - "endpointProtocol": "HTTP", - "endpointProtocolVersion": [ - "1.1" - ], - "subprotocol": "DSP", - "subprotocolBody": "id=123;dspEndpoint=http://edc.control.plane/", - "subprotocolBodyEncoding": "plain", - "securityAttributes": [ - { - "type": "NONE", - "key": "NONE", - "value": "NONE" - } - ] - } - } - ] - } - ] -} -``` - -#### Example for Submodel-Registration at existing AAS - -The Submodel Descriptors in the DTR must not only follow the schema defined by the openAPI file. Additionally, it is -imperative that the network mandates how they shall be populated with data. This is especially critical because the -data access is not straight-forward but passes through an EDC which the Data Consumer must negotiate with. That's why -the subprotocol body holds information on how to talk to the EDC's Data Plane. - -```json -{ - "id": "e5c96ab5-896a-482c-8761-efd74777ca97", - "semanticId": { - "type": "ExternalReference", - "keys": [ - { - "type": "GlobalReference", - "value": "urn:bamm:io.catenax.material_for_recycling:1.1.0#MaterialForRecycling" - } - ] - }, - "endpoints": [ - { - "interface": "SUBMODEL-3.0", - "protocolInformation": { - "href": "https://edc.data.plane/mypath/submodel", - "endpointProtocol": "HTTP", - "endpointProtocolVersion": [ - "1.1" - ], - "subprotocol": "DSP", - "subprotocolBody": "id=123;dspEndpoint=http://edc.control.plane/", - "subprotocolBodyEncoding": "plain", - "securityAttributes": [ - { - "type": "NONE", - "key": "NONE", - "value": "NONE" - } - ] - } - } - ] -} - -``` -Currently, this structure is still standardized ambiguously in CX-0002. There, the `subprotocolBody` is not mandated to -contain the specific data (`"id=xyz;dspEndpoint=myControlPlane"`). As this is however good practice in other Kits, the -structure will likely find its way into the CX-0002 standard in the future. - - - -### EDC Usage Policies - -The decision what policies shall be implemented for the exchange of data is at the discretion of each use-case and cannot -be standardized in the context of the semantics-standards or the DT Kit. - -## Data Provisioning - -### Patterns - -Data Providers will usually follow one of two patterns: -1. Digital Twin Repository: Deploying a dedicated Repository for the persistence of digital twins and related data is the most -convenient way to get going with the AAS. Due to the risk of data duplication and unclear initial ingestion mechanisms, -it may not scale to industrial sizes. -2. Delegation: Wrapping another API or a database may deploy the Submodel API as a new facade. It delegates the incoming -requests to the respective backend systems. - -Offering data to the network requires mappings that are naturally dependent on the data source format. More on data integration -can be found in the corresponding [CX e.V. guide](https://catena-x.net/fileadmin/user_upload/04_Einfuehren_und_umsetzen/Onboarding/DataIntegrationPatterns_Guide_Final_V1.pdf). - -### Register Digital Twins - -As mentioned in CX - 0002, every Data Provider is required not only to deploy a DTR in his infrastructure but also to -register each of the Submodels. Otherwise, the data will not be discoverable by Data Consumers. diff --git a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/assets/img/DTKIT_discovery_seq.svg b/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/assets/img/DTKIT_discovery_seq.svg deleted file mode 100644 index 6f127f26043..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/assets/img/DTKIT_discovery_seq.svg +++ /dev/null @@ -1 +0,0 @@ -Data ConsumerSubmodel ServerDigital Twin RegistryProvider EDC Control PlaneEDC DiscoveryBPN Discovery ServiceDiscovery FinderProvider Setup AdminData ConsumerSubmodel ServerDigital Twin RegistryProvider EDC Control PlaneEDC DiscoveryBPN Discovery ServiceDiscovery FinderProvider Setup Admincritical[: setup of registration]loop[forEach BPN Discovery instance]critical[: discovery from data consumer side]POST /api/administration/Connectors with Link between BPN and EDC endpoint1POST /api/administration/connectors/discovery with IdType-to-BPN-Discover-URL-Mapping2POST /api/administration/connectors/bpnDiscovery with assetId, idType ("van", "cxId" etcetc)3POST /api/management/v2/assets with baseUrl and typization for AAS Registry4POST /shell-descriptors for all shell descriptors of a data provider5POST /api/administration/connectors/discovery/search with body containing relevant idTypes6bpn-discovery-endpoints7POST /api/administration/connectors/bpnDiscovery/search with body containing assetId8provider-bpn9POST /api/administration/Connectors/discovery with provider-bpn10edc-endpoint11negotiate data access and usage12access token13GET /lookup/shells?assetIds=xyz14aas-id15GET /shell-descriptors/{{aas-id}} with aas-id encoded base64url16shell-descriptor17GET /submodel/$value18data19 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/assets/img/DTKIT_high_level_arch.svg b/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/assets/img/DTKIT_high_level_arch.svg deleted file mode 100644 index 4a95da42a81..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/assets/img/DTKIT_high_level_arch.svg +++ /dev/null @@ -1 +0,0 @@ -AAS Registry & DiscoveryAAS SubmodelsProvider EDCConsumer EDCAny Consumer AppDiscovery FinderBPN DiscoveryEDC DiscoveryData ConsumerData ProviderOpCoStandard adopted from IDTAStandard specified by CX e.V.Standard adopted from IDSAInteractionOrganizationalboundaries \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/assets/img/DTKIT_pictogram_blue.png b/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/assets/img/DTKIT_pictogram_blue.png deleted file mode 100755 index 7e39e02eb83..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/assets/img/DTKIT_pictogram_blue.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/assets/img/DTKIT_terminology.svg b/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/assets/img/DTKIT_terminology.svg deleted file mode 100644 index 86d4c33bc08..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/assets/img/DTKIT_terminology.svg +++ /dev/null @@ -1 +0,0 @@ -AspectDigital TwinAspect ModelAsset Administration ShellSubmodelDigital RepresentationSubmodelElementssemantic definition forassociated withis acontainsis aassociated withimplements anImplements aDigital Twin RegistryAAS RegistryAAS DiscoveryEDCregistered inEDC Discoveryregistered inDiscovery FinderBPN Discoveryregistered inregistered inimplementsimplementsregistered inregistered inStandardized elsewhereAssetregistered inrepresents anStandardized in CX -0002 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/page_adoption-view.md deleted file mode 100644 index c0170aa2ef0..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/page_adoption-view.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -id: Adoption View Digital Twin Kit -title: Adoption View -description: 'Digital Twin Kit' -sidebar_position: 2 ---- - - - -![DT Kit Pictotogram](assets/img/DTKIT_pictogram_blue.png) - -### Digital Twin KIT - - -## Vision & Mission - -### Vision - -The aim of the Digital Twin Kit is to trace parts and materials across the entire value chain to enable data driven use -cases over all n-tier levels without compromising data sovereignty. This Kit enables data and app providers to deliver -solutions for building data chains and to send quality notifications on all levels and industries. - -To provide the Catena-X Automotive Network with a uniform infrastructure to enable data-level interoperability between -Business Partners is the purpose of the Digital Twin Kit. Regardless of the data's provenance, the Kit sets the scene -for a comprehensive landscape of distributed Digital Twins of assets (mostly parts) along the entire lifecycle of the -supply chain. - -### Mission - -The Digital Twin Kit bundles the necessary standards, APIs, interaction patterns and reference implementations on how -to build a Digital Twin for an asset. By adopting established standards and integrating them, the Digital Twin Kit leverages -the conceptual and implementation work of existing communities while contributing feedback and Open-Source-Contributions -back to the public. A priority is the seamless integration with other Catena-X developments such as the -[Connector Kit](https://eclipse-tractusx.github.io/docs-kits/category/connector-kit). - -### Customer Journey - -With the Digital Twin Kit, all roles mentioned in the [Operating Model Whitepaper](https://catena-x.net/fileadmin/user_upload/Publikationen_und_WhitePaper_des_Vereins/CX_Operating_Model_Whitepaper_02_12_22.pdf) -are given the necessary tooling to format their data and APIs in a standardized manner. - - -## Business Value - -Point-to-Point integration between Business Partners is challenging. On the one hand, all questions of sovereignty, -authorization, authentication must be agreed upon and implemented. That is covered by the -[Connector Kit](https://eclipse-tractusx.github.io/docs-kits/category/connector-kit) and the -services it relies on. What this Kit adds is a set of technologies that reduce the integration efforts on the -data level. Data Consumers can develop their applications against data formats that are standardized and reuse -them independent of whom they will consume the data from. This reduces the necessary investment significantly -and saves a network-participant from a strict link between the application and the data model. -Consuming applications can be substituted seamlessly if they are developed against the -relevant Catena-X standards - further lowering the bar of entry for new applications in the CX-Ecosystem. - - -## Use Case - -### Status Quo / Today’s challenge - -This Kit's aim is not to solve a dedicated business problem. It is an infrastructure component, critical for scalable -data sharing and integration. It does however deliver a broad set of capabilities that the use cases can leverage. - -- Well-defined API structure extensible by domain models. Each use case will want to share different data and the API -expands with the scope of the model. - -- A distributed infrastructure of central and decentral components integrating hand-in-hand with backend-systems southward -and the network northward. - -- Extensive meta-model to create a virtual representation of asses across their entire lifecycle. - -### Example - -The [Traceability Kit](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Adoption%20View%20Traceability%20Kit#logic--schema) -and the [Data Chain Kit](https://eclipse-tractusx.github.io/docs-kits/kits/Data%20Chain%20Kit/Documentation/irs_arc42) -build on Digital Twins and leverage many of this Kit's content. The Data Chain Kit would be unimagineable without the -pre-defined endpoint- and payload-definition that is the Digital Twin Kit. Likewise, -coupling the chains' elements would be impossible without a unified hierarchical structure running with all participants. -For more info how specifically the Asset Administration Shell is used, consult the Kits. - -## Additional Resources - -### CX-Standards - -- [CX - 0001 EDC Discovery API](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/9_Data-Discovery-Services/CX_-_0001_EDC_DISCOVERY_API_PlatformCapabilityDS_v_1.0.1-1.pdf) -- [CX - 0002 Digital Twins in Catena-X](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Archiv/Update_Juli_23_R_3.2/CX-0002-DigitalTwinsInCatena-X-v.1.0.2.pdf)*(linked version 1.0.2, this KIT refers to v2.0.0, to be released in 09/23)* -- CX - 0053 BPN Discovery Services *(v1.0.0 to be released in 09/23)* - -### Terminology - -The following figure is also a non-normative part of CX-0002 "Digital Twins in Catena-X" v2.0.0. When published, that -standard can be found in the [Catena-X standard library](https://catena-x.net/de/standard-library). -![How words relate in the DT Kit](assets/img/DTKIT_terminology.svg) diff --git a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/page_changelog.md b/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/page_changelog.md deleted file mode 100644 index fabd05e81c0..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/page_changelog.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -id: Digital Twin Kit Changelog -title: Changelog -description: 'Digital Twin Kit' -sidebar_position: 1 ---- - -![DT Kit Pictotogram](assets/img/DTKIT_pictogram_blue.png) - -### Digital Twin KIT - -All notable changes to this Kit will be documented in this file. - -## [1.0.0] - 2023-08-17 - -### Added - -- version from release - -### Changed - -- couple of bugfixes raised by reviewers - -## [0.2.0] - 2023-08-08 - -

Added

- -- Additional figure on terminology -- section on entire discovery mechanism -- pictograms - -

Changed

- -- Clarification on decentralization of registries -- Minor improvements based on stakeholders' feedback -- figures optimized for dark backgrounds -- example data adjusted to standards for CX R3.2 - -

Removed

- -- ./. - - -## [0.1.0] - 2023-07-12 - -

Added

- -- Initial version of the Kit including adoption, operation and development view incl. all relevant API specifications. - -

Changed

- -- ./. - -

Removed

- -- ./. diff --git a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/page_software-operation-view.md deleted file mode 100644 index 601ac7d73a8..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Digital Twin Kit/page_software-operation-view.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: Operation View Digital Twin Kit -title: Operation View -description: 'Digital Twin Kit' -sidebar_position: 3 ---- - -![DT Kit Pictotogram](assets/img/DTKIT_pictogram_blue.png) - -### Digital Twin KIT - - - -Based on the information provided in this kit, it is possible to run and program against an infrastructure of -Digital Twins the Catena-X-way. This infrastructure empowers Data Consumers to consume the network's data as agreed with -each Data Provider and facilitated by an Operating Company. They run central and decentral services that allow them to -discover each other, exchange information and contextualize it according to a standardized semantics. - -| Service Name | Description | Reference Implementation | [Standardized in](https://catena-x.net/de/standard-library) | -|-----------------------|----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------| -| Discovery Finder | A microservice resolving a type of identifiers against a set of BPN-Discovery Servers. | [Tractus-X Discovery Finder](https://github.com/eclipse-tractusx/sldt-discovery-finder) | CX - 0053 | -| BPN Discovery | A microservice resolving a particular assetId against the registered BPN of its owner. | [Tractus-X BPN Discovery](https://github.com/eclipse-tractusx/sldt-bpn-discovery) | CX - 0053 | -| EDC Discovery | A microservice that resolves a BPN against an EDC endpoint. | [Tractus-X Portal including EDC Discovoery API](https://github.com/eclipse-tractusx/portal-backend) | CX - 0001 | -| Digital Twin Registry | An exhaustive list of all Submodel Servers, with link to their assets, adhering to the AAS Registry API. | [Tractus-X Digital Twin Registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry) | CX - 0002 | -| Submodel Server | The data source adhering to a subset of the Submodel API as defined in AAS Part-2 3.0. | [FA³ST-Framework](https://github.com/FraunhoferIOSB/FAAAST-Service), [Eclipse Basyx](https://github.com/eclipse-basyx/basyx-java-sdk), [AASX Server](https://github.com/admin-shell-io/aasx-server) | CX - 0002 | - - -![High Level Architecture of an App leveraging the Digital Twin Kit](assets/img/DTKIT_high_level_arch.svg) \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/changelog.md b/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/changelog.md deleted file mode 100644 index 0c37302194e..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/changelog.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Changelog ---- - -## [0.1.0] - 2023-08-11 - -### Added - -- move KIT to Tractus-X repository - -### Changed - -### Removed - -## NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - -- SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2023 Robert Bosch GmbH -- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2023 T-Systems International GmbH -- SPDX-FileCopyrightText: 2023,2023 SAP SE -- SPDX-FileCopyrightText: 2023,2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. für ihre Institute IPK und IPK -- SPDX-FileCopyrightText: 2023,2023 BASF SE -- SPDX-FileCopyrightText: 2023,2023 Henkel AG & Co. KGaA -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: diff --git a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/page-adoption-view.md b/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/page-adoption-view.md deleted file mode 100644 index c780825a0d4..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/page-adoption-view.md +++ /dev/null @@ -1,282 +0,0 @@ ---- -title: Adoption View ---- - -## Introduction - -The EcoPass KIT will be the key enabler for various stakeholders to use digital product passports, which represent a digital collection of specific information about a physical product in a standardized exchange format. This data is governed by agreed-upon ownership and access rights, which are conveyed through the Eclipse Data Space Connector (EDC). The primary purpose of the product pass is to enable the electronic registration, processing and sharing of product-related details among various entities in the supply chain, including several businesses and authorities. The demand for interoperable product passports exists worldwide, driven by the need to establish sustainable and transparent supply chains across different types of products, for which the adoption of standards will become crucial. -In this context, Catena-X offers a decentralized ecosystem supported by standards and principles like data sovereignty, which can effectively implement such a product passport system. The objective of the EcoPass KIT is therefore to: - -- Provide a comprehensive overview of the business context and benefits of product passports. -- Offer guidelines for industry stakeholders. -- Provide a detailed description and offer tools to implement product passports. - -## Vision & Mission - -### Vision: Empowering Sustainability – One Product at a Time - -The EcoPass KIT envisions a future where sustainability is at the core of every product's lifecycle, from design and manufacturing to usage and end-of-life. By fostering transparency, traceability and informed decision-making, we aim to inspire solution and service providers to create innovative, eco-friendly products that reduce environmental impact and drive the global economy towards a circular model. - -### Mission: Unleashing Circularity Potential - -The EcoPass KIT enables the scalable usage of digital product passports in order to address the pressing issue of inefficient resource usage and lack of product transparency. With growing concerns over environmental impact, limited resources and waste generation, there is an urgent need for a comprehensive solution to drive sustainable practices across the value chain. The KIT offers unified data models, a reference application for passport utilization as well as the required API. Low entry barriers will allow you to adapt digital product passports rapidly and pay your contribution to a fully circular value chain without the necessity of vast expertise or resources. Designed for multiple products, the KIT offers scalability, high-quality product information and a set of tools for regulatory compliance. Our mission is to unlock the circular potential of every component and material, fostering a culture of sustainability, innovation, and shared responsibility among all stakeholders. - -All described specifications in the KIT are based on [Catena-X standards](https://catena-x.net/de/standard-library) such as the Asset Administration Shell, SSI and decentral Digital Twin Registry. They refer to other Catena-X KITs like the [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/kits/tractusx-edc/docs/kit/adoption-view/Adoption%20View/) (EDC), [Data Chain KIT](https://eclipse-tractusx.github.io/docs-kits/category/data-chain-kit/) (Item Relationship Service = IRS) and [Business Partner KIT](https://eclipse-tractusx.github.io/docs-kits/category/business-partner-kit/) to ensure interoperability and data sovereignty according to IDSA and Gaia-X principles. - -## Business Value - -Following this mission, the EcoPass KIT serves as an instrumental tool promoting sustainable and circular value chains. The improved transparency, traceability and accountability offered with digital product passports will facilitate informed decision-making for various stakeholders. This will bring ethical sourcing, efficient use of resources and reduction of environmental impacts to a new level. By making use of the Catena-X standards defined within the EcoPass KIT, product passports will ensure interoperability for stakeholders and systems to communicate seamlessly. This standardized language is crucial to improve efficiency, lower operational costs and create faster data processing. It ensures a consistent approach to data collection, storage and visualization to enhance the accuracy, reliability and comparability of information. -The following section will highlight the five major advantages of the Catena-X EcoPass KIT, which are also displayed below. - -#### Figure 1 - -![AdoptionView Business Value](resources/adoption-view/adoption-view-BusinessValue.png) - -**Seamless Integration and Collaboration**: By leveraging the EcoPass KIT, service providers can easily integrate with the Catena-X marketplace, promoting efficient collaboration and exchange of information with other businesses in the network. The unified data model and API specification simplifies the process, reducing the time and resources needed for integration and fostering interoperability between various players. - -**Enhanced Consumer Trust and Brand Loyalty**: Utilizing the KIT to develop solutions for the Catena-X marketplace allows service providers to showcase their commitment to transparency and sustainability. This fosters consumer trust and brand loyalty, as increasingly conscious customers prefer products and services that align with their values and make a positive impact on the environment. - -**Data-Driven Decision Making**: The EcoPass KIT enables service providers to harness the power of high-quality data sets from various sources in the Catena-X network. This wealth of information supports data-driven decision-making, helping businesses optimize their processes, reduce waste and identify opportunities for growth and innovation. Leveraging the dynamic data attributes within a passport, the product's evolving condition can be reflected, which offers a highly valuable increase of knowledge about the product’s behavior, quality and performance. - -**Regulatory Compliance and Risk Mitigation**: By offering solutions based on the KIT, service providers can help businesses comply with evolving regulations and industry standards. The increased transparency and traceability provided by digital product passports facilitate compliance management, offer the creation of certificates, and reduce the risks associated with non-compliance, such as penalties and reputational damage. - -**Competitive Advantage through Innovation**: The KIT's foundation for value-added services and innovative solutions provides service providers with a unique competitive edge in the Catena-X marketplace. By developing and offering cutting-edge products and services that cater to the growing demand for sustainable and transparent solutions, service providers can differentiate themselves in a crowded market and seize new business opportunities. - -## Use Case Explanation - -### Today's Challenges - -Today's globalized supply chains often struggle with transparency, data fragmentation and inefficiencies through the lack of digitally available product information. Traceability becomes difficult, hindering the ability to track products' origins and ensure accountability. Risk management and compliance efforts are compromised, impacting product quality and sustainability. Customer expectations for transparency and sustainability information remain unmet, potentially leading to dissatisfaction and loss of market share. Moreover, supply chains lack the resilience and responsiveness needed to adapt to disruptions effectively. -Embracing a digital product pass can address these challenges, enabling transparent, efficient and sustainable supply chains. Implementing the EcoPass KIT can enable companies to address these challenges by creating a comprehensive, accurate and up-to-date record of their products' lifecycles. This information can be used to improve resource efficiency, optimize recycling processes and reduce waste, ultimately driving the adoption of circular economy principles. - -### How can the EcoPass KIT help to address regulatory challenges? - -- Manufacturers are required to disclose information regarding the environmental impact of their products under the European Union's (EU) Ecodesign Directive. The EcoPass KIT can assist producers in adhering to this rule by offering a digital record of the environmental impact of their products. -- Companies are required to provide information regarding their efforts to address forced labor and human trafficking in their supply chains under the California Transparency in Supply Chains Act (CTSCA). The EcoPass KIT's digital record of a company's supply chain operations can assist businesses to comply with this law. -- Certain manufacturers of products are required to take back and recycle their products at the end of their functional lifespans under the German Waste Management Act (Kreislaufwirtschaftsgesetz). The EcoPass KIT, which offers a digital record of the goods that have been returned and recycled, can assist producers in adhering to this obligation. - -### Ecopass KIT benefits for value chain partners and solution providers - -Stakeholders along the value chain, as well as solution providers can reap the benefits of utilizing KITs in their organization. The [Figure 2](page-adoption-view#figure-2) below shows an overview of these benefits, further explanation can be found below the illustration. - -#### Figure 2 - -![ValueChain Benefits](resources/adoption-view/adoption-view-ValueChainBenefits.png) - - -**Value Chain Partners** can benefit from the EcoPass KIT especially by bringing the product transparency to a next level which will allow for several areas to increase the company’s value. Multiple risks (e.g. regulatory compliance) can be mitigated, cost and process efficiency may be improved, the strategic knowledge about products increases and the possibility for new business is being established. - -1. **Regulatory Compliance**: Improve compliance with regulations and industry standards by utilizing a digital product passport to demonstrate responsible sourcing, production and waste management practices. -2. **Enhanced Transparency**: Visibility of the product's condition, origins and components will lead to better decision-making and higher resource efficiency. -3. **Efficient Data Management**: Adopting a digital product pass will reduce administrative burdens and facilitate seamless data exchange between stakeholders. -4. **Increased Accountability**: A clear chain of custody for products fosters accountability among value chain participants for product quality, safety and sustainability. -5. **Risk Mitigation**: Comprehensive product data helps value chain participants to proactively identify and mitigate risks, ensuring higher product quality and safety standards. -6. **Strengthened Customer Trust**: Offering transparency of business practices and sustainability efforts builds trust with customers and enhances brand loyalty. -7. **Supply Chain Optimization**: Data-driven insights enable the optimization of supply chain processes to support the integration of sustainable approaches. -8. **Foster Collaborations**: Connecting and sharing information across the value chain facilitates collaboration with other stakeholders to promote joint efforts towards sustainability challenges. - -**Solution Providers** will gain a head start in delivering comprehensive and efficient digital product pass solutions. The pre-built features accelerate time-to-market, reduce costs and ensure a reliable, scalable and compliant system. In addition, solution providers can leverage a KIT as the basis to build their own customized solutions and to offer their customers innovative and value-driven digital product pass services in an efficient and simplified way. - -1. **New Market & Customer Base**: The possibility of developing innovative solutions and providing them through the Catena-X marketplace fosters new market opportunities and scalability of the customer base. -2. **Accelerated Time-to-Market**: The KIT provides the thematical and technical basis to build solutions, significantly reducing the time and resources required to develop digital product pass solutions. -3. **Flexibility and Customization**: While the KIT offers a solid foundation, it is designed to allow solution providers for customizing and tailoring the platform to meet specific needs and preferences of the target market and value chain participants. -4. **Risk Mitigation**: The predefined KIT tools support solution providers in reducing the risk of development errors and vulnerabilities. -5. **Cost Efficiency**: The KIT's standardized data model and open interface simplify the process of connecting to the Catena-X network, reducing the investment needs for integration. -6. **Competitive Advantage**: Adopting the KIT quickly positions solution providers in the market faster with cutting-edge services gaining a competitive advantage. -7. **Alignment with Industry Standards**: The KITs adhere to industry standards, making it easier for solution providers to align with existing supply chain ecosystems and collaborate with other stakeholders. -8. **Data Utilization**: The wealth of data available in the Catena-X network is leveraged to drive innovation and develop data-driven solutions tailored to the unique needs of various industries. - -#### Battery Pass: A real-world example - -In the automotive industry, a Battery Pass or digital product passport for batteries plays a crucial role in ensuring transparency, traceability, and sustainability in the battery supply chain. Here's a real-world example of how a digital product pass might be set up for a battery used in electric vehicles (EVs), including its benefits, illustrated below: - -#### Figure 3 - -![BP realWorldExample](resources/adoption-view/adoption-view-BatteryPass_a_example.png) - -1. **Battery Manufacturing**: During the production stage, the battery manufacturer collects and records relevant data, such as the battery's unique identifier, type and model, manufacturing date and location, energy capacity and raw materials composition, including the content of critical elements like lithium, cobalt and nickel. -2. **Supply Chain Transparency**: Information about the battery's sourcing, manufacturing and distribution processes is documented, ensuring compliance with environmental and social standards. This includes data on the origin of raw materials, labor practices and the environmental footprint of each stage of the supply chain. -3. **Vehicle Integration**: When the battery is integrated into an electric vehicle, the Battery Pass is linked to the car's unique identification number (VIN), allowing seamless tracking and communication between the battery, the vehicle and relevant stakeholders. -4. **In-Use Performance Tracking**: As the vehicle is used, the Battery Pass continuously collects data on the battery's performance, such as its state of charge, charging cycles and degradation over time. This information is essential for the vehicle owner, automaker and service providers to monitor the battery's health and optimize its lifespan. -5. **End-of-Life Management**: When the battery reaches the end of its useful life, the Battery Pass provides detailed instructions for proper disposal and recycling, ensuring compliance with regulations and facilitating the recovery of valuable materials. The data stored in the Battery Pass helps recycling facilities to efficiently process the battery, reducing waste and promoting a circular economy. - -Throughout this process, the Battery Pass serves as a single, secure, and easily accessible source of information for various stakeholders, such as vehicle manufacturers, suppliers, service providers, regulators and vehicle owners. By implementing a digital product passport like the Battery Pass in the automotive industry, companies can promote transparency, traceability, and sustainability, ultimately contributing to a more eco-friendly and circular economy. - - -### How the KIT can help - -The EcoPass KIT addresses the real-world problem of battery traceability and sustainability in the automotive industry by providing a standardized, easy-to-implement solution for creating and managing digital product passports. Here's how the EcoPass KIT can help and scale in this context: - -1. **Standardization and Interoperability**: The EcoPass KIT offers a unified data model and is planning an API specification, allowing for seamless integration across different stakeholders, including manufacturers, suppliers, service providers and regulatory bodies. This standardization promotes interoperability and streamlines communication throughout the battery lifecycle. -2. **Simplified Adoption**: By providing a comprehensive and easy-to-use KIT, EcoPass can lower the barrier to entry for businesses of all sizes, enabling them to implement digital product passports without extensive technical expertise or resources. This can encourage widespread adoption of the solution, resulting in a larger-scale positive impact on sustainability and traceability. -3. **Scalable Solution**: The EcoPass KIT is designed to accommodate various product types, sizes and applications, ensuring its relevance and adaptability to the evolving automotive industry. This scalability allows the KIT to be utilized for a wide range of battery technologies, facilitating its adoption across diverse sectors. -4. **Enhanced Data Quality and Analysis**: The EcoPass KIT enables the collection and management of high-quality data throughout the product lifecycle. This wealth of information can be used by stakeholders to make data-driven decisions, optimize processes and identify opportunities for innovation and improvement in battery design, manufacturing and recycling. -5. **Facilitated Regulatory Compliance**: With the EcoPass KIT in place, businesses can more easily comply with the evolving regulations and industry standards related to battery traceability and sustainability. The digital product passport provides a comprehensive record of the battery's lifecycle, supporting compliance management and reducing the risk of penalties and reputational damage. - -By providing a standardized, scalable and easy-to-adopt solution, the EcoPass KIT will play a significant role in addressing the challenges of product traceability and sustainability in the automotive industry, promoting a more transparent, environmentally friendly and circular economy. - -## Semantic Models - -Depending on the use case and related KIT, Catena-X provides different semantic models that help to structure and make use of data via semantic information. These models help to provide a basic meaning to the data and their relationship, thereby enabling interoperability between data sets. Catena-X data models rely on principles as understandability, standardization, accuracy, differentiation, auditability, comprehensiveness, and provision of insights to drive improvement actions. -In its first version the KIT entails the data models Battery Pass and Transmission Pass, further data models will follow. The goal of these passports is to create unified data models that can be used and adapted across the automotive industry. These data models follow the Catena-X Standards [CX-0034](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/Sustainability_Use_Case_Circular_Economy/CX_-_0034_Data_Model_BatteryPass_UseCase_CE_v_1.0.1.pdf), CX-0095 (insert once published) and are modeled according to the [CX-0003](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Archiv/Update_Juli_23_R_3.2/CX-0003-SAMMSemanticAspectMetaModel-v.1.0.2.pdf) BAMM Standard (BAMM has been renamed to SAMM thereafter) in Version 1.0.0 . For detailed information please follow the embedded links to the Catena-X Standard library. - -### Battery Pass - -#### Battery Pass Introduction - -The Catena-X standards, which are crucial to create a more sustainable battery business, serve as the foundation for the data model behind the Battery Pass. The Battery Pass assists in enhancing the traceability and sustainability of batteries by offering a thorough record of a battery's life cycle. This will mitigate the battery industry's environmental effect and make it easier to recycle batteries. -Accordingly, the Battery Pass establishes the fundamental framework for digital infrastructures aimed at documenting and facilitating the exchange of essential information and update-relevant technical data. Specifically, it focuses on data that provides a comprehensive account of supply chain responsibility, e.g. the carbon footprint, working conditions during raw material extraction and the assessment of battery conditions. It is structured according to the following categories: - -- General Information -- Product Condition -- Composition -- Cell Chemistry -- Electrochemical Properties -- Additional Information - In addition, the Battery Pass data model offers the following advantages: -- It is self-describing, which means it has all the details necessary to comprehend what it includes. Different systems can easily interpret the Battery Pass as a result. -- It is extendable, therefore new information can be added without much difficulty. As a result, the Battery Pass will be able to adapt to the changing requirements of the battery sector. -- It establishes a common semantic in Catena-X which other passes can build upon. - -#### Link to current model - -The semantic models are located [here](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/38605f6ddf19a0b4540dd483720d1d8c057ca332/io.catenax.battery.battery_pass). For each version there is a separated directory containing the ttl-file and a generated samples. - -#### Example Payload - -```json -{ - "electrochemicalProperties": { - "ratedCapacity": 210, - "batteryEnergy": { "foo": "bar" }, - "ratioMaximumAllowedBatteryPowerAndMaximumAllowedBatteryEnergy": 0.611, - "batteryVoltage": { "foo": "bar" }, - "internalResistance": { "foo": "bar" }, - "capacityThresholdExhaustion": 23, - "batteryPower": { "foo": "bar" }, - "capacityFade": 34 - }, - "document": { - "responsibleSourcing": [{ "foo": "bar" }], - "packagingInstructions": [{ "foo": "bar" }], - "transportationInstructions": [{ "foo": "bar" }], - "vehicleDismantlingProcedure": [{ "foo": "bar" }], - "testReportsResults": [{ "foo": "bar" }], - "batteryDismantlingProcedure": [{ "foo": "bar" }], - "safetyMeasures": [{ "foo": "bar" }], - "declarationOfConformity": [{ "foo": "bar" }] - }, - "datePlacedOnMarket": "2023-03-14T17:10:25.344+01:00", - "cellChemistry": { "foo": "bar" }, - "physicalDimensions": { "foo": "bar" }, - "temperatureRangeIdleState": { "foo": "bar" }, - "batteryCycleLife": { "foo": "bar" }, - "manufacturer": { "foo": "bar" }, - "warrantyPeriod": 60, - "composition": { "foo": "bar" }, - "manufacturing": { "foo": "bar" }, - "batteryIdentification": { "foo": "bar" }, - "stateOfBattery": { - "stateOfHealth": 12, - "statusBattery": "first life/ waste/ repaired/ repurposed/ recycled", - "stateOfCharge": 23 - }, - "cO2FootprintTotal": 124.0 -} -``` - -### Transmission Pass - -#### Transmission Pass Introduction - -In addition to the Battery Pass, numerous other components will require digital product passports. One example is the vehicle transmission, for which a standardized passport already exists. The Transmission Passport serves as tool for advancing a sustainable and circular transmission value chain. -To enable stakeholders to access relevant data, the passport leverages Catena-X shared services, a standardized data model, and an application. The initial version of the Transmission Passport model includes the following information: - -- Transmission Identification -- General Information -- Sustainability Information -- State of Health Information -- Product Specific Parameters -- Instructions -- Track and Trace Data - -By incorporating circularity parameters, the Transmission Passport aims to enhance transparency and promote a circular economy within the European Union. Detailed descriptions can be found in the Ecodesign for Sustainable Products Regulation Proposal (ESPR). This proposal identifies content clusters for circularity and establishes concrete circularity parameters for the Transmission Passport. The data sets encompass information relevant to both closed and open loop business models. -It is important to note that the data model includes optional and mandatory information fields to fulfill regulatory requirements. Sharing information within the network relies on decentralized technologies and is always subject to individual decisions by each provider. The data model aligns with the newly proposed Ecodesign Regulation (ESPR-2022) and will be continuously adapted to changing circumstances. As one of the first extensions of the EcoPass KIT, more product passes are expected soon to serve the demand of data models across the automotive industry. -Link to current model - -#### Link to current model - -The semantic models are located [here](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/38605f6ddf19a0b4540dd483720d1d8c057ca332/io.catenax.transmission.transmission_pass). For each version there is a separated directory containing the ttl-file and a generated samples. - -#### Example Payload - -```json -{ - "productSpecificParameters": { - "torqueConverter": ["RYtGKbgicZaHCBRQDSx"], - "driveType": "combustion engine", - "oilType": "ZF Lifeguard Hybrid 2", - "spreading": 6.79, - "torque": 500.0, - "power": 300.0, - "standardGearRatio": { - "gear": "1", - "ratio": 4.1567 - }, - "oilCapacity": 8.9, - "electricPerformance": ["VLhpfQGTMDYpsBZxvfBoeygjb"], - "speedResistance": { - "speed": 7800, - "gear": "1" - } - }, - "instructions": { - "packagingInstructions": [{ "foo": "bar" }], - "transportationInstructions": [{ "foo": "bar" }], - "dismantlingProcedure": [{ "foo": "bar" }], - "safetyMeasures": [{ "foo": "bar" }], - "vehicleDismantlingProcedure": [{ "foo": "bar" }] - }, - "identification": { - "manufacturerId": "BPNL1234567890ZZ", - "localIdentifiers": [{ "foo": "bar" }], - "dataMatrixCode": "UMaAIKKIkknjWEXJUfPxxQHeWKEJ" - }, - "sparePartSupplier": [{ "foo": "bar" }], - "stateOfHealth": { "foo": "bar" }, - "generalInformation": { "foo": "bar" }, - "sustainability": { "foo": "bar" } -} -``` - -## Business Architecture - -The Business Architecture illustrates the interaction between the EcoPass KIT and other KITs, components, data models, and artifacts used for identity and access management, illustrated by the [Figure 4](page-adoption-view#figure-4) below. - -#### Figure 4 - -![Image: Business Architecture](resources/adoption-view/adoption-view-EcoPassKITBusinessArch.png) - -The core of the network is to provide interoperability between different applications. For this reason, a common semantic is indispensable. In the Catena-X ecosystem, it has been agreed to use the description language SAMM to describe data models. -To additionally provide a standardized interface, the open standard of the International Digital Twin Association (IDTA) is used, abbreviated as IDTA. This standard corresponds to the Asset Administration Shell (AAS). -It is used to discover digital twins and exchange actual usage data. -To control access to both usage and meta data, the EcoPass KIT relies on the [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/kits/tractusx-edc/docs/kit/adoption-view/Adoption%20View/). Interactions between two parties occur exclusively peer-to-peer via the standardized interfaces of the Connector KIT, based on the International Data Space Protocol. -Data sovereignty is enabled by so-called verifiable credentials. These rely on the technology of Self-Sovereign Identity (SSI) and are enabled through the Connector KIT. In short, consumers must present their signed credentials, defined by a data provider, before a data contract (and thus a data exchange) can take place. It should be mentioned that this concept is still in the prototype phase as of Release 3.2 and will be expanded in future releases. - -## NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - -- SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2023 Robert Bosch GmbH -- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2023 T-Systems International GmbH -- SPDX-FileCopyrightText: 2023,2023 SAP SE -- SPDX-FileCopyrightText: 2023,2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. für ihre Institute IPK und IPK -- SPDX-FileCopyrightText: 2023,2023 BASF SE -- SPDX-FileCopyrightText: 2023,2023 Henkel AG & Co. KGaA -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: diff --git a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/page-software-development-view.md b/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/page-software-development-view.md deleted file mode 100644 index f7b6dcd5077..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/page-software-development-view.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: Development View ---- - -## Introduction - -### General Development Information - -The developer view provides developers with resources to utilize the EcoPass KIT effectively. On the one side developers can learn how to integrate the EcoPass KIT into their applications and to make use of the product passport exchanging feature via the Catena-X network. On the other side, IT-Administrators will learn how to provide the needed passport data and which components are required. -Thereby, this KIT covers various aspects, starting from how the available API Endpoints can be utilized for data models and how to make them available in the Catena-x Data Space. - -### Architecture Overview - -The following [Figure 1](page-software-development-view#figure-1) shows how the EcoPass KIT (represented by Product Passport Frontend and Backend) is embedded in the overall architecture. - -#### Figure 1 - -![EcoPassKIT IT Arch Picture](resources/development-view/adoption-view-EcoPassKIT_IT_Arch.png) - -After authorization, the sequence diagram below [Figure 2](page-software-development-view#figure-2) illustrates the identification process of the decentral Digital Twin Registry. The process is divided into 25 steps, starting within the Data Consumer Environment, which is providing the digital product passport consumer application/service. In summary, the sequence details the interaction of EDC(s), corresponding BPN(s), and the decentral Digital Twin Registry (dDTR). It also illustrates how the consumer not only requests data via the EDC(s), but also how the data is exchanged via the provider, thereby leveraging the EDC component at all stages. The sequence is concluded by data requests for digital twins and corresponding sub models. - -The Figure below describes the process of searching for a DPP based on a part identification. The process shown in the figure assumes that the following conditions are met. The consumer has a part identifier and wants to obtain the corresponding digital twin. It also assumes that the consumer knows the BPN of the data room participant that is the owner of the digital twin. -This process can be roughly divided into three steps. In the first step, [001] to [006], the EDCs of the data provider are identified. Then, the consumer has received a list of EDC endpoints, all belonging to the data space participant that can provide the requested digital twin. In the second step, calls [007] to [011], the consumer determines which specific DTR asset to query to obtain the correct DPP. This is accomplished by traversing the received list of EDC endpoints until the DTR asset that can provide the DPP being sought is found. Once the DTR facility is located, the contract negotiation workflow is initiated by the consumer. During this workflow, it is determined if the consumer has the necessary rights to access and receive the DPP they are looking for. The rights are dependend on the frame contracts the consumer aggreed to. On top the provider can white or blacklist ceratain BPNs which ensures that the provider has full controll of their data. At this point, the consumer knows where to find the DPP, and a usage and access policy is negotiated. In the last step, calls [012] to [023], the actual retrieval of the DPP is performed. In order to retrieve the DPP, its unique identifier (UUID) is required. This UUID is determined by retrieving the DPP that is associated with the part ID. After retrieving the UUID, the consumer requests the asset. - -#### Figure 2 - -![Sequence Diagramm](resources/development-view/developmentview-sequence-diagramm.svg) - -#### API calls - -| Call | Method | Path | Params | -| ------ | ------ | -------------------------------------------------- | ------------------------------------------ | -| [001] | POST | /api/administration/connectors/discovery/search | key:ManufactureID | -| [003] | POST | /api/administration/connectors/bpnDiscovery/search | key:ManufactureID | -| [005] | POST | /api/administration/connectors/discovery/search | `{[]}` | -| [0012] | GET | /lookup/shells | key:partInstanceID, value: batteryDMC-Code | - -## API Specification - -| Service Name | Description | Reference Implementation | Standardization Number | -| --------------------- | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Portal/IAM | Portal | [Portal](https://github.com/eclipse-tractusx/portal-backend) | [CX - 0015](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/4_IAM/CX_-_0015_IAM___Access_Control_Paradigm_PlatformCapabilityIAM_v_1.0.1.pdf) | -| Discovery Finder | A microservice resolving a type of identifiers against a set of BPN-Discovery Servers. | [Tractus-X Discovery Finder](https://github.com/eclipse-tractusx/sldt-discovery-finder) | [CX - 0053](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Archiv/Update_Juli_23_R_3.2/CX-0053-BPNDiscoveryServiceAPIs.pdf) | -| BPN Discovery Service | A microservice resolving a particular assetId against the registered BPN of its owner. | [Tractus-X BPN Discovery](https://github.com/eclipse-tractusx/sldt-bpn-discovery) | [CX - 0053](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Archiv/Update_Juli_23_R_3.2/CX-0053-BPNDiscoveryServiceAPIs.pdf) | -| EDC Discovery Service | A microservice that resolves a BPN against an EDC endpoint. | [Tractus-X Portal including EDC Discovoery API](https://github.com/eclipse-tractusx/portal-backend) | [CX - 0001](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/9_Data-Discovery-Services/CX_-_0001_EDC_DISCOVERY_API_PlatformCapabilityDS_v_1.0.1-1.pdf) | -| EDC | Eeclipse Dataspace Connector | [Tractus-X EDC](https://github.com/eclipse-tractusx/tractusx-edc) | [CX - 0018](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/3_Sovereign_Data_Exchange/CX_-_0018_EDC_PlatformCapabilitySovereignDataExchange_v_1.0.1.pdf) | - -Please note: In order to provide a passport asset for consumption a corresponding offer must exist. Please refer to “[Setup Data Offer](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/docs/samples/Transfer%20Data.md#2-setup-data-offer)” in the EDC documentation. - -## Reference Implementationfernce - -A reference implementation and a corresponding documentation can be found [here](https://github.com/eclipse-tractusx/digital-product-pass/tree/main). - -This reference includes a frontend and a backend allowing users to look up and display Battery Passport assets. -The Helm charts of this reference implementation are located [here](https://github.com/eclipse-tractusx/digital-product-pass/tree/main/charts/digital-product-pass). - -### Documentation in the context development - -The following represents a collection of relevant documentation regarding the presented adaptation and all related services: - -**[EDC Domain Model](https://github.com/eclipse-edc/Connector/blob/main/docs/developer/architecture/domain-model.md)** - -**[Reference Implementation (+Arch42)](https://github.com/eclipse-tractusx/digital-product-pass/tree/main/docs)** - -## NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - -- SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2023 Robert Bosch GmbH -- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2023 T-Systems International GmbH -- SPDX-FileCopyrightText: 2023,2023 SAP SE -- SPDX-FileCopyrightText: 2023,2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. für ihre Institute IPK und IPK -- SPDX-FileCopyrightText: 2023,2023 BASF SE -- SPDX-FileCopyrightText: 2023,2023 Henkel AG & Co. KGaA -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: diff --git a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BatteryPass_a_example.png b/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BatteryPass_a_example.png deleted file mode 100644 index 4f06b81bb74..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BatteryPass_a_example.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BatteryPass_a_example.png.license b/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BatteryPass_a_example.png.license deleted file mode 100644 index e24cf459351..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BatteryPass_a_example.png.license +++ /dev/null @@ -1,15 +0,0 @@ -## NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - -- SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2023 Robert Bosch GmbH -- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2023 T-Systems International GmbH -- SPDX-FileCopyrightText: 2023,2023 SAP SE -- SPDX-FileCopyrightText: 2023,2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. für ihre Institute IPK und IPK -- SPDX-FileCopyrightText: 2023,2023 BASF SE -- SPDX-FileCopyrightText: 2023,2023 Henkel AG & Co. KGaA -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/eco-pass-kit diff --git a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BusinessValue.png b/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BusinessValue.png deleted file mode 100644 index c877cf39ec0..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BusinessValue.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BusinessValue.png.license b/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BusinessValue.png.license deleted file mode 100644 index e24cf459351..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BusinessValue.png.license +++ /dev/null @@ -1,15 +0,0 @@ -## NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - -- SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2023 Robert Bosch GmbH -- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2023 T-Systems International GmbH -- SPDX-FileCopyrightText: 2023,2023 SAP SE -- SPDX-FileCopyrightText: 2023,2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. für ihre Institute IPK und IPK -- SPDX-FileCopyrightText: 2023,2023 BASF SE -- SPDX-FileCopyrightText: 2023,2023 Henkel AG & Co. KGaA -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/eco-pass-kit diff --git a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-EcoPassKITBusinessArch.png b/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-EcoPassKITBusinessArch.png deleted file mode 100644 index 7ec80e269c3..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-EcoPassKITBusinessArch.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-EcoPassKITBusinessArch.png.license b/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-EcoPassKITBusinessArch.png.license deleted file mode 100644 index e24cf459351..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-EcoPassKITBusinessArch.png.license +++ /dev/null @@ -1,15 +0,0 @@ -## NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - -- SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2023 Robert Bosch GmbH -- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2023 T-Systems International GmbH -- SPDX-FileCopyrightText: 2023,2023 SAP SE -- SPDX-FileCopyrightText: 2023,2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. für ihre Institute IPK und IPK -- SPDX-FileCopyrightText: 2023,2023 BASF SE -- SPDX-FileCopyrightText: 2023,2023 Henkel AG & Co. KGaA -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/eco-pass-kit diff --git a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-ValueChainBenefits.png b/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-ValueChainBenefits.png deleted file mode 100644 index 4cc9b0d5ce1..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-ValueChainBenefits.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-ValueChainBenefits.png.license b/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-ValueChainBenefits.png.license deleted file mode 100644 index e24cf459351..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-ValueChainBenefits.png.license +++ /dev/null @@ -1,15 +0,0 @@ -## NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - -- SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2023 Robert Bosch GmbH -- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2023 T-Systems International GmbH -- SPDX-FileCopyrightText: 2023,2023 SAP SE -- SPDX-FileCopyrightText: 2023,2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. für ihre Institute IPK und IPK -- SPDX-FileCopyrightText: 2023,2023 BASF SE -- SPDX-FileCopyrightText: 2023,2023 Henkel AG & Co. KGaA -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/eco-pass-kit diff --git a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/development-view/adoption-view-EcoPassKIT_IT_Arch.png b/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/development-view/adoption-view-EcoPassKIT_IT_Arch.png deleted file mode 100644 index 713ca78a154..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/development-view/adoption-view-EcoPassKIT_IT_Arch.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/development-view/adoption-view-EcoPassKIT_IT_Arch.png.license b/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/development-view/adoption-view-EcoPassKIT_IT_Arch.png.license deleted file mode 100644 index e24cf459351..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/development-view/adoption-view-EcoPassKIT_IT_Arch.png.license +++ /dev/null @@ -1,15 +0,0 @@ -## NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - -- SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2023 Robert Bosch GmbH -- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2023 T-Systems International GmbH -- SPDX-FileCopyrightText: 2023,2023 SAP SE -- SPDX-FileCopyrightText: 2023,2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. für ihre Institute IPK und IPK -- SPDX-FileCopyrightText: 2023,2023 BASF SE -- SPDX-FileCopyrightText: 2023,2023 Henkel AG & Co. KGaA -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/eco-pass-kit diff --git a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/development-view/developmentview-sequence-diagramm.svg b/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/development-view/developmentview-sequence-diagramm.svg deleted file mode 100644 index b1604843f59..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/development-view/developmentview-sequence-diagramm.svg +++ /dev/null @@ -1 +0,0 @@ -Data Provider EnviromentCatenaX DeploymentDataConsumer EnviromentdDTRProviderEDCEDCDiscoveryServiceBPNDiscoveryServiceDiscoveryFinderConsumerEDCConsumerApplicationdDTRProviderEDCEDCDiscoveryServiceBPNDiscoveryServiceDiscoveryFinderConsumerEDCConsumerApplicationloop[for each EDC inList][001] Request BPN Discovery Endpoints[002] Response Collection of Endpoints[003] Request BPN(s) based on key value pairs[004] Response BPNs[005] Request EDC Enpoints based on BPNs[006] Response EDC Endpoints[007] Request Data Catalogue[008] Request Data Catalogue[009] Response Catalogue based on policies[010] Catalogue[011] Search for DTR Asset[012] Request digital twin of batteries with partInstanceID[013] Request digital twin of batteries with partInstanceID[014] Request digital twin of batteries with partInstanceID[015] Response DT UUID of batteries matching the key-value pair[016] Response DT UUID of batteries matching the key-value pair[017] DT UUID of batteries matching the key-value pair[018] Request sub-model based on DT UUID[019] Request sub-model based on DT UUID[020] Request sub-model based on DT UUID[021] Reponse passport sub-model[022] Reponse passport sub-model[023] Reponse passport sub-model \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/development-view/developmentview-sequence-diagramm.svg.license b/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/development-view/developmentview-sequence-diagramm.svg.license deleted file mode 100644 index e24cf459351..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Eco_Pass_KIT/resources/development-view/developmentview-sequence-diagramm.svg.license +++ /dev/null @@ -1,15 +0,0 @@ -## NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - -- SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2023 Robert Bosch GmbH -- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2023 T-Systems International GmbH -- SPDX-FileCopyrightText: 2023,2023 SAP SE -- SPDX-FileCopyrightText: 2023,2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. für ihre Institute IPK und IPK -- SPDX-FileCopyrightText: 2023,2023 BASF SE -- SPDX-FileCopyrightText: 2023,2023 Henkel AG & Co. KGaA -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/eco-pass-kit diff --git a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/Software Development View/osim-api.info.mdx b/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/Software Development View/osim-api.info.mdx deleted file mode 100644 index 41bc0e32c22..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/Software Development View/osim-api.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: osim-api -title: "OSim API" -description: "OSim API for requesting and receiving simulation results" -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: 1.0.0 - -# OSim API - - - -OSim API for requesting and receiving simulation results - - - \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/Software Development View/page_software-development-view.md deleted file mode 100644 index 9677c4eb49c..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/Software Development View/page_software-development-view.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -id: Specification OSim Kit -title: Specification -description: 'OSim Kit' -sidebar_position: 4 ---- - -![osim kit banner](@site/static/img/OSimKitIcon.svg) - -### OSim Kit - -## Sample Data - -The following example shows the payload used for exchange of simulation results between the OSim partners. The format corresponds with AAS format serialized as a JSON string. - -```json -{ - "owner": { "id": "BPNL00000007OTZ3" }, - "dataQuality": 1, - "description": "Daily standard simulation", - "comment": "successful simulation", - "expirationTimestamp": "2023-03-24T09:15:24.000Z", - "runId": "0fece48b-c8d1-4180-1a9caca6d67e", - "shipments": [ - { - "handlingUnits": [ - { - "name": "Palette", - "volume": 1, - "weight": 189, - "batches": [ - { - "unitOfMeasurement": "KG", - "materialName": "KK1000GR-Gehäuse-Rot", - "quantity": 50, - "materialNumber": "KK1000GR", - "batchOrderId": "Order-0001", - "batchId": "Batch_1", - "hazardousGoods": false, - "batchExpirationTimestamp": "2023-08-22T16:00:00.000Z", - "batchNumber": "45" - } - ], - "handlingUnitId": "HUT_1", - "amount": 1 - } - ], - "shipmentId": "DE51515151", - "recipientTimestampPlanned": "2023-04-19T09:00:00.000Z", - "destination": { "id": "BPNL00000007OTZ3" }, - "recipient": { "id": "BPNL00000007OTZ4" }, - "logistics": { "id": "BPNL00000007OS0H" }, - "preceding": {}, - "splittingAllowed": true, - "destinationTimestamp": "2023-03-19T09:00:00.000Z" - } - ], - "timestamp": "2023-03-09T14:13:42.806Z" -} -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/Software Development View/receive-latest-simulation-result.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/Software Development View/receive-latest-simulation-result.api.mdx deleted file mode 100644 index 15de750ef50..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/Software Development View/receive-latest-simulation-result.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: receive-latest-simulation-result -title: "receiveLatestSimulationResult" -description: "Receive latest simulation result which can be stored in own OSim Manager instance" -sidebar_label: "receiveLatestSimulationResult" -hide_title: true -hide_table_of_contents: true -api: {"tags":["receiveLatestSimulationResult"],"description":"Receive latest simulation result which can be stored in own OSim Manager instance","operationId":"receiveLatestSimulationResult","parameters":[{"name":"requestId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8d628899-3e6f-4666-91c3-74ee7ab88b2b"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"owner":{"type":"object","properties":{"id":{"type":"string"}}},"dataQuality":{"type":"integer"},"description":{"type":"string"},"comment":{"type":"string"},"expirationTimestamp":{"type":"string"},"runId":{"type":"string"},"shipments":{"type":"array","items":{"type":"object","properties":{"handlingUnits":{"type":"array","items":{"type":"object","properties":{"volume":{"type":"integer"},"batches":{"type":"array","items":{"type":"object","properties":{"unitOfMeasurement":{"type":"string"},"materialName":{"type":"string"},"quantity":{"type":"integer"},"materialNumber":{"type":"string"},"batchOrderId":{"type":"string"},"batchId":{"type":"string"},"hazardousGoods":{"type":"boolean"},"batchExpirationTimestamp":{"type":"string"},"batchNumber":{"type":"string"}}}},"handlingUnitId":{"type":"string"},"amount":{"type":"integer"},"name":{"type":"string"},"weight":{"type":"integer"}}}},"shipmentId":{"type":"string"},"recipientTimestampPlanned":{"type":"string"},"destination":{"type":"object","properties":{"id":{"type":"string"}}},"recipient":{"type":"object","properties":{"id":{"type":"string"}}},"logistics":{"type":"object","properties":{"id":{"type":"string"}}},"preceding":{"type":"object","properties":{}},"splittingAllowed":{"type":"boolean"},"destinationTimestamp":{"type":"string"}}}},"timestamp":{"type":"string"}}},"examples":{"0":{"value":"{ \n \"owner\": { \"id\": \"BPNL00000007OTZ3\" }, \n \"dataQuality\": 1, \n \"description\": \"Daily standard simulation\", \n \"comment\": \"successful simulation\", \n \"expirationTimestamp\": \"2023-03-24T09:15:24.000Z\", \n \"runId\": \"0fece48b-c8d1-4180-1a9caca6d67e\", \n \"shipments\": [ \n { \n \"handlingUnits\": [ \n { \n \"name\": \"Palette\", \n \"volume\": 1, \n \"weight\": 189, \n \"batches\": [ \n { \n \"unitOfMeasurement\": \"KG\", \n \"materialName\": \"KK1000GR-Gehäuse-Rot\", \n \"quantity\": 50, \n \"materialNumber\": \"KK1000GR\", \n \"batchOrderId\": \"Order-0001\", \n \"batchId\": \"Batch_1\", \n \"hazardousGoods\": false, \n \"batchExpirationTimestamp\": \"2023-08-22T16:00:00.000Z\", \n \"batchNumber\": \"45\" \n } \n ], \n \"handlingUnitId\": \"HUT_1\", \n \"amount\": 1 \n } \n ], \n \"shipmentId\": \"DE51515151\", \n \"recipientTimestampPlanned\": \"2023-04-19T09:00:00.000Z\", \n \"destination\": { \"id\": \"BPNL00000007OTZ3\" }, \n \"recipient\": { \"id\": \"BPNL00000007OTZ4\" }, \n \"logistics\": { \"id\": \"BPNL00000007OS0H\" }, \n \"preceding\": {}, \n \"splittingAllowed\": true, \n \"destinationTimestamp\": \"2023-03-19T09:00:00.000Z\" \n } \n ], \n \"timestamp\": \"2023-03-09T14:13:42.806Z\" \n}"}}}}},"responses":{"200":{"description":"Simulation Result Received","content":{"text/html; charset=utf-8":{"schema":{"type":"string"},"examples":{}}}}},"servers":[{"url":"https://{server-url}"}],"method":"post","path":"/api/receiveLatestSimulationResult/requestId/{requestId}","jsonRequestBodyExample":{"owner":{"id":"string"},"dataQuality":0,"description":"string","comment":"string","expirationTimestamp":"string","runId":"string","shipments":[{"handlingUnits":[{"volume":0,"batches":[{"unitOfMeasurement":"string","materialName":"string","quantity":0,"materialNumber":"string","batchOrderId":"string","batchId":"string","hazardousGoods":true,"batchExpirationTimestamp":"string","batchNumber":"string"}],"handlingUnitId":"string","amount":0,"name":"string","weight":0}],"shipmentId":"string","recipientTimestampPlanned":"string","destination":{"id":"string"},"recipient":{"id":"string"},"logistics":{"id":"string"},"preceding":{},"splittingAllowed":true,"destinationTimestamp":"string"}],"timestamp":"string"},"info":{"title":"OSim API","description":"OSim API for requesting and receiving simulation results","version":"1.0.0"},"postman":{"name":"receive Latest Simulation Result","description":{"content":"Receive latest simulation result which can be stored in own OSim Manager instance","type":"text/plain"},"url":{"path":["api","receiveLatestSimulationResult","requestId",":requestId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"requestId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/html; charset=utf-8"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/OSim Kit/Software Development View//osim-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## receiveLatestSimulationResult - - - -Receive latest simulation result which can be stored in own OSim Manager instance - -
Path Parameters
Request Body
    owner object
    shipments object[]
    handlingUnits object[]
    batches object[]
    destination object
    recipient object
    logistics object
    preceding object
- -Simulation Result Received - -
Schema
  • string
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/Software Development View/request-latest-simulation-result.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/Software Development View/request-latest-simulation-result.api.mdx deleted file mode 100644 index a1d336d24e5..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/Software Development View/request-latest-simulation-result.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: request-latest-simulation-result -title: "requestLatestSimulationResult" -description: "Request latest simulation result by referring the latest simulation run id available in own OSim Manager" -sidebar_label: "requestLatestSimulationResult" -hide_title: true -hide_table_of_contents: true -api: {"tags":["requestLatestSimulationResult"],"description":"Request latest simulation result by referring the latest simulation run id available in own OSim Manager","operationId":"requestLatestSimulationResult","parameters":[{"name":"requestId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8d628899-3e6f-4666-91c3-74ee7ab88b2b"},{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"bbf461bf-28d5-4fc2-95fa-7697eb122f48"},{"name":"simulationRunId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"50737df3-4237-4652-b092-1ef8649f6ca6"}],"responses":{"200":{"description":"Request Received","content":{"text/html; charset=utf-8":{"schema":{"type":"string"},"examples":{}}}}},"servers":[{"url":"https://{server-url}"}],"method":"get","path":"/api/requestLatestSimulationResult/bpns/{bpns}/requestId/{requestId}/simulationRunId/{simulationRunId}","info":{"title":"OSim API","description":"OSim API for requesting and receiving simulation results","version":"1.0.0"},"postman":{"name":"request Latest Simulation Result","description":{"content":"Request latest simulation result by referring the latest simulation run id available in own OSim Manager","type":"text/plain"},"url":{"path":["api","requestLatestSimulationResult","bpns",":bpns","requestId",":requestId","simulationRunId",":simulationRunId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"requestId"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"simulationRunId"}]},"header":[{"key":"Accept","value":"text/html; charset=utf-8"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/OSim Kit/Software Development View//osim-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## requestLatestSimulationResult - - - -Request latest simulation result by referring the latest simulation run id available in own OSim Manager - -
Path Parameters
- -Request Received - -
Schema
  • string
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/Software Development View/sidebar.js b/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/Software Development View/sidebar.js deleted file mode 100644 index 9917ad405d8..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/Software Development View/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/OSim Kit/Software Development View//osim-api"},{"type":"category","label":"requestLatestSimulationResult","link":{"type":"generated-index","title":"requestLatestSimulationResult","slug":"/category/kits/OSim Kit/Software Development View/request-latest-simulation-result"},"items":[{"type":"doc","id":"kits/OSim Kit/Software Development View//request-latest-simulation-result","label":"requestLatestSimulationResult","className":"api-method get"}]},{"type":"category","label":"receiveLatestSimulationResult","link":{"type":"generated-index","title":"receiveLatestSimulationResult","slug":"/category/kits/OSim Kit/Software Development View/receive-latest-simulation-result"},"items":[{"type":"doc","id":"kits/OSim Kit/Software Development View//receive-latest-simulation-result","label":"receiveLatestSimulationResult","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/architecture.png b/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/architecture.png deleted file mode 100644 index 80d9760beb1..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/architecture.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/businessProcess.png b/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/businessProcess.png deleted file mode 100644 index 8d6f1b493e3..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/businessProcess.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/page_adoption-view.md deleted file mode 100644 index 9e4ae2132ef..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/page_adoption-view.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -id: Adoption View OSim Kit -title: Adoption View -description: 'OSim Kit' -sidebar_position: 2 ---- - -![osim kit banner](@site/static/img/OSimKitIcon.svg) - -### OSim Kit - -## Vision & Mission - - -**Gain increased supply chain transparency through collaborative simulation across all stakeholders** - -**Combine simulations of plants internally with simulations of external logistics over multiple tiers** - -Online control and simulation aims at linking production simulation with logistics simulation in order to identify delivery problems earlier and react in response to changing customer requirements or external disturbances/events -The online control and simulation (OSim) Kit defines the mechanisms and services needed to enable every Catena-X partner (producer as well as logisticians) to exchange simulation results in an open, interoperable and Catena-X compliant way. -An open architecture for integrating partners of all kinds together with standardized interfaces and semantics models are the fundamental basis of the OSim Kit. - -**Integrate any supply chain partner** - -Even partners that are not using any simulation tool can contribute to the overall transparency through the well-defined information requirements. - -**Integrate any simulation tool** - -Thanks to open architecture OSim is independent of the simulation tools that partners use. - -## Business Value - -Conventional planning and simulation tools use material flow simulations only on the plant level but they don't exchange simulation results with their respective partners in the supply chain. OSim goes beyond this by enabling every Catena-X partner (producers as well as logisticians) to integrate material flow simulation results of their partners into the simulation of their own processes. This is achieved by sharing the material flow simulation results on supply chain level. - -The simulation results of the Catena-X partners on the supply chain's lower tier level and logistics, together with data of the company's own operations are fed into a simulation model as input. Considering both, plannable and unpredictable influencing factors, this simulation model is iterated as often as necessary until an optimal result has been found. Sharing of simulation results to the next tier level is the core capability of the collaborative simulation approach. - -A central application takes over the tasks of monitoring and controlling the transmission of the simulation results, regardless of the level of digitalization of the partners. In addition, this application takes over the control of the simulation tools used. - -![Example of an OSim partner network from the perspective of the producing company WERK-76](./werk76.png) - -Benefits for OEM, SME and Solution Provider - -- Collaborative simulation over the supply chain -- Linking production simulation and logistics simulation -- Early detection and reaction to delivery problems -- Early response to changing customer requirements -- Take external disturbances/events into account early - -## Business Process - -The simulation results of the Catena-X partners on the lower tier level and logistics, together with data of the company's own operations are fed into the individual simulation model as input. Considering both, planable and unforeseeable influencing factors, this simulation model is iterated through as often as necessary until an optimal production schedule is reached and a simulation result is created. Sharing of simulation results to the next tier level is the base of the collaborative simulation approach in a short-term horizon, across the complete supply chain. - -The following picture shows the fundamental network structure, consisting of suppliers, logisticians and OEMs who exchange simulation results with each other, considering the one-up and one-down principles. Every material flow simulation result includes information about delivery readiness of packaged material goods, like material identifier, amount, delivery time and destination. - -![business processes](./businessProcess.png) - -## Semantic Model - -### Materialflow Simulation Result (MaterialFlowSimulationResult) - -The Semantic Model *MaterialFlowSimulationResult* summarizes simulation results of the individual partners and is used for data exchange along the supply chain. - -The *MaterialFlowSimulationResult* object will be sent by OSim partner to another OSim partner on a higher tier level. OSim partner can be a producing company as well as a logistics company. - -Every *MaterialFlowSimulationResult* includes information about delivery readiness of packaged material goods, like material identifier, amount, delivery time and destination. - -#### Structure of the Material Flow Result - -The MaterialFlowSimulationResult semantic model contains 4 hierarchical entities: - -- MaterialFlowSimulationResult -- Shipment -- HandlingUnit -- MaterialBatch - -One MaterialFlowSimulationResult refers to one or more Shipments. - -**Shipment** describes a delivery approach with information about source, destination and delivery time. One Shipment refers to one or more HandlingUnits. - -**HandlingUnit** describes the smallest shipment unit. One HandlingUnit refers to one or more MaterialBatches. The parameter Amount allows to define how many absolute identical (size and content) HandlingUnits are included in the shipment. - -**MateriaBatch** describes the material and the quantity which the handling unit contains. - -#### Aspect Model - -Github Link to semantic data model: - -## Logic & Schema - -### Architecture - -#### Introduction - -The Osim approach is based on a distributed simulation in which each participant simulates its role and additionally exchanges information with its suppliers and customers online via standardized interfaces. In the process, a strict 1-up / 1-down principle (i.e. data is only exchanged with the immediate predecessors and successors in the supply chain) guarantees compliance with antitrust regulations. The data exchange itself is carried out according to Gaia-X principles, which guarantee the data sovereignty of all partners involved. - -All partners involved in the supply chain simulate their respective actions (production or logistical deliveries) on the basis of the latest information from the shop floor and its internal systems. They then pass this on to the successors in the supply chain according to the 1-up principle, where a new simulation is carried out on the basis of this possibly changed information. In OSim, a "horizontal" exchange of information across the supply chain is thus combined with a "vertical" exchange with the simulation tools and thus indirectly with the shop floor. - -#### Components - -The OSim solution is built of different components mixed by CATENA-X central services and specific OSim components. The main OSim-specific application is the OSim Manager, followed by Simulation tools for logistics and production. - -The OSim Manager is a software application that exchanges all the information necessary for a local understanding of the supply chain with the partners and simulation tools, collects it and prepares it for the user. - -The simulation tools are responsible for the processing of material flow simulations in both, production plants and logistics. - -The following central services are needed for the communication along the supply chain: - -- Business Partner Number (BPN) Registry = Management of business partner legal entities, sites and addresses used to identify the partners and their BPN-IDs for communication -- Identity and Access Management (IAM) = IdP used to login against Catena-X services -- Self Sovereign Identity (SSI) = Central service hosting the EDCs certificates (public keys). Used for mutual authentication between different EDC instances -- Discovery Service (DS) = as a central registry used to store/lookup the EDC endpoints for OSim requests/sending. -- Eclipse Data Connector (EDC) = Handling contract negotiation and initiates data transfer. The Eclipse Data Connector (EDC) interface enables data exchange between the OSim managers of the participating partners. - -### Architecture and Dataflow - -![architecture](./architecture.png) - -### Technical requirements for a CATENA-X compliant data transmission - -The following appropriate configurations must be made in advance of the data exchange: - -1. In the BPN registry, all partner instances (production sites) participating in the OSim use case must be listed with their respective site identification and address. The BPN IDs of the production sites (BPNS) are used for registration in the DS. -2. In the IAM, each OSim participating partner must apply for a "technical user", which is used for process communication with the central services. -3. Registration of OSim endpoints takes place in the Discovery Service. -4. The certificates required for SSI are issued on request. - -At runtime the OSim Manager application must know the partner BPN-ID of the communication partner. With this BPN-ID, a look-up command is issued on the Discovery Service. The result is the endpoint link that the EDC connector needs to establish the connection. diff --git a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/page_changelog.md b/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/page_changelog.md deleted file mode 100644 index 13c29182c9a..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/page_changelog.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: OSim Kit Changelog -title: Changelog -description: 'OSim Kit' -sidebar_position: 1 ---- - -![osim kit banner](@site/static/img/OSimKitIcon.svg) - -### OSim Kit - -All notable changes to this Kit will be documented in this file. - -## [1.0.0] - 2023-08-18 - -### Added - -- Initial version of the Kit including adoption and development view - -### Changed - -- ./. - -### Removed - -- ./. diff --git a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/werk76.png b/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/werk76.png deleted file mode 100644 index 4e28607ee88..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/OSim Kit/werk76.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/Software Development View/page_software-development-view.md deleted file mode 100644 index 85c0a885c05..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/Software Development View/page_software-development-view.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -id: Specification -title: Specification -description: 'PCF-Exchange-KIT' -sidebar_position: 3 ---- - -## Introduction - -The developer view provides a detailed guide on how to utilize the PCF exchange KIT effectively. Developer will learn how to integrate the kit into there applications and make use of the feature of exchanging PCF values via the Catena-X network. -IT-Administrators will learn how they need to provide PCF data and which components are needed therefore. - -This Kit covers various aspects, starting from how utilize the available API Endpoints, the used data models and how to make them available to the Catena-X network. - -## Building Block View - -The following figure shows the current high level architecture of the use case PCF exchange. It is build on an asynchronous data exchange. - -![Building Block View](../resources/development-view/BuildingblockView.png) - -## Sequence View - -The following chapter illustrates the process from searching for an EDC point, to querying a PCF value, and finally transmitting the requested value. - -### EDC Discovery and dDTR Access - -For receiving the EDC Endpoints for a requested partner, the EDC Discovery Service is used, following the [CX-0001]([test](https://catena-x.net/de/standard-library)) Standard. For receiving endpoints, at least the BPN-L needs to be known to get the related endpoints. For more details the used Catena-X Standard is linked. - -![EDCDiscoveryAndDTRAccess](../resources/development-view/PCFUpdatepushthroughEDC.png) - -### PCF Request - -To actual request PCF values via the PCF API endpoint first of all the EDC PCF asset needs to be identified. Therefore the decentralized Digital Twin Registry (dDTR) is used. Data provider must register their dDTR(s) as EDC assets following the CX-0002 standard. After identifying the dDTR the Digital Twin with the related PCF submodel can be searched (see [API calls [0003 +0004]](#api-calls)). An example are documented [here](#payload-for-requesting-pcf-sub-model). -After successfully locating the EDC asset containing the PCF request endpoint (Example Payload can be found [here](#payload-for-edc-data-asset-pcf)), the query for a PCF dataset can be initiated, as illustrated in the attached sequence diagram. - -![PCF Request](../resources/development-view/PCFRequestthroughAAS.png) - ->**Note** -> The API Wrapper shown in the sequence diagrams is optional. The management API of the EDC can also be used directly. - -### PCF Update - -The sequence diagram provided below presents an example of a PCF update flow. An update is feasible only for assets that have been previously requested at least once, as demonstrated in [PCF Request](#sequence-view). Proactive updates without a prior request are not achievable with the current version. - -![PCF Update](../resources/development-view/PCFUpdatepushthroughEDC.png) - -#### API Calls - -| Call | Method | Path | Param | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| -| [001](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/API%20EDC%20Discovery/post-list-of-bpns-or-an-empty-array-to-retrieve-available-company-connector-authorization-required-roles-view-connectors) (Look up EDC Endpoints) | POST | /api/administration/Connectors/discovery/ | `[]` | -| [002](https://eclipse-tractusx.github.io/docs-kits/next/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/catalog) (Look up dDTR) | POST | /v2/catalog/request-->Lookup Asset in the EDC catalog (EDC asset type data.core.digitalTwinRegistry) | | -| [003](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/API%20AAS%20Discovery/get-all-asset-administration-shell-ids-by-asset-link) (Lookup Twin ID) | GET | /lookup/shells | `assetIds= [{"key": "manufacturerPartId", "value":"mat345",{"key":"assetLifecyclePhase", "value": "AsPlanned"}}]` | -| [004](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/API%20AAS%20Registry/get-all-asset-administration-shell-descriptors) (Look Up PCF Submodel/EDC Asset ID) | GET | /shell-descriptors | `{DIGITAL TWIN ID}` | -| [005] (Requesting PCF Value) | GET | /productIds | {productId} | -| 006 (Sending PCF Value) | PUT | /productIds | {productId} | - -- The assetIds under [003] must be base64 encoded! -- When responding on PCF exchange request the "requestID" is mandatory in the PUT call. -- When sharing a PCF update the "requestID" is NOT allowed in the PUT call. -- The EDC asset used to receive PCF is NOT looked up through AAS, but identified by type ("data.pcf.exchangeEndpoint"). - -##### Payload for Requesting PCF Sub Model - -The following JSON shows the structure of a registered PCF submodel in the DTR. The subprotocolBody is used for asset bundling. For this, the CX Standard [CX-0002](https://catena-x.net/de/standard-library) is to be followed. - -The digital twin id can be searched via the, `manufacturerPartId` and the ``assetLifecyclePhase:"asPlanned"`` -The sub-model PCF must be registered with the ``idshort: PCFExchangeEndpoint``. - -```json -{ - "description": [ - { - "language": "en", - "text": "PCF endpoint for material 'mat345'" - } - ], - "idShort": "PCFExchangeEndpoint", - "identification": "urn:uuid:205cf8d1-8f07-483c-9c5b-c8d706c7d05d", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.pcf:4.0.0#Pcf" - ] - }, - "endpoints": [ - { - "interface": "PCF-0.0.3", - "protocolInformation": { - "href": "https://edc.data.plane/productIds/mat345", - "endpointProtocol": "HTTP", - "endpointProtocolVersion": ["1.1"] - "subprotocol": "DSP", - "subprotocolBody": "id=c34018ab-5820-4065-9087-416d78e1ab60;dspEndpoint=https://some.controlplane.url:7173", - "subprotocolBodyEncoding": "plain" - } - } - ] -} -``` - -#### Payloads for EDC Asset - -##### Payload for EDC Data Asset PCF - -The following JSON shows the the EDC Asset for PCF defined in the EDC using the asset bundling mentioned under [Payload for Requesting PCF Sub Model](#api-calls). - -```json - "@type": "edc:AssetEntryDto", - "edc:asset": { - "@id": "c34018ab-5820-4065-9087-416d78e1ab60", - "edc:properties": { - "rdfs:label": "PCF Data", - "rdfs:comment": "Endpoint for PCF data", - "dcat:version": "0.0.3", - "aas-semantics:semanticId": "urn:bamm:io.catenax.pcf:4.0.0#Pcf", - "edc:contentType": "application/json", - "edc:type": "data.pcf.exchangeEndpoint" - }, - "edc:privateProperties": null, - - "edc:dataAddress": { - "edc:type": "edc:HttpData", - "edc:baseUrl": https://some.url/service, - "edc:proxyBody": "true", - "edc:proxyPath": "true", - "edc:proxyQueryParams": "true", - "edc:proxyMethod": "true", - "edc:contentType": "application/json" - } -} - -``` - -#### Payload for EDC Policy - -The following JSON is an policy definition including the policy "frameworkagreement pcf" and membership. The [frameworkagreement document](https://catena-x.net/fileadmin/user_upload/04_Einfuehren_und_umsetzen/Governance_Framework/Catena-X_UseCasePCFExchange_Beta-Phase_DE.pdf) is published via the association and are available via the Catena-X homepage. The membership credential is automatically created after finishing successfully the onboarding process. - -##### Payload to create a SSI based Policy - -```json - -{ - "@context": { - "odrl": "http://www.w3.org/ns/odrl/2/" - }, - "@type": "PolicyDefinitionRequestDto", - "@id": "{{POLICY_ID}}", - "policy": { - "@type": "Policy", - "odrl:permission": [ - { - "odrl:action": "USE", - "odrl:constraint": { - "@type": "LogicalConstraint", - "odrl:and": [ - { - "@type": "Constraint", - "odrl:leftOperand": "activeMember", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "active" - }, - { - "@type": "Constraint", - "odrl:leftOperand": "FrameworkAgreement.pcf", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "active" - } - ] - } - } - ] - } -} - -``` - -For more examples how to define policies with SSI have a look [here](https://github.com/eclipse-tractusx/ssi-docu/blob/main/docs/architecture/cx-3-2/edc/policy.definitions.md). - -#### Payload Contract Definition - -```json -{ - "@id": "54ef3326-42b2-4221-8c5a-3a6270d54db8", - "edc:accessPolicyId": "a343fcbf-99fc-4ce8-8e9b-148c97605aab", - "edc:contractPolicyId": "a343fcbf-99fc-4ce8-8e9b-148c97605aab", - "edc:assetsSelector": [ - { - "@type": "Criterion", - "edc:operandLeft": "@id", - "edc:operator": "=", - "edc:operandRight": "c34018ab-5820-4065-9087-416d78e1ab60" - } - ] -} -``` - -## Error Handling - -As Release 3.2 only covers the "happy path" for exchange PCF data via the Catena-X network. Error handling is currently not covered. - -## Standards - -### Used CX Standards - -- [CX-0001-EDCDiscoveryAPI](https://catena-x.net/de/standard-library) -- [CX-0002-DigitalTwinsInCX](https://catena-x.net/de/standard-library) -- [CX-0003-SAMMSemanticAspectMetaModel](https://catena-x.net/de/standard-library) -- [CX-0006-RegistrationAndInitialOnBoarding](https://catena-x.net/de/standard-library) -- [CX-0013 Identity of Member Companies](https://catena-x.net/de/standard-library) -- [CX-0014 Employees and Technical Users](https://catena-x.net/de/standard-library) -- [CX-0015 IAM & Access Control Paradigm](https://catena-x.net/de/standard-library) -- [CX-0016 Company Attribute Verification](https://catena-x.net/de/standard-library) -- [CX-0017 Company Role by the Connector](https://catena-x.net/de/standard-library) -- [CX-0018-SovereignDataExchange](https://catena-x.net/de/standard-library) -- [CX-0026 PCF Data Model](https://catena-x.net/de/standard-library) -- [CX-0029 Product Carbon Footprint Rulebook](https://catena-x.net/de/standard-library) -- [CX-0049-DID Document Schema](NeedtobeaddedbyAccociation) -- [CX-0050-Framework Agreement Credential](NeedtobeaddedbyAccociation) -- [CX-0051-Summary Credential](NeedtobeaddedbyAccociation) - -## Other Standards - -- [Pathfinder Framework](https://wbcsd.github.io/data-exchange-protocol/v2/) - -## 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 T-Systems International GmbH -- SPDX-FileCopyrightText: 2023,2023 SAP SE -- SPDX-FileCopyrightText: 2023,2023 SIEMENS AG -- SPDX-FileCopyrightText: 2023,2023 SUPPLY ON AG -- 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 CCT -- SPDX-FileCopyrightText: 2023,2023 Gris Group -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/pcf-exchange-kit diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/catena-x-pcf-request-endpoint.info.mdx b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/catena-x-pcf-request-endpoint.info.mdx deleted file mode 100644 index 20034d9984c..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/catena-x-pcf-request-endpoint.info.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -id: catena-x-pcf-request-endpoint -title: "Catena-X-pcf-request-endpoint" -description: " A API for request, send and update PCF data" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 0.0.3 - -# Catena-X-pcf-request-endpoint - - -A API for request, send and update PCF data via the Catena-X Network. diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/get-pcf.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/get-pcf.api.mdx deleted file mode 100644 index 41fa03016ad..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/get-pcf.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-pcf -title: "get_pcf" -description: "get_pcf" -sidebar_label: "get_pcf" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"get_pcf","parameters":[{"name":"productId","description":"ID of the product/material the PCF is requested for","example":"SomeProductID","in":"path","required":true,"schema":{"type":"string"}},{"name":"BPN","description":"The caller's Catena-X BusinessPartnerNumber","example":"BPN9354218404L","in":"query","required":true,"schema":{"type":"string"}},{"name":"requestId","description":"ID identifying the call (will be referenced in corresponding PCF response)","example":"X374e9453K","in":"query","required":true,"schema":{"type":"string"}},{"name":"message","in":"query","required":false,"description":"URL encoded, max 250 chars","example":"No%20offset%20included%2C%20please%21","schema":{"type":"string"}}],"responses":{"202":{"description":"PCF was accepted. PCF will be sent later via to POST endpoint."}},"description":"get_pcf","method":"get","path":"/productIds/{productId}","info":{"title":"Catena-X-pcf-request-endpoint","version":"0.0.3"},"postman":{"name":"get pcf","description":{"type":"text/plain"},"url":{"path":["productIds",":productId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The caller's Catena-X BusinessPartnerNumber","type":"text/plain"},"key":"BPN","value":""},{"disabled":false,"description":{"content":"(Required) ID identifying the call (will be referenced in corresponding PCF response)","type":"text/plain"},"key":"requestId","value":""},{"disabled":false,"description":{"content":"URL encoded, max 250 chars","type":"text/plain"},"key":"message","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the product/material the PCF is requested for","type":"text/plain"},"type":"any","value":"","key":"productId"}]},"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/catena-x-pcf-request-endpoint -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## get_pcf - - - -get_pcf - -
Path Parameters
Query Parameters
- -PCF was accepted. PCF will be sent later via to POST endpoint. - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/set-pcf.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/set-pcf.api.mdx deleted file mode 100644 index 2fe561a409a..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/set-pcf.api.mdx +++ /dev/null @@ -1,86 +0,0 @@ ---- -id: set-pcf -title: "set_pcf" -description: "set_pcf" -sidebar_label: "set_pcf" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"set_pcf","parameters":[{"name":"productId","description":"ID of the product/material the PCF referring to","example":"SomeProductID","in":"path","required":true,"schema":{"type":"string"}},{"name":"BPN","description":"The caller's Catena-X BusinessPartnerNumber","example":"BPN83456784L","in":"query","required":true,"schema":{"type":"string"}},{"name":"requestId","description":"ID identifying the request call (same as within original PCF request), if the PUT is responding to a call. Can be dismissed in a PCF update call.","example":"X374e9453K","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"description":"The requested PCF in WBCSD format","required":true,"content":{"application/json":{"schema":{"description":"A Product (Carbon) Footprint represents the carbon footprint of a product with values as specified in the Catena-X PCF Rulebook in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative.","type":"object","properties":{"id":{"description":"The product footprint identifier as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","title":"urn_bamm_io.catenax.pcf_4.0.0_IdTrait"},"specVersion":{"description":"Version of the product footprint data specification as defined in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","title":"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"},"partialFullPcf":{"description":"Indicator for partial or full PCF (Product Carbon Footprint) declaration as specified in the Catena-X PCF Rulebook.","type":"string","enum":["Cradle-to-gate","Cradle-to-grave"],"title":"urn_bamm_io.catenax.pcf_4.0.0_PartialFullPcfCharacteristic"},"precedingPfIds":{"description":"Set of preceding PCF (Product Carbon Footprint) identifiers without duplicates as specified in the Catena-X PCF Rulebook in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. Declared as \"optional\" in WBCSD, needs to be covered by application.","type":"array","items":{"description":"Entity for defining a preceding PCF (Product Carbon Footprint) identifier entity as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"object","properties":{"id":{"description":"The product footprint identifier as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","title":"urn_bamm_io.catenax.pcf_4.0.0_IdTrait"}},"required":["id"],"title":"urn_bamm_io.catenax.pcf_4.0.0_PrecedingPfId"},"uniqueItems":true,"minItems":1,"title":"urn_bamm_io.catenax.pcf_4.0.0_PrecedingPfIdsTrait"},"version":{"description":"Version of the product (carbon) footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to \"0\" per default.","type":"number","minimum":1,"title":"urn_bamm_io.catenax.pcf_4.0.0_ProductFootprintVersion"},"created":{"description":"Timestamp of the creation of the Product (Carbon) Footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","title":"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp"},"extWBCSD_pfStatus":{"description":"Status indicator of a product (carbon) footprint as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example set to \"Active\" per default.","type":"string","enum":["Active","Deprecated"],"title":"urn_bamm_io.catenax.pcf_4.0.0_PfStatusCharacteristic"},"validityPeriodStart":{"description":"Start of interval during which the product (carbon) footprint is declared as valid as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. If specified, the validity period start must be equal to or greater than the reference period end.","type":"string","pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","title":"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp"},"validityPeriodEnd":{"description":"End of interval during which the product (carbon) footprint is declared as valid as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","title":"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp"},"comment":{"description":"Additional information and instructions related to the calculation of the product (carbon) footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","title":"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"},"companyName":{"description":"Name of the product (carbon) footprint data owner as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","minLength":1,"title":"urn_bamm_io.catenax.pcf_4.0.0_NonEmptyStringTrait"},"companyIds":{"description":"Non-empty set of Uniform Resource Names (URN). Each value is supposed to uniquely identify the product (carbon) footprint data owner as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"array","items":{"description":"Company identifier in context of a product (carbon) footprint which must be declared as URN (Uniform Resource Name) as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"object","properties":{"companyId":{"description":"Identifier of a company in context of a product (carbon) footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","format":"uri","title":"urn_bamm_io.catenax.pcf_4.0.0_CompanyIdCharacteristic"}},"required":["companyId"],"title":"urn_bamm_io.catenax.pcf_4.0.0_CompanyId"},"uniqueItems":true,"minItems":1,"title":"urn_bamm_io.catenax.pcf_4.0.0_CompanyIdsTrait"},"productDescription":{"description":"Free-form description of the product as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","title":"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"},"productIds":{"description":"Non-empty set of product identifiers. Each value is supposed to uniquely identify the product as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"array","items":{"description":"Identifier of a product in context of a product (carbon) footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"object","properties":{"productId":{"description":"Identifier of a product in context of a product (carbon) footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","format":"uri","title":"urn_bamm_io.catenax.pcf_4.0.0_ProductIdCharacteristic"}},"required":["productId"],"title":"urn_bamm_io.catenax.pcf_4.0.0_ProductId"},"uniqueItems":true,"minItems":1,"title":"urn_bamm_io.catenax.pcf_4.0.0_ProductIdsTrait"},"extWBCSD_productCodeCpc":{"description":"UN (United Nations) Product Classification Code (CPC - Central Classification Code) of a given product as specified the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, which will probably be declared as \"optional\" in a later WBCSD specification version. In Catena-X for example specified with default value \"011-99000\".","type":"string","title":"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"},"productName":{"description":"Non-empty trade name of a product as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","minLength":1,"title":"urn_bamm_io.catenax.pcf_4.0.0_NonEmptyStringTrait"},"pcf":{"description":"A PCF (Product Carbon Footprint) represents the carbon footprint of a product and related data as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"object","properties":{"declaredUnit":{"description":"Unit of analysis of a product in context of the PCF (product carbon footprint) as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example list of valid units includes \"piece\".","type":"string","enum":["liter","kilogram","cubic meter","kilowatt hour","megajoule","ton kilometer","square meter","piece"],"title":"urn_bamm_io.catenax.pcf_4.0.0_DeclaredUnitCharacteristic"},"unitaryProductAmount":{"description":"Amount of units contained within a product in context of the PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","minimum":0,"exclusiveMinimum":true,"title":"urn_bamm_io.catenax.pcf_4.0.0_StrictlyPositiveDecimalTrait"},"productMassPerDeclaredUnit":{"description":"Mass of a product per declared unit in context of the PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveDecimalWeightTrait"},"exemptedEmissionsPercent":{"description":"Percentage of emissions excluded from PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":5,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_ExemptedEmissionsPercentTrait"},"exemptedEmissionsDescription":{"description":"Rationale behind exclusion of specific PCF (Product Carbon Footprint) emissions as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","title":"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"},"boundaryProcessesDescription":{"description":"Processes attributable to each lifecycle stage as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","title":"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"},"geographyCountrySubdivision":{"description":"Subdivision of a country which must be an ISO 3166-2 subdivision code as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","pattern":"([A-Z]{2}-[A-Z0-9]{1,3}|)","title":"urn_bamm_io.catenax.pcf_4.0.0_GeographyCountrySubdivisionTrait"},"geographyCountry":{"description":"Two letter country code that must conform to data type ISO 3166CC as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","pattern":"([A-Z]{2})","title":"urn_bamm_io.catenax.pcf_4.0.0_GeographyCountryTrait"},"geographyRegionOrSubregion":{"description":"Region according to list as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","enum":["Africa","Americas","Asia","Europe","Oceania","Australia and New Zealand","Central Asia","Eastern Asia","Eastern Europe","Latin America and the Caribbean","Melanesia","Micronesia","Northern Africa","Northern America","Northern Europe","Polynesia","South-eastern Asia","Southern Asia","Southern Europe","Sub-Saharan Africa","Western Asia","Western Europe","Global"],"title":"urn_bamm_io.catenax.pcf_4.0.0_GeographyRegionOrSubregionCharacteristic"},"referencePeriodStart":{"description":"Start of time boundary for which a PCF (Product Carbon Footprint) value is considered to be representative as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","title":"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp"},"referencePeriodEnd":{"description":"End of time boundary for which a PCF (Product Carbon Footprint) value is considered to be representative as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","pattern":"-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?","title":"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Timestamp"},"crossSectoralStandardsUsed":{"description":"Discloses the cross-sectoral standards applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"array","items":{"description":"Entity for defining an accounting standard used for product carbon footprint calculation as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"object","properties":{"crossSectoralStandard":{"description":"Discloses a cross-sectoral standard applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","enum":["GHG Protocol Product standard","ISO Standard 14067","ISO Standard 14044"],"title":"urn_bamm_io.catenax.pcf_4.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic"}},"required":["crossSectoralStandard"],"title":"urn_bamm_io.catenax.pcf_4.0.0_CrossSectoralStandard"},"title":"urn_bamm_io.catenax.pcf_4.0.0_CrossSectoralStandardSet"},"productOrSectorSpecificRules":{"description":"Product or sector specific rules applied for calculating or allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product Category Rules), including operators or publishers and according rule names as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"array","items":{"description":"Entity for defining a product or sector specific rule of a product carbon footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"object","properties":{"extWBCSD_operator":{"description":"Operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example must always be \"Other\".","type":"string","enum":["PEF","EPD International","Other"],"title":"urn_bamm_io.catenax.pcf_4.0.0_ProductOrSectorSpecificRuleOperator"},"productOrSectorSpecificRules":{"description":"Product-specific or sector-specific set of rules used for calculating or allocating GHG (Greenhouse Gas) emissions applied from the specified operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"array","items":{"description":"Name of a rule applied by a specified operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"object","properties":{"ruleName":{"description":"Name of a rule applied by a specific operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","minLength":1,"title":"urn_bamm_io.catenax.pcf_4.0.0_NonEmptyStringTrait"}},"required":["ruleName"],"title":"urn_bamm_io.catenax.pcf_4.0.0_RuleName"},"uniqueItems":true,"minItems":1,"title":"urn_bamm_io.catenax.pcf_4.0.0_RuleNamesTrait"},"extWBCSD_otherOperatorName":{"description":"Other operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by a default value.","type":"string","minLength":1,"title":"urn_bamm_io.catenax.pcf_4.0.0_NonEmptyStringTrait"}},"required":["extWBCSD_operator","productOrSectorSpecificRules"],"title":"urn_bamm_io.catenax.pcf_4.0.0_ProductOrSectorSpecificRule"},"uniqueItems":true,"title":"urn_bamm_io.catenax.pcf_4.0.0_ProductOrSectorSpecificRuleSet"},"extWBCSD_characterizationFactors":{"description":"IPCC (Intergovernmental Panel on Climate Change) version of the GWP (Global Warming Potential) characterization factors used for calculating the PCF (Product Carbon Footprint) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by default with value \"AR6\".","type":"string","enum":["AR5","AR6"],"title":"urn_bamm_io.catenax.pcf_4.0.0_CharacterizationFactorsCharacteristic"},"extWBCSD_allocationRulesDescription":{"description":"Allocation rules used and underlying reasoning in context of a product carbon footprint as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by default with value \"In accordance with Catena-X PCF Rulebook\".","type":"string","title":"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"},"extTFS_allocationWasteIncineration":{"description":"Allocation approach used for waste incineration with energy recovery as specified by the TFS (Together For Sustainability) initiative. In Catena-X for example must be specified by value \"cut-off\".","type":"string","enum":["cut-off","reverse cut-off","system expansion"],"title":"urn_bamm_io.catenax.pcf_4.0.0_AllocationWasteIncinerationCharacteristic"},"primaryDataShare":{"description":"Share of primary data in percent as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":100,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PercentTrait"},"secondaryEmissionFactorSources":{"description":"Emission factors used for the PCF (Product Carbon Footprint) calculation as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"array","items":{"description":"Entity for defining an emission factor data source used to calculate a product carbon footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"object","properties":{"secondaryEmissionFactorSource":{"description":"Characteristic for defining an emission factor data source used to calculate a product carbon footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","title":"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"}},"required":["secondaryEmissionFactorSource"],"title":"urn_bamm_io.catenax.pcf_4.0.0_EmissionFactorDS"},"uniqueItems":true,"title":"urn_bamm_io.catenax.pcf_4.0.0_EmissionFactorDSSet"},"dataQualityRating":{"description":"Quantitative data quality indicators of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"object","properties":{"coveragePercent":{"description":"Percentage of PCF (Product Carbon Footprint) included in the data quality assessment based on the >5% emissions threshold as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to \"100\" per default.","type":"number","maximum":100,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PercentTrait"},"technologicalDQR":{"description":"Technological representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":3,"exclusiveMaximum":false,"minimum":1,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_DqiNumberTrait"},"temporalDQR":{"description":"Temporal representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":3,"exclusiveMaximum":false,"minimum":1,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_DqiNumberTrait"},"geographicalDQR":{"description":"Geographical representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":3,"exclusiveMaximum":false,"minimum":1,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_DqiNumberTrait"},"completenessDQR":{"description":"Completeness of the data collected for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":3,"exclusiveMaximum":false,"minimum":1,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_DqiNumberTrait"},"reliabilityDQR":{"description":"Reliability of the data collected for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":3,"exclusiveMaximum":false,"minimum":1,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_DqiNumberTrait"}},"title":"urn_bamm_io.catenax.pcf_4.0.0_DataQualityIndicators"},"extWBCSD_packagingEmissionsIncluded":{"description":"Flag indicating whether packaging emissions are included in a PCF (Product Carbon Footprint) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example value is \"TRUE\" per default.","type":"boolean","title":"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Boolean"},"pcfExcludingBiogenic":{"description":"Product carbon footprint of a product excluding biogenic emissions as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait"},"pcfIncludingBiogenic":{"description":"Product carbon footprint of a product including biogenic emissions as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Optional value in current specification version but will be mandatory in future version.","type":"number","title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveOrNegativeEmission"},"fossilGhgEmissions":{"description":"Emissions from combustion of fossil sources as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Identical to \"pcfExcludingBiogenic\", will be removed in later version.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait"},"biogenicCarbonEmissionsOtherThanCO2":{"description":"GWP (Global Warming Potential) of biogenic CO2e-emissions in production phase which contain only GHG (Greenhouse Gas) emissions other than CO2 - excludes biogenic CO2. For specification see Catena-X PCF Rulebook.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait"},"biogenicCarbonWithdrawal":{"description":"Biogenic carbon content in the product converted to CO2e as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveDecimalWeightTrait"},"dlucGhgEmissions":{"description":"Direct land use change CO2e emissions in context of a product carbon footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait"},"extTFS_luGhgEmissions":{"description":"Land use CO2 emissions in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait"},"aircraftGhgEmissions":{"description":"GHG (Greenhouse Gas) emissions resulting from aircraft engine usage for the transport of the product as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait"},"extWBCSD_packagingGhgEmissions":{"description":"Emissions resulting from the packaging of the product as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example value is zero per default.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait"},"distributionStagePcfExcludingBiogenic":{"description":"Product carbon footprint for the distribution stage of a product excluding biogenic emissions as specified in the Catena-X PCF Rulebook.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait"},"distributionStagePcfIncludingBiogenic":{"description":"Product carbon footprint for the distribution stage of a product including biogenic emissions as specified in the Catena-X PCF Rulebook.","type":"number","title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveOrNegativeEmission"},"distributionStageFossilGhgEmissions":{"description":"Emissions from the combustion of fossil sources in the distribution stage as specified in the Catena-X PCF Rulebook.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait"},"distributionStageBiogenicCarbonEmissionsOtherThanCO2":{"description":"GWP (Global Warming Potential) of biogenic CO2e-emissions in distribution phase which contain only GHG (Greenhouse Gas) emissions other than CO2 ? excludes biogenic CO2. For specification see Catena-X PCF Rulebook.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait"},"distributionStageBiogenicCarbonWithdrawal":{"description":"GWP (Global Warming Potential) of biogenic CO2-withdrawal in distribution stage (biogenic CO2 contained in the product) as specified in the Catena-X PCF Rulebook.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait"},"extTFS_distributionStageDlucGhgEmissions":{"description":"Direct land use change CO2 emissions during distribution stage in context of a product carbon footprint as specified in the Catena-X PCF Rulebook. TFS specific extension.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait"},"extTFS_distributionStageLuGhgEmissions":{"description":"Land use CO2 emissions in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait"},"carbonContentTotal":{"description":"Total carbon content per declared unit in context of a product carbon footprint as specified in the Catena-X PCF Rulebook.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait"},"extWBCSD_fossilCarbonContent":{"description":"Fossil carbon amount embodied in a product as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by a calculated value.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait"},"carbonContentBiogenic":{"description":"Biogenic carbon amount embodied in a product as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PositiveEmissionsTrait"}},"required":["declaredUnit","unitaryProductAmount","productMassPerDeclaredUnit","exemptedEmissionsPercent","referencePeriodStart","referencePeriodEnd","crossSectoralStandardsUsed","extWBCSD_characterizationFactors","extTFS_allocationWasteIncineration","secondaryEmissionFactorSources","extWBCSD_packagingEmissionsIncluded","pcfExcludingBiogenic","extWBCSD_packagingGhgEmissions"],"title":"urn_bamm_io.catenax.pcf_4.0.0_PcfEntity"},"pcfLegalStatement":{"description":"Option for legal statement/ disclaimer as specified in the Catena-X PCF Rulebook.","type":"string","title":"urn_bamm_io.openmanufacturing_characteristic_2.0.0_Text"}},"required":["id","specVersion","partialFullPcf","version","created","extWBCSD_pfStatus","companyName","companyIds","productIds","extWBCSD_productCodeCpc","productName","pcf"],"title":"ProductFootprintResponse"}}}},"responses":{"200":{"description":""}},"description":"set_pcf","method":"put","path":"/productIds/{productId}","jsonRequestBodyExample":{"id":"string","specVersion":"string","partialFullPcf":"Cradle-to-gate","precedingPfIds":[{"id":"string"}],"version":0,"created":"string","extWBCSD_pfStatus":"Active","validityPeriodStart":"string","validityPeriodEnd":"string","comment":"string","companyName":"string","companyIds":[{"companyId":"string"}],"productDescription":"string","productIds":[{"productId":"string"}],"extWBCSD_productCodeCpc":"string","productName":"string","pcf":{"declaredUnit":"liter","unitaryProductAmount":0,"productMassPerDeclaredUnit":0,"exemptedEmissionsPercent":0,"exemptedEmissionsDescription":"string","boundaryProcessesDescription":"string","geographyCountrySubdivision":"string","geographyCountry":"string","geographyRegionOrSubregion":"Africa","referencePeriodStart":"string","referencePeriodEnd":"string","crossSectoralStandardsUsed":[{"crossSectoralStandard":"GHG Protocol Product standard"}],"productOrSectorSpecificRules":[{"extWBCSD_operator":"PEF","productOrSectorSpecificRules":[{"ruleName":"string"}],"extWBCSD_otherOperatorName":"string"}],"extWBCSD_characterizationFactors":"AR5","extWBCSD_allocationRulesDescription":"string","extTFS_allocationWasteIncineration":"cut-off","primaryDataShare":0,"secondaryEmissionFactorSources":[{"secondaryEmissionFactorSource":"string"}],"dataQualityRating":{"coveragePercent":0,"technologicalDQR":0,"temporalDQR":0,"geographicalDQR":0,"completenessDQR":0,"reliabilityDQR":0},"extWBCSD_packagingEmissionsIncluded":true,"pcfExcludingBiogenic":0,"pcfIncludingBiogenic":0,"fossilGhgEmissions":0,"biogenicCarbonEmissionsOtherThanCO2":0,"biogenicCarbonWithdrawal":0,"dlucGhgEmissions":0,"extTFS_luGhgEmissions":0,"aircraftGhgEmissions":0,"extWBCSD_packagingGhgEmissions":0,"distributionStagePcfExcludingBiogenic":0,"distributionStagePcfIncludingBiogenic":0,"distributionStageFossilGhgEmissions":0,"distributionStageBiogenicCarbonEmissionsOtherThanCO2":0,"distributionStageBiogenicCarbonWithdrawal":0,"extTFS_distributionStageDlucGhgEmissions":0,"extTFS_distributionStageLuGhgEmissions":0,"carbonContentTotal":0,"extWBCSD_fossilCarbonContent":0,"carbonContentBiogenic":0},"pcfLegalStatement":"string"},"info":{"title":"Catena-X-pcf-request-endpoint","version":"0.0.3"},"postman":{"name":"set pcf","description":{"type":"text/plain"},"url":{"path":["productIds",":productId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The caller's Catena-X BusinessPartnerNumber","type":"text/plain"},"key":"BPN","value":""},{"disabled":false,"description":{"content":"ID identifying the request call (same as within original PCF request), if the PUT is responding to a call. Can be dismissed in a PCF update call.","type":"text/plain"},"key":"requestId","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the product/material the PCF referring to","type":"text/plain"},"type":"any","value":"","key":"productId"}]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/catena-x-pcf-request-endpoint -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## set_pcf - - - -set_pcf - -
Path Parameters
Query Parameters
Request Body required
- -The requested PCF in WBCSD format - -
    precedingPfIds object[]
    - -**Possible values:** `>= 1` - -
    - -Set of preceding PCF (Product Carbon Footprint) identifiers without duplicates as specified in the Catena-X PCF Rulebook in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. Declared as "optional" in WBCSD, needs to be covered by application. - -
  • Array [
  • ]
    • = 1`"} schema={{"description":"Version of the product (carbon) footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to \"0\" per default.","type":"number","minimum":1,"title":"urn_bamm_io.catenax.pcf_4.0.0_ProductFootprintVersion"}}>
    companyIds object[] required
    - -**Possible values:** `>= 1` - -
    - -Non-empty set of Uniform Resource Names (URN). Each value is supposed to uniquely identify the product (carbon) footprint data owner as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
  • Array [
  • ]
    • productIds object[] required
    - -**Possible values:** `>= 1` - -
    - -Non-empty set of product identifiers. Each value is supposed to uniquely identify the product as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
  • Array [
  • ]
    • pcf object required
    - -A PCF (Product Carbon Footprint) represents the carbon footprint of a product and related data as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
    crossSectoralStandardsUsed object[] required
    - -Discloses the cross-sectoral standards applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
  • Array [
  • ]
    • productOrSectorSpecificRules object[]
    - -Product or sector specific rules applied for calculating or allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product Category Rules), including operators or publishers and according rule names as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
  • Array [
    • productOrSectorSpecificRules object[] required
    - -**Possible values:** `>= 1` - -
    - -Product-specific or sector-specific set of rules used for calculating or allocating GHG (Greenhouse Gas) emissions applied from the specified operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
  • Array [
  • ]
  • ]
    • secondaryEmissionFactorSources object[] required
    - -Emission factors used for the PCF (Product Carbon Footprint) calculation as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
  • Array [
  • ]
    • dataQualityRating object
    - -Quantitative data quality indicators of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
    5% emissions threshold as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to \"100\" per default.","type":"number","maximum":100,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_PercentTrait"}}>= 1` and `<= 3`"} schema={{"description":"Technological representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":3,"exclusiveMaximum":false,"minimum":1,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_DqiNumberTrait"}}>= 1` and `<= 3`"} schema={{"description":"Temporal representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":3,"exclusiveMaximum":false,"minimum":1,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_DqiNumberTrait"}}>= 1` and `<= 3`"} schema={{"description":"Geographical representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":3,"exclusiveMaximum":false,"minimum":1,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_DqiNumberTrait"}}>= 1` and `<= 3`"} schema={{"description":"Completeness of the data collected for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":3,"exclusiveMaximum":false,"minimum":1,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_DqiNumberTrait"}}>= 1` and `<= 3`"} schema={{"description":"Reliability of the data collected for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":3,"exclusiveMaximum":false,"minimum":1,"exclusiveMinimum":false,"title":"urn_bamm_io.catenax.pcf_4.0.0_DqiNumberTrait"}}>
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/sidebar.js b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/sidebar.js deleted file mode 100644 index e6c25a0e6e8..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/catena-x-pcf-request-endpoint"},{"type":"category","label":"PCF Exchange API","items":[{"type":"doc","id":"kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/get-pcf","label":"get_pcf","className":"api-method get"},{"type":"doc","id":"kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/set-pcf","label":"set_pcf","className":"api-method put"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/changelog.md b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/changelog.md deleted file mode 100644 index 60051175717..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/changelog.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -id: PCF Exchange Kit Changelog -title: Changelog -description: 'PCF Exchange Kit' -sidebar_position: 1 ---- -## PCF Exchange KIT - -All notable changes to this Kit will be documented in this file. - -## [0.1.0] - 2023-08-23 - -### Added - -Initial Version of the PCF exchange KIT including adoption and development view incl. all relevant API specifications. - -### Changed - -N/A - -### Removed - -N/A diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/page_adoption-view.md deleted file mode 100644 index abcadf30541..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/page_adoption-view.md +++ /dev/null @@ -1,527 +0,0 @@ ---- -id: Adoption View -title: Adoption View -description: 'PCF-Exchange-KIT' -sidebar_position: 2 ---- - -## Introduction - -Sustainability has become increasingly important in the automotive industry in recent years. In particular, the topic of CO2 emissions is the focus of interest, and the product-specific CO2 footprint (PCF: product carbon footprint) has developed into a key indicator for sustainable product design and supply chains. Accordingly, there is a need to determine this data as precisely as possible across the automotive supply chain and to exchange it among partners in the network. This requires appropriate standards for calculation and exchange of data. - -In this context, Catena-X offers a decentralized ecosystem supported by standards and principles like data sovereignty, which can effectively implement such a PCF data exchange. The PCF KIT will be the key enabler for various stakeholders to calculate and exchange PCF data in a standardized format. The objective of the PCF KIT is therefore to: - -- Provide a comprehensive overview about the methods and tools for a PCF data exchange in the Catena-X dataspace. -- Offer various standards and guidelines for industry stakeholders. -- Provide a detailed description of the essential components required. - -## Vision & Mission - -### Vision - -Report and steer the de-carbonization of our value chain with dedicated measures based on real PCF values, without compromising upstream data sovereignty. - -### Mission - -Addressing supply chain carbon emissions today is missing reliable data about baseline emissions, effect of reductions, and best practices. This is due to three reasons: - -- Complexity of supply chains leading to huge amount of data: complex supply chains spanning different countries and actors from many industries lead to huge amounts of data. - -- Lack of Trust: Unwillingness to share data because of risk of losing competitive advantage, because data is shared with competitors. - -- Missing standards for measuring carbon emissions in a comparable way. - -At the core of our project is the recognition of a current challenge - the lack of transparency and accessibility to real PCF information in supply chains. Through our project, we strive to bridge this information gap by establishing a trusted and collaborative and interoperable environment. Suppliers will have the opportunity to share their PCF data with confidence, knowing that it remains sovereign and under their control. - -We will address this by working on trustworthy ecosystem that prioritizes data sovereignty, security, and collaboration on standards. Therefore, our mission is to revolutionize the supply chain industry by providing a platform where suppliers can securely share their primary Product Carbon Footprint (PCF) data throughout the supply chain. - -We are guided by the following principles: - -- **Building trust** by making clear rules for data exchange and by pre-agreed data contracts between partners in the value chain. -- Building trust through **data sovereignty and data security**. We will build an ecosystem to share minimal data on a need-to-know basis, incorporating 3rd party verification by trusted partners. Decentralized architectures ensure that data remains within companies and is only shared with authorized persons as needed. -- **Governance** on the principles of mutual collaboration in the automotive industry and across with all relevant actors of the value chain on the principle of equality between partners, involving relevant outside stakeholders and the scientific community. -- **Flexibility and interoperability** by building an ecosystem of interoperable apps based on open standards. Collaborative standards for collecting, calculating, and sharing emission and product data make these processes more efficient and comparable. -- **Scalability** and manageability of large amounts of data. Decentralized data ecosystems can handle and scale large amounts of data, as decentralized structures are created as required by participating companies. - -## Business Process - -### Premises and assumptions - -We assume that the calculation and exchange of PCF data is “new territory” for many companies. In large or larger enterprises (e.g., OEM or Tier-1 suppliers), the topic of sustainability with its various facets has been on the agenda for several years now. Appropriate structures and organizations were set up there. In this respect, it can be assumed that they have the expertise and resources for a PCF calculation. Corresponding, self-developed IT tools can also be found there. We cannot expect this for small and medium-sized enterprises (SMEs). In particular small companies often lack the knowledge and resources to calculate a PCF. - -The following premises are therefore relevant for the following customer journeys: - -- A PCF calculation requires expert or at least in-depth knowledge. -- A PCF calculation is currently mostly created manually; automation is not common or possible in most cases. -- Automation is also not yet feasible because there are no concepts or standards for verifying PCF data. -- Due to the (manual) effort, PCF calculation and data exchange will initially only be carried out for selected products. - -Accordingly, the presented customer journeys are characterized by manual process steps. However, as the topic becomes more widely known in the automotive supply chain (especially among SMEs), greater automation should be sought. This is the only way to represent a larger (ideally the entire) range of products. - -### Overview - -The scope of our business process is the calculation and the exchange of Product Carbon Footprint (PCF) data across the supply chain for parts / components that are already in series production (→ "after start of production (SOP)"). One can therefore assume that a real supply chain already exists for this part / component. - -To describe the process, we defined two customer journeys: - -1. The customer journey “PCF data exchange” describes an asynchronous communication process: A customer requests the PCF from their supplier for a component (“PCF Request”), and the supplier provides the requested data (“PCF Response”). -2. If necessary, the requested PCF data must first be determined; this leads to the second customer journey “PCF calculation”. - -The exchange-process is initiated top-down (e.g., at the OEM; but it can also start at any level of the supply chain), starting with a request of a customer to the supplier. It could then be continued step by step throughout the entire tier-n supply chain. Ideally, the entire supply chain (or actually: the entire supply tree) would be covered via this cascading request/response process. The result would be a PCF that is 100% based on requested and reported data. - -![PCF Request and Response](resources/adoption-view/PCFRequestandResponse.png) - -In the real world, this will not be implemented this way, at least in the short and medium term. It can be assumed that this process and information chain will break down at certain points in the supply chain. There, data is not requested, but is calculated using secondary data, as is standard procedure these days. There can be various reasons for this: - -- The affected part of the supply chain is only of minor relevance to the PCF; the effort required to determine the real data would therefore not be worthwhile. -- The supplier cannot or does not want to provide corresponding data. - -However, it is important that a PCF value reported from a supplier to its customer always represents the entire supply chain behind it. Therefore, the following data is recorded in a PCF calculation and aggregated to form the resulting PCF: - -- direct emissions, that are generated in the supplier's own production system ("Scope 1") -- indirect emissions from purchased energy ("Scope 2") -- upstream emissions caused by purchased products from the upstream supply chain ("Scope 3") - -![Scope of Catena-X Use Case](resources/adoption-view/ScopeofCatena-XUseCase.png) - -The data for direct and indirect emissions will usually come from internal data sources, as these emission-shares are generated in the supplier's own production system. The upstream emissions ("Scope 3") can either be requested from the respective sub-supplier. Or it could be calculated, e.g., by using information from eco-databases. Putting all together, the transparency on the PCF for a given part or component is created through a cascade of top-to-bottom PCF requests, and a cascade of aggregated PCF data from bottom to top. - -### Customer Journey "PCF Data Exchange" - -This customer journey describes the exchange of PCF data in an asynchronous request/response process. - -![PCF Data Exchange Overview](resources/adoption-view/PCFDataExchangeOverview.png) - -PCF data is exchanged between a data consumer (e.g., supplier on tier n) and a data provider (e.g., supplier on tier n+1). It is basically an asynchronous request/response process that is started by the data consumer: - -1. The data consumer realizes that he needs the PCF for a specific component and that this data is not available in his local data (or is not of sufficient quality). -2. With his PCF Data exchange tool, the data consumer checks whether the required PCF data is available via Catena-X (from a technical perspective, this means that there is already a digital twin for the component and that the PCF submodel is available for this twin). If so, the tool would “fetch up” this data. If not, the user can request this data from the supplier as described in the next steps. -3. The data consumer submits a “PCF request” (according to the standardized API [CX-0028](https://catena-x.net/de/standard-library)) to his supplier. In doing so, he asks the supplier to provide PCF data for the specific component, which was determined in accordance with the requirements of the Catena-X PCF Rulebook ([CX-0029](https://catena-x.net/de/standard-library)). - -With this request, the process temporarily ends for the data consumer. The ball is now in the data provider's playing field.: - -4. The data provider receives the PCF request (message/display in his PCF data exchange tool). To answer this request, he takes the following steps: -5. The data provider checks whether the requested data is already available (i.e., whether the PCF has already calculated in the past but has not yet been provided to the customer). -6. If the data is not yet available, the data provider must create it first. At this point, he starts the “PCF calculation” subjourney (see [below](#customer-journey-pcf-calculation)). At the end of this subjourney, the PCF data is available, and the provider can answer the original request with the next steps. -7. The data provider sends a PCF Response (according to the standardized API see [CX-0028](https://catena-x.net/de/standard-library)) to the data consumer. At the same time, the data is made available in Catena-X (which means from a technical perspective, that a PCF submodel is attached to the corresponding digital twin of the component). - -For the data provider, the process is now over, and the consumer's request has been answered with the response. Now follow a few more steps on the consumer side. - -8. The data consumer, who sent the initial PCF request, now receives the PCF response (message/display in his PCF data exchange tool). -9. With the data exchange tool, the consumer can access and “pick up” the PCF data, according to the standardized PCF data model (see [Semantic Model](#semantic-models)). - ->**Remark:** ->There are currently no options for data verification or acceptance/rejection of transmitted data at this stage in the process. These topics are currently still being discussed at Catena-X association level and are therefore not yet covered in the processes and tools. This will only happen with later releases. - -10. The data consumer can now transfer this data to his internal systems/databases (e.g., a PCF calculation tool), and use it for the internal business processes (e.g., PCF calculation or reporting). -This ends this customer journey. - -### Customer Journey “PCF Calculation” - -This customer journey describes the calculation of a [CX Rulebook-compliant PCF](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Archiv/Update_Standard_PDF_Feb._2023/1_Sustainability_v1.0/CX_-_0029_PCF_Rulebook_UseCaseSustainability_v_1.0.0.pdf), with some of the required data obtained via the Catena-X network. - -![PCF Calculation](resources/adoption-view/PCFCalculation.png) - -The calculation process will often be triggered by an incoming PCF request (see subjourney "[PCF data exchange](#customer-journey-pcf-data-exchange)", step 6). But of course, a PCF calculation can also be carried out proactively without a corresponding request via PCF Request. -To determine a PCF, an appropriate calculation tool is usually used, which guides the user through the process and ensures that all relevant data is taken into account. We will limit ourselves here to a generic, tool-independent presentation of the most important steps. - -1. Make a plan: What are the different components of the PCF? Where can I get the relevant data from? -→ This structuring should be supported by an appropriate process in the calculation tool. -1. Put the direct emissions from the production site (e.g., use of natural gas or fuels) into the calculation. -→ Get the raw data from internal data sources and enter them in the calculation tool. -1. Put the indirect emissions from purchased energy into the calculation. -→ Get the raw data (consumption values, energy mix, …) from internal data sources and from the energy supplier, and enter it in the calculation tool. -1. Upstream emissions: - 1. For sub-components with a (expected) relevant share on the PCF, the aim is to use real data (or primary data) for the calculation. Therefore, a PCF request is sent to the suppliers of these sub-components, to obtain appropriate real data (see subjourney ["PCF data exchange"](#customer-journey-pcf-data-exchange)). As soon as the data is available (via a PCF Response), it can be used as input for the calculation. - 2. For other sub-components, which only make up a small proportion of the upstream emissions, there will be no request of data to the supplier. Instead, the data will be obtained from a database for secondary data. -2. If necessary, put other emissions and further data into the calculation (e.g., transport emissions, waste, recycling quotas, ...). -3. Put it all together and get the overall PCF. -4. Transfer PCF to the exchange tool (or in general: make the PCF data available). - -### PCF Personas - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PersonaRole and Task (in larger companies)Specifics for SME ChallengesCatena-X Contribution
Purchaser In general, the purchaser will not be a sustainability expert! - Sustainability is for him just an additional dimension (as cost, quality, ...). -
    -
  • He requests sustainability data for purchased (sub)products from his suppliers.
    • -
  • In the sourcing process he evaluates the incoming offers (which will include more and more sustainability data).
    • -
  • He negotiates PCF targets with his suppliers.
    • -
  • He checks compliance with agreements and targets and evaluates the supplier's performance.
    • -
  • He will be often the one, who detects incidents (e.g., non-fulfillment of targets, missing certificates, ...).
    • -
- Different responsibilities and views possible: -
    -
  • A part / components / materials-oriented view
    • -
  • A supplier / commodity-oriented view
    • -
- 		-

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

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

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

-

He requires standardized data.

-

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

-

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

- 		-

X defines standards for sustainability data.

-

CX provides up-to-date and reliable sustainability data

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

CX provides phase-specific data.

-

CX provides (standard) reports.

-

CX provides apps and services for data exchange.

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

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

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

Customer view:

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

Internal View:

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

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

-

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

-

Requires access to eco-data (secondary data).

-

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

- 		-

CX defines standards for PCF calculation.

-

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

-

CX provides apps and services for data exchange.

-

CX provides calculation tools.

-

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

-
PCF Controller (product) -

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

-

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

-

External/Customer view:

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

Internal View:

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

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

-

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

-

He requires standardized data.

-

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

-

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

- 		-

CX defines standards for PCF data.

-

CX provides apps and services for PCF data exchange.

-

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

-

CX provides phase-specific data.

-
Sustainability Manager (product) -

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

-

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

-

He ensures the consistency of product objectives with corporate objectives.

-

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

-

He receives sustainability targets from customers.

-

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

-

He performs analyses in the context of sustainability.

-

He collaborates with external auditors.

- 		- -

He collaborates with external auditors.

-

He requires standardized data.

-

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

-

He needs reports for tracking and monitoring of sustainability data.

-

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

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

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

-

CX provides apps and services for data exchange.

-

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

-

CX provides phase-specific data.

-

CX provides (standard) reports.

-

CX provides analysis tools.

-
Sustainability Manager (corporate) -

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

-

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

-

He gets input from the Sustainability Manager Product.

- 		-

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

-

Thesis: an SME does CCF rather than PCF.

- 		-

He requires (aggregated) sustainability data.

-

He requires “high level” (standard) reports.

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

He is the central interface to the customer.

-

He is the owner of the customer quotation process.

-

He negotiates PCF targets with customers (→purchaser).

-

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

-

He is accountable for incident management with customers.

- 		- -

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

-

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

- 		-

CX provides sustainability data of own products.

-

CX provides apps and services for data exchange.

-
Auditor (external) -

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

-

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

-

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

-

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

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

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

-

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

-
Sustainability Associations / InstitutionsThey provide industry-specific averages and benchmarks of PCF values.
- -## Semantic Models - -Depending on the use case and related KIT, Catena-X provides different semantic models that help to structure and make use of data via semantic information. These models help to provide a basic meaning to the data and their relationship, thereby enabling interoperability between data sets. Catena-X data models rely on principles as understandability, standardization, accuracy, differentiation, audibility, comprehensiveness, and provision of insights to drive improvement actions. - -### PCF - -#### Introduction PCF Data Model - -In an era defined by growing environmental consciousness and sustainability imperatives, the concept of measuring and reducing carbon footprints has become paramount across industries. A pivotal key in this pursuit is a aligned and standardized Product Carbon Footprint Data Model. This data model not only facilitates the systematic calculation and comparison of carbon footprints but also offers a structured approach to managing environmental impact data. - -As the global community grapples with the impacts of climate change, consumers, businesses, and governments are seeking actionable ways to mitigate their carbon emissions. The need for a consistent and universally accepted method of quantifying these emissions from diverse products has given rise to the significance of a Standardized Product Carbon Footprint Data Model. This model acts as a lingua franca, enabling stakeholders to communicate and analyze carbon footprint information transparently and comprehensively. - -For this KIT only the data model PCF is used. The data model follows the Catena-X Standard [CX-0026](https://catena-x.net/de/standard-library) and is modeled following the [CX-0003](https://catena-x.net/de/standard-library) Standard. - -#### Example Payload - -The following json shows a example payload for a requested pcf value. - -```json -{ - "specVersion": "2.0.1-20230314", - "companyIds": { - "companyId": "urn:uuid:51131FB5-42A2-4267-A402-0ECFEFAD1619" - }, - "extWBCSD_productCodeCpc": "011-99000", - "created": "2022-05-22T21:47:32Z", - "companyName": "My Corp", - "extWBCSD_pfStatus": "Active", - "version": 0, - "productName": "My Product Name", - "pcf": { - "biogenicCarbonEmissionsOtherThanCO2": 1, - "distributionStagePcfExcludingBiogenic": 1.5, - "biogenicCarbonWithdrawal": 0, - "distributionStageBiogenicCarbonEmissionsOtherThanCO2": 1, - "extWBCSD_allocationRulesDescription": "In accordance with Catena-X PCF Rulebook", - "exemptedEmissionsDescription": "No exemption", - "distributionStageFossilGhgEmissions": 0.5, - "exemptedEmissionsPercent": 0, - "geographyCountrySubdivision": "US-NY", - "extTFS_luGhgEmissions": 0.3, - "distributionStageBiogenicCarbonWithdrawal": 0.5, - "pcfIncludingBiogenic": 1, - "aircraftGhgEmissions": 0, - "productMassPerDeclaredUnit": 0.456, - "productOrSectorSpecificRules": [ - { - "extWBCSD_operator": "PEF", - "productOrSectorSpecificRules": { - "ruleName": "urn:tfs-initiative.com:PCR:The Product Carbon Footprint Guideline for the Chemical Industry:version:v2.0" - }, - "extWBCSD_otherOperatorName": "NSF" - } - ], - "extTFS_allocationWasteIncineration": "cut-off", - "pcfExcludingBiogenic": 2, - "referencePeriodEnd": "2022-12-31T23:59:59Z", - "extWBCSD_characterizationFactors": "AR5", - "secondaryEmissionFactorSources": [ - { - "secondaryEmissionFactorSource": "ecoinvent 3.8" - } - ], - "unitaryProductAmount": 1000.0, - "declaredUnit": "liter", - "referencePeriodStart": "2022-01-01T00:00:01Z", - "geographyRegionOrSubregion": "Africa", - "fossilGhgEmissions": 0.5, - "boundaryProcessesDescription": "Electricity consumption included as an input in the production phase", - "geographyCountry": "DE", - "extWBCSD_packagingGhgEmissions": 0, - "dlucGhgEmissions": 0.4, - "carbonContentTotal": 2.5, - "extTFS_distributionStageLuGhgEmissions": 1.1, - "primaryDataShare": 56.12, - "dataQualityRating": { - "completenessDQR": 2, - "technologicalDQR": 2, - "geographicalDQR": 2, - "temporalDQR": 2, - "reliabilityDQR": 2, - "coveragePercent": 100 - }, - "extWBCSD_packagingEmissionsIncluded": true, - "extWBCSD_fossilCarbonContent": 0.1, - "crossSectoralStandardsUsed": [ - { - "crossSectoralStandard": "GHG Protocol Product standard" - } - ], - "extTFS_distributionStageDlucGhgEmissions": 1, - "distributionStagePcfIncludingBiogenic": 0, - "carbonContentBiogenic": 0 - }, - "partialFullPcf": "Cradle-to-gate", - "productIds": { - "productId": "urn:gtin:4712345060507" - }, - "validityPeriodStart": "2022-01-01T00:00:01Z", - "comment": "Comment for version 42.", - "id": "3893bb5d-da16-4dc1-9185-11d97476c254", - "validityPeriodEnd": "2022-12-31T23:59:59Z", - "pcfLegalStatement": "This PCF (Product Carbon Footprint) is for information purposes only. It is based upon the standards mentioned above.", - "productDescription": "Ethanol, 95% solution", - "precedingPfIds": { - "id": "3893bb5d-da16-4dc1-9185-11d97476c254" - } -} -``` - -The entire data model is available as open source through the link provided below. - -```text -https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.pcf/4.0.0 -``` - -## Business Architecture - -The PCF Exchange KIT can be used to exchange PCF data within the Catena-X ecosystem in a decentralized and interoperable manner, while maintaining a high level of data sovereignty. To achieve this, the PCF Exchange KIT leverages other KITs (particularly the platform-related ones), standardized data models, and an Identity and Access Management (IAM) system based on OAuth and Self-Sovereign Identity (SSI) technology. - -In order to ensure **interoperability**, as described in the section on [Semantic Models](#semantic-models), a standardized data model is essential. However, it's not only the data model but also the standardized interfaces (both the PCF Exchange API and the standardized API provided by the Connector Kit) that contribute to interoperability. - -To enable **data sovereignty**, Catena-X relies on **Self-Sovereign-Identity** (SSI). This allows data providers to precisely specify the conditions that must be met before requested data is transmitted. In the context of the PCF KIT, the "PCF Credential" and "Membership Credential" are mandatory. The PCF Credential references the [PCF Framework Agreement](https://catena-x.net/fileadmin/user_upload/04_Einfuehren_und_umsetzen/Governance_Framework/Catena-X_UseCasePCFExchange_Beta-Phase_DE.pdf) signed by a data consumer. The Membership Credential additionally ensures that the requester is an active member of Catena-X. - -The diagram shown here illustrates the interaction between the PCF KIT and the other Catena-X components. -![Business Architecture](resources/adoption-view/BusinessArchitecture.png) - -## 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 T-Systems International GmbH -- SPDX-FileCopyrightText: 2023,2023 SAP SE -- SPDX-FileCopyrightText: 2023,2023 SIEMENS AG -- SPDX-FileCopyrightText: 2023,2023 SUPPLY ON AG -- 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 CCT -- SPDX-FileCopyrightText: 2023,2023 Gris Group -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/pcf-exchange-kit diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/page_documentation.md b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/page_documentation.md deleted file mode 100644 index 15d424477bf..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/page_documentation.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Documentation Overview ---- - -## NOTICE - -- 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 T-Systems International GmbH -- SPDX-FileCopyrightText: 2023,2023 SAP SE -- SPDX-FileCopyrightText: 2023,2023 SIEMENS AG -- SPDX-FileCopyrightText: 2023,2023 SUPPLY ON AG -- 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 CCT -- SPDX-FileCopyrightText: 2023,2023 Gris Group -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/pcf-exchange-kit \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/page_software-operation-view.md deleted file mode 100644 index c4e27d6d9b8..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/page_software-operation-view.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -id: Operation View -title: Operation View -description: 'PCF Exchange KIT' -sidebar_position: 4 ---- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/adoption-view/BusinessArchitecture.png b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/adoption-view/BusinessArchitecture.png deleted file mode 100644 index 52c9786cfe2..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/adoption-view/BusinessArchitecture.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/adoption-view/PCFCalculation.png b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/adoption-view/PCFCalculation.png deleted file mode 100644 index 209b1fa02f8..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/adoption-view/PCFCalculation.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/adoption-view/PCFDataExchangeOverview.png b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/adoption-view/PCFDataExchangeOverview.png deleted file mode 100644 index 432468be611..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/adoption-view/PCFDataExchangeOverview.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/adoption-view/PCFRequestandResponse.png b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/adoption-view/PCFRequestandResponse.png deleted file mode 100644 index 4651620686a..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/adoption-view/PCFRequestandResponse.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/adoption-view/ScopeofCatena-XUseCase.png b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/adoption-view/ScopeofCatena-XUseCase.png deleted file mode 100644 index 5c00d2cd45e..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/adoption-view/ScopeofCatena-XUseCase.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/BuildingblockView.png b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/BuildingblockView.png deleted file mode 100644 index de59cecc806..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/BuildingblockView.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/EDCDiscoveryAnddDTRAccess.puml b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/EDCDiscoveryAnddDTRAccess.puml deleted file mode 100644 index 1c6daf6cff8..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/EDCDiscoveryAnddDTRAccess.puml +++ /dev/null @@ -1,91 +0,0 @@ -@startuml "EDC Discovery and dDTRAccess" - -participant PCF_Client -participant Client_API_Wapper -participant Client_EDC -participant EDC_Discovery_Service -participant Company_EDC -participant Company_DTR - -group Request PCF value - -group Technical user login (not shown in detail here) -end -!startsub EDCDiscovery -group Lookup Company's EDC -PCF_Client -> EDC_Discovery_Service: Lookup EDC URL (via BPN) -note right -POST https://portal-backend.some.demo.catena-x.net/api/administration/connectors/discovery -{ - [ ] -} -end note -EDC_Discovery_Service -> PCF_Client: EDC URL -end -!endsub - -!startsub DTRDiscovery -group Lookup Companies DTR -PCF_Client -> Client_EDC: Lookup Companies DTR\n(via Company's EDC URL) -Client_EDC -> Company_EDC: Lookup Asset in Catalog\n(EDC asset type "data.core.digitalTwinRegistry") -note right -Assumption PI9: Only one dDTR behind one of the EDCs -(there could be multiple in theory!) -end note -Company_EDC -> Client_EDC: DTR Asset -Client_EDC -> PCF_Client: DTR Asset ID -end -!endsub - -!startsub MaterialTwinLookup -group Lookup PCF Submodel of Material Twin -PCF_Client -> Client_EDC: Lookup Twin's Submodel\nin Companies DTR\n(via Company's EDC URL) -Client_EDC -> Company_EDC: Negotiate DTR access & lookup\nTwin's Submodel in Company's DTR\n(using AAS API and materialID) -note right -Lookup Twin ID for material: -GET https://someEDCProxURL/lookup/shells?assetIds=[{"key": "manufacturerPartId","value":"mat345"},{"key": "assetLifecyclePhase","value": "AsPlanned"}] - -Lookup Twin for ID -GET https://someEDCProxURL/registry/shell-descriptors/urn:uuid:c34018ab-5820-4065-9087-416d78e1ab60 - -end note -Company_EDC -> Company_DTR: Lookup Material Twin\nincl. PCF submodel -Company_DTR -> Company_EDC: Material Twin (AAS)\nincl. PCF submodel -Company_EDC -> Client_EDC: Material Twin (AAS)\nincl. PCF submodel -Client_EDC -> PCF_Client: Material Twin (AAS)\nincl. PCF submodel -note right -Showing submodel only to ease readability! - -{ - "description": [ - { - "language": "en", - "text": "PCF endpoint for material 'mat345'" - } - ], - "idShort": "PCFExchangeEndpoint", - "identification": "urn:uuid:205cf8d1-8f07-483c-9c5b-c8d706c7d05d", - "semanticId": { - "value": [ - "urn:bamm:io.catenax.pcf:4.0.0#Pcf" - ] - }, - "endpoints": [ - { - "interface": "PCF-0.0.3", - "protocolInformation": { - "href": "https://edc.data.plane/productIds/mat345", - "endpointProtocol": "HTTP", - "endpointProtocolVersion": ["1.1"] - "subprotocol": "DSP", - "subprotocolBody": "id=c34018ab-5820-4065-9087-416d78e1ab60;dspEndpoint=https://some.controlplane.url:7173", - "subprotocolBodyEncoding": "plain" - } - } - ] -} -end note -end -!endsub - -@enduml \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/EDCDiscoveryanddDTRAccess.png b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/EDCDiscoveryanddDTRAccess.png deleted file mode 100644 index 6c580760868..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/EDCDiscoveryanddDTRAccess.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/PCFRequest.puml b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/PCFRequest.puml deleted file mode 100644 index 00de656e79c..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/PCFRequest.puml +++ /dev/null @@ -1,104 +0,0 @@ -@startuml "PCF Request through AAS" - -participant PCF_Client -participant Client_API_Wapper -participant Client_EDC -participant EDC_Discovery_Service -participant Company_EDC -participant Company_DTR -participant Company_API_Wapper -participant Company_PCF_App - -group Request PCF value - -group Technical user login (not shown in detail here) -end - -!includesub EDCDiscoveryAnddDTRAccess.puml!EDCDiscovery -!includesub EDCDiscoveryAnddDTRAccess.puml!DTRDiscovery -!includesub EDCDiscoveryAnddDTRAccess.puml!MaterialTwinLookup - -group Invoke PCF Submodel of Material Twin -PCF_Client -> PCF_Client: Extract Endpoint from submodel via 'idShort' -PCF_Client -> PCF_Client: Rewrite endpoint URL for call through own API Wrapper -PCF_Client -> Client_API_Wapper: Invoke asset with reqID, BPN & comment -note right -GET https://clientApiWrapperUrl/api/service/c34018ab-5820-4065-9087-416d78e1ab60/productIds/mat345?providerUrl=https://some.controlplane.url:7173&requestId=123&BPN=&comment=... -end note -Client_API_Wapper -> Client_EDC: Negotiate access to asset and enable proxy transfer -Client_EDC -> Company_EDC: Negotiate access to asset and enable proxy transfer -Company_EDC -> Client_EDC: Agreement & EndpointDataReference -Client_EDC -> Client_API_Wapper: Agreement & EndpointDataReference -Client_API_Wapper -> Client_EDC: PCF endpoint call incl. req.ID, BPN & comment -Client_EDC -> Company_EDC: PCF endpoint call incl. req.ID, BPN & comment -note right -Using PCF API through EDC via HTTP Proxy: -GET https://{someURL}/productIds/mat345?requestId=123&BPN=&comment=... -end note -Company_EDC -> Company_PCF_App: PCF endpoint call incl. req.ID, BPN & comment -note right -Can we use existing -PCF API directly? -If so: no AAS adapter -would be needed! -end note -Company_PCF_App -> Company_EDC: Accepted -Company_EDC -> Client_EDC: Accepted -Client_EDC -> Client_API_Wapper: Accepted -Client_API_Wapper -> PCF_Client: Accepted -end -end - -Company_PCF_App -> Company_PCF_App: Approve PCF Request and\ncalculate PCF if needed - -group Receive/Send PCF value - -group Technical user login (not shown in detail here) -end - -group Lookup Clients's EDC -Company_PCF_App -> EDC_Discovery_Service: Lookup EDC URL (via BPN) -note right -POST https://portal-backend.some.demo.catena-x.net/api/administration/connectors/discovery -{ - [ ] -} -end note -EDC_Discovery_Service -> Company_PCF_App: EDC URL -end - -group Lookup Clients PCF Receive Asset -Company_PCF_App -> Company_EDC: Lookup Client's Receive Asset\n(via Company's EDC URL) -Company_EDC -> Client_EDC: Lookup Asset in Catalog\n(EDC asset type "data.pcf.exchangeEndpoint") -note right -There could be multiple EDC URLs, but -only one with a PCF Exchange Asset -end note -Client_EDC -> Company_EDC: PCF Asset -Company_EDC -> Company_PCF_App: PCF Asset ID -end - -group Push PCF to Client -Company_PCF_App -> Company_API_Wapper: Invoke asset with reqID, BPN & comment -note right -PUT https://clientApiWrapperUrl/api/service/20ac18ab-5820-4065-9087-416d78e155cd/productIds/mat345?providerUrl=https://client.controlplane.url:8184&requestId=123&BPN=& -end note -Company_API_Wapper -> Company_EDC: Negotiate access to asset and enable proxy transfer -Company_EDC -> Client_EDC: Negotiate access to asset and enable proxy transfer -Client_EDC -> Company_EDC: Agreement & EndpointDataReference -Company_EDC -> Company_API_Wapper: Agreement & EndpointDataReference -Company_API_Wapper -> Company_EDC: PCF endpoint call incl. req.ID & BPN -Company_EDC -> Client_EDC: PCF endpoint call incl. req.ID & BPN -note right -Using PCF API through EDC via HTTP Proxy: -PUT https://{someURL}/productIds/mat345?requestId=123&BPN= -end note -Client_EDC -> PCF_Client: PCF endpoint call incl. req.ID, BPN & comment -PCF_Client -> Client_EDC: OK -Client_EDC -> Company_EDC: OK -Company_EDC -> Company_API_Wapper: OK -Company_API_Wapper -> Company_PCF_App: OK -end -end - -@enduml \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/PCFRequestthroughAAS.png b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/PCFRequestthroughAAS.png deleted file mode 100644 index aa0c927fbf8..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/PCFRequestthroughAAS.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/PCFUpdate.puml b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/PCFUpdate.puml deleted file mode 100644 index 67ad46e1667..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/PCFUpdate.puml +++ /dev/null @@ -1,68 +0,0 @@ -@startuml "PCF Update pushed through EDC" - -participant PCF_Client -participant Client_EDC -participant EDC_Discovery_Service -participant Company_EDC -participant Company_DTR -participant Company_API_Wapper -participant Company_PCF_App - -Company_PCF_App -> Company_PCF_App: Calculate updated PCF value -Company_PCF_App -> Company_PCF_App: Select reveivers for PCF push update - -group Send updated PCF value to already known Client - -group Technical user login (not shown in detail here) -end - -group Lookup Clients's EDC -Company_PCF_App -> EDC_Discovery_Service: Lookup EDC URL (via BPN) -note right -POST https://portal-backend.some.demo.catena-x.net/api/administration/connectors/discovery -{ - [ ] -} -end note -EDC_Discovery_Service -> Company_PCF_App: EDC URL -end - -group Lookup Clients PCF Receive Asset -Company_PCF_App -> Company_EDC: Lookup Client's Receive Asset\n(via Company's EDC URL) -Company_EDC -> Client_EDC: Lookup Asset in Catalog\n(EDC asset type "data.pcf.exchangeEndpoint") -note right -There could be multiple EDC URLs, but -only one with a PCF Exchange Asset -end note -Client_EDC -> Company_EDC: PCF Asset -Company_EDC -> Company_PCF_App: PCF Asset ID -end - -group Push PCF to Client -Company_PCF_App -> Company_API_Wapper: Invoke asset with sender's BPN -note right -PUT https://clientApiWrapperUrl/api/service/722b7ea2-3bc6-4f9e-a106-b8650d206b69/productIds/mat345?providerUrl=https://client.controlplane.url:8384&BPN= -{ - ...Updated PCF JSON in Body... -} -end note -Company_API_Wapper -> Company_EDC: Negotiate access to asset and enable proxy transfer -Company_EDC -> Client_EDC: Negotiate access to asset and enable proxy transfer -Client_EDC -> Company_EDC: Agreement & EndpointDataReference -Company_EDC -> Company_API_Wapper: Agreement & EndpointDataReference -Company_API_Wapper -> Company_EDC: PCF endpoint call incl. sender's BPN -Company_EDC -> Client_EDC: PCF endpoint call incl.sender's BPN -note right -Using PCF API through EDC via HTTP Proxy: -PUT https://{someURL}/productIds/mat345?BPN= -{ ... } -end note -Client_EDC -> PCF_Client: PCF endpoint call incl. sender's BPN -PCF_Client -> Client_EDC: OK -Client_EDC -> Company_EDC: OK -Company_EDC -> Company_API_Wapper: OK -Company_API_Wapper -> Company_PCF_App: OK -end -end - -@enduml \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/PCFUpdatepushthroughEDC.png b/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/PCFUpdatepushthroughEDC.png deleted file mode 100644 index 56627e53322..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/PCF Exchange Kit/resources/development-view/PCFUpdatepushthroughEDC.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/Quality-Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-23.09/kits/Quality-Kit/Software Development View/page_software-development-view.md deleted file mode 100644 index b9d73705985..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Quality-Kit/Software Development View/page_software-development-view.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -id: Specification Quality Kit -title: Specification -description: 'Quality Kit' -sidebar_position: 4 ---- - -![Quality kit banner](@site/static/img/QualityKitIcon.png) - -### Quality KIT - -## Quality Data Offers at EDC - -For the process described in the KIT Quality, data exchange between the participating partner companies is necessarily to be done for large vehicle and product populations. The data exchange therefore tshould be done as a file download via EDC according to the following specifications. - -### **Asset File type** - -It is recommended to create and transfer the files in the types csv, parquet, json or xls - -### **Asset Transfers** - -File transfer can be done via EDC S3 plane or alternatively REST http. - -### **Asset consumption** - -**File** flattening **rules**: The data provided in the asset is build from 4 to 6 structures. To assure a secure and smooth exchange flatting rules for the file (csv / xls / Parquet / json) must be applied. This includes checks for format and possible values for each column and will be part of next version regulations. If the rules are not applied correctly the mapping of content will not be possible without manual handling effort. - -## Sample Data - -Standard version from: 09.2023 - -In the following, example data for the standardized data models are provided as download in zip format. The sample data is generated according the current standards. It contains a virtual fleet of 50.000 vehicles where two quality issues are implemented. - -- Production failure of product "zehn" at Tier 1 -- Specification failure - -### Quality Task Sample Data - -Github Link to semantic data model: [CX-00036 Quality Task](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.quality_task) - -Filedownload: 20230704-io.catenax.quality_task.zip - -As **data provider** please add the **JSON file** from folder tesdata_CX32 -as EDC asset id to **EDC REST data plane**: -CX_release32_qualitytask_100_testdata_100_json - -As **data provider** please add the **PARQUET file** from folder tesdata_CX32 -as EDC asset id to **EDC S3 data plane**: -CX_release32_qualitytask_100_testdata_100_parquet - ---- - -### Quality Task Attachment Sample Data - -Github Link to semantic data model: [CX-00092 Quality Task Attachment](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.quality_task_attachment) - -Filedownload: 20230718-io.catenax.quality_task_attachment.zip - -As **data provider** please add the **PARQUET file** from folder tesdata_CX32 -as EDC asset id to **EDC S3 data plane**: -CX_release32_qualitytaskattachment_100_testdata_100_zip - ---- - -### Fleet Vehicles Sample Data - -Github Link to semantic data models: - -[CX-00037 Vehicle Product Description](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.vehicle.product_description) - -[CX-00091 Fleet Vehicles](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.fleet.vehicles) - -Filedownload: 20230707-io.catenax.fleet.vehicles.zip - -As **data provider** please add the **JSON file** from folder tesdata_CX32 -as EDC asset id to **EDC REST data plane**: -CX_release32_fleetvehicles_100_testdata_100_json - -As **data provider** please add the **PARQUET file** from folder tesdata_CX32 -as EDC asset id to **EDC S3 data plane**: -CX_release32_fleetvehicles_100_testdata_100_parquet - ---- - -### Fleet Diagnostic Sample Data - -Github Link to semantic data model: [CX-00038 Fleet Diagnostic Data](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.fleet.diagnostic_data) - -Filedownload: 20230707-io.catenax.fleet.diagnostic_data.zip - -As **data provider** please add the **JSON file** from folder tesdata_CX32 -as EDC asset id to **EDC REST data plane**: -CX_release32_fleetdiagnostic_100_testdata_100_json - -As **data provider** please add the **PARQUET file** from folder tesdata_CX32 -as EDC asset id to **EDC S3 data plane**: -CX_release32_fleetdiagnostic_100_testdata_100_parquet - ---- - -### Fleet Claim Sample Data - -Github Link to semantic data model: [CX-00039 Fleet Claim Data](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.fleet.claim_data) - -Filedownload: 20230707-io.catenax.fleet.claim_data.zip - -As **data provider** please add the **JSON file** from folder tesdata_CX32 -as EDC asset id to **EDC REST data plane**: -CX_release32_fleetclaim_100_testdata_100_json - -As **data provider** please add the **PARQUET file** from folder tesdata_CX32 -as EDC asset id to **EDC S3 data plane**: -CX_release32_fleetclaim_100_testdata_100_parquet - ---- - -### Manufactured Parts Quality Information Sample Data - -Github Link to semantic data model: [CX-00041 Manufactured Parts Quality Information](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.manufactured_parts_quality_information) - -Filedownload: 20230707-io.catenax.manufactured_parts_quality_information.zip - -As **data provider** please add the **JSON file** from folder tesdata_CX32 -as EDC asset id to **EDC REST data plane**: -CX_release32_manufacturingqualityinformation_100_testdata_100_json - -As **data provider** please add the **PARQUET file** from folder tesdata_CX32 -as EDC asset id to **EDC S3 data plane**: -CX_release32_manufacturingqualityinformation_100_testdata_100_parquet - ---- - -### Parts Analyses Sample Data - -Github Link to semantic data model: [CX-00040 Parts Analyses](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.parts_analyses) - -Filedownload: 20230704-io.catenax.parts_analyses.zip - -As **data provider** please add the **JSON file** from folder tesdata_CX32 -as EDC asset id to **EDC REST data plane**: -CX_release32_partsanalyses_200_testdata_100_json - -As **data provider** please add the **PARQUET file** from folder tesdata_CX32 -as EDC asset id to **EDC S3 data plane**: -CX_release32_partsanalyses_200_testdata_100_parquet diff --git a/docs-kits_versioned_docs/version-23.09/kits/Quality-Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-23.09/kits/Quality-Kit/page_adoption-view.md deleted file mode 100644 index 3d99a074d46..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Quality-Kit/page_adoption-view.md +++ /dev/null @@ -1,453 +0,0 @@ ---- -id: Adoption View Quality Kit -title: Adoption View -description: 'Quality Kit' -sidebar_position: 2 ---- - -![Quality kit banner](@site/static/img/QualityKitIcon.png) - -### Quality KIT - -## Vision & Mission - -### Vision - -Our vision is to move from parts-based quality management on a bilateral level between supplier and customer to a data-based approach across the OEM-n-Tier chains of value creation to enable a network approach for producing and ensuring product quality. - -![quality kit vision diagram](@site/static/img/quality-kit_vision-min.png) - -The Quality KIT enables **data provider** and **consumer** to exchange and analyse existing data across company boundaries on a daily basis, securely and easily. By merging the OEM's field quality data and the supplier's product information, a new level of transparency is achieved in a joint analysis (single point of information). This leads to earlier failure detection, faster cooperation between partners and acceleration of root cause analysis. Once the root cause of the problem is known, corrective actions can be targeted to the products and vehicles that have the quality problem using Catena-X traceability capabilities. The containment minimises the number of parts & vehicles for which corrective actions need to be implemented. - -This KIT enables **quality app provider** to deliver solutions for quality data analysis including tracebility and notification functionalities. - -### Mission - -![quality kit mission diagram](@site/static/img/quality-kit_mission-min.png) - -The Quality KIT provides the necessary standards, aspect models, technical data pipeline specifications and business logics on how to estabilish a soverein exchange of quality related data along the OEM-Tier n chain. All the components mentioned are based on the following principles: - -- We bring together data from suppliers and manufacturers (OEM). -- Data exchange between data provider and consumer complies with the Catena-X network's data sovereignty principles. -- Data exchange enables each partner to use the applications of their choice for data analysis features like Early Warning and Root Cause Analysis. -- We standardize data models incl. their assets -- Data exchange in the current Quality KIT version is described as a common requirement. -- Analysis methods and algorithms that are realized in the quaity applications are not part of any standardization. It is desirable that different tools deliver different results Specialisation of tools is valuable. - -In sum this KIT enables quality management to substantially **increase speed** in resolving quality problems and reach a **new level on transparency** and traceability. - -### Customer Journey - -With the Quality KIT, we support the Catena-X customer journey for our adopters and solutions providers. - -![quality kit customer journey diagram](@site/static/img/quality-kit_customer-journey-min.png) - -## Business Value - -Through the standardized specifications described in the “Quality-KIT” – mainly the semantic models and data exchange process – data providers & consumers can build up a soverreign and trusty data exchange pipeline with their partner companies and reduce investment and implementation costs to integrate data based quality processes in their company inhouse process and IT landscape. - -Furthermore, quality application providers can also reduce the implementation effort and enter potential new markets providing specific analytic capabilities. - -## Use Case - -### Status Quo / Today's challenge - -In today’s global and complex collaboration models quality does not emerge as the sum of the quality contributions of the individual partners in the value chain of OEM and suppliers, but rather because of the networking of the partners involved. - -The existing conventional bilateral working models do not account for this. There is no operative network in the industry with a substantial coverage of elements of the value chains that provides the necessary means for collaborative quality management with all involved partners. - -From Quality Management perspective, the main challenge within the automotive industry is to define and implement inter-organizational end-to-end data chains across the whole automotive partner chain to empower data driven quality use cases. - -Main challenges to ensure a trustful and scalable cooperation are: - -- Trustful and sovereign data exchange mechanism including ... - - legal contracts and access/usage policy framework along the complete data chain - - Standardized data pipeline - - Aligned standard data exchange, e.g. file format and transfer -- Standardized data models - -### Benefits - -![quality kit benefits diagram](@site/static/img/quality-kit_benefits-min.png) - -#### OEM and large automotive suppliers - -The Quality KIT from Catena-X enables companies to realize trustful and sovereign data exchange with their partners and utilize the data in a cooperative way for an Early Warning of known and unknown quality issues. Root causes can be analysed und understood much faster what leads to an earlier and focussed counter measure. In sum companies can realize economic benefit by reduction of warranty costs while at the same time increasing customer satisfaction due to a maximum availability of vehicles, products and services. - -#### SME - -The defined standards like data models and data exchange pipelines enforce a flexible and low-barries approach to integrate quality use cases and features according to SME need. An easy access to analytic capabilities or transparent analytic results from partner companies leads to an economic benefit from warranty costs reduction via faster on more focused activities related to quality issues. - -#### Solution Provider - -Solution providers have the potential to scale customer groups via platform effects and standardization of data models and their exchange. Additional new market potentials can be accessed via marketplace and shared service network. - -**Example: Benefits of using early warning and root cause analyses in active field monitoring of a vehicle component** - -OEM A and supplier B agree to carry out quality analyses with field data from the OEM and production data from the supplier based on Catena-X Use Case Quality Methodology (live control loop see above) and with Catena-X-certified tools. For this purpose, a quality case with framework conditions is agreed to in the use case. A component and the associated data are selected. After technical and organizational onboarding and the agreed data exchange, the joint analysis room is available and collaborative quality work can be started. - -In general, one of the partners carries out continuous monitoring of the components using the common database. This allows, for example, error messages in the vehicle, repairs and claims to be monitored and anomalies are immediately visible. - -In our example, an engine component passes on various error messages (DTCs = Diagnosis Trouble Codes) to the vehicle via the central engine control unit. After 4 weeks, it is visible in the Catena-X certified tool that a DTC in the field is slowly but steadily increasing. With Catena-X Tooling, this is immediately recognized, although no increasing workshop visits and repairs are yet visible in the database. An employee of a partner immediately notices this and shares this observation with the joint team. At the same time, the employee begins to clarify through initial analyses whether the anomaly is actually a problem. Since it quickly becomes clear from the data that this is a potentially critical fault pattern with the result of increasing repair cases and that a replacement of parts may be necessary, the employee reports this to the joint team (early warning). - -The team decides to carry out a root cause analysis together. Various hypotheses about the cause of the fault are examined: running times are compared, software levels, environmental conditions at the time the fault occurred, etc. The cause of the fault is a diagnostic algorithm modified in a software update, which results in the abnormal DTC appearing more often in the field at hot temperatures. This is caused by the production of vehicles from a certain point in time with the new software version or the installation of a new software version for vehicles in the field, e.g. during a service visit to a workshop. - -As a jointly defined corrective measure between OEM and supplier, a modified algorithm will be integrated into the next regular software update. This starts as soon as possible in vehicle production and vehicles with the faulty software version receive a software update the next time they visit the workshop. For this purpose, repair shops are informed that the displayed error (DTC) for a particular software version is a software problem and does not require any repair. This minimizes costs due to unnecessary repairs. - -The affected component continues to be monitored regularly. After a few months, there is a decrease in the conspicuous DTC corresponding to the reduction in the number of vehicles in the field with the faulty software version (proof of effectiveness of the corrective measure adopted). - -The image below shows user feedback, challenges, results and benefits of the new data-based way of working using the example of the Early Warning & Root Cause Analysis process steps. - -![quality kit example of benefits chart](@site/static/img/quality-kit_example-benefit-min.png) - -**Conclusion:** - -The example impressively shows that with the Catena-X methodology (live control loop), quality problems can be identified earlier, the causes of faults can be found more quickly, corrective measures can be carried out in a more targeted manner and the affected vehicles can be narrowed down more precisely. There are similar examples of the conversion of production parameters at the supplier or design errors in the design of vehicle components. - -(Source: The example is based on real project results from piloting the Catena-X methodology at an OEM with 5 selected suppliers) - -## Tutorials - -The following videos gives an overview of the presented Quality Improvement Use Case. - -Overview about how Quality Management is improved by Catena-X - - - -For more technical details take a look at the video in the [Operation View](/docs-kits/kits/Quality-Kit/page_software-operation-view.md) - -Data driven Quality Management with Catena-X - Statements from the consortial partners - - - -## Semantic Models - -### Semantic Structure - -![semantic structure chart](@site/static/img/quality-kit_semantic-structure-min.png) - -### Overview Data Model Entities - -Download for MS Excel: Quality_KIT_DataModelOverview_v1.0.xlsx - -### Quality Task - -Quality Task is the root element and describes why companies are working together on a quality topic and what they want to do. All involved companies and their contact people are named. In addition, a flag tells what should be done with exchanged data after a Quality Task is closed. A Quality Task (qTask) can be created by both **OEM or Supplier** and defines why data is exchanged between two or more companies and what insights should be generated out of the transferred data. In addition, there is a flag what happens with the transferred data when this qTask is closed. - -**Remark**: The table contains an overview about the data content as explanation. For the implementation of the valid entity naming and semantic structure please reference to the model definition in Github. - -| Entity name | Entity description | Example | -|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------| -| qualityTaskId | An unique quality task identifier for this quality task. Each company generates their own quality task ids using the Catena-X business partner number. | BPN-811_2022_000001 | -| status | Status of this quality task | new | -| creationDate | Timestamp when this quality task was created | 2019-04-01T14:00:00 | -| title | Working title for this quality task | Early Warning A | -| description | Description what should be done in this quality task | Early Warning of vehicle model A | -| component | The component that should be monitored or investigated in this quality task | ComponentA | -| dataDeletion | What should be done with the data after this quality task is closed | delete-data-after-closing | -| cxBPN | Catena-X Business Partner Number (BPN) of the involved company | BPN-8110 | -| name | Name of the involved company | testCompanyA | -| email | E-Mail of the key contact at involved company | Horst.Schlemmer@testCompanyA.de | - -Github Link to semantic data model: [CX-00036 Quality Task](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.quality_task) - -### Quality Task Attachment - -Quality Task Attachment gives the ability to share data that is not standardized in an existing semantic model yet. Non standardized data provisioning is realized as a file transfer. The model contains file parameters and the schema of structured data in the provided file. A Quality Task Attachment can be provided by both **OEM or Supplier**. - -**Remark**: The table contains an overview about the data content as explanation. For the implementation of the valid entity naming and semantic structure please reference to the model definition in Github. - -| Entity name | Entity description | Example | -|--------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------| -| qualityTaskId | Reference to a Quality Task: A unique identifier. The company creating this quality task sets this identifier. The identifier should contain the BPN to make it unique insidethe CX network. | BPN-811_2022_000001 | -| relatedModelType | Name of the semantic data model, that the attachment belongs to. | fleet diagnotic data | -| fileDescription | Description of the file content | Fleet environmental conditions | -| fileName | Name of the provided file | Histogramm_data.csv | -| sizeInKb | Size of the provided file in KiloByte | 615 | -| fileExtension | Extension of the provided file | csv | -| filePath | Path of the provided file - If file is provided in a folder structure | /subfolder/Histogramm_data.csv | -| delimiter | Delimiter that separates column values in a tabular form like e.g. a "csv" file | semicolon | -| unit | Physical unit of each variable in a tabular schema | degreeCelsius | -| variableName | Name of each variable in a tabular schema | Ambient temperature | -| dataType | Data type of each variable in a tabular schema | double | -| variableDescription | Description of each variable in a tabular schema | This column contains the hourly ambient temperature | -| decimalSeperator | Seperator in a decimal number | comma | - -Github Link to semantic data model: [CX-00092 Quality Task Attachment](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.quality_task_attachment) - -**OEM Data**: Data structured in the following semantic models are to be delivered by OEM. - -### Fleet Vehicles Product Description - -Master data for each vehicle of a specific population - from an end customer view. This model represents the vehicle as it was sold to the customer. All entities and properties are constant over the lifetime of the vehicle. - -**Remark**: This semantic model contains of two models that are standardized in CX-00091, containing the vehicle population (listOfVehicles) and CX-00037 containing the data entities. The table contains an overview about the data content as explanation. For the implementation of the valid entity naming and semantic structure please reference to the model definition in Github. - -| Entity name | Entity description | Example | -|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| -| anonymizedVin | OEM-specific hashed VIN; link to car data over pseudonymized/hashed VIN or Catena-X unique digital twin identifier | 3747429FGH382923974682 | -| class | Class of the vehicle | A | -| driveType | Drive type of a vehicle according to enumeration | All-Wheel Drive (AWD) | -| emptyWeight | The empty weight of the vehicle in kg as specified | 2000 | -| modelDescription | Detail vehicle model, e.g. "Golf VIII" | CX test model 2 | -| modelIdentifier | OEM-specific model identifier or OEM-specific project name | 689-G8 | -| steeringPos | Position of vehicle steering wheel (e.g. left or right) | Left-Hand Drive (LHD) | -| catenaXId | A fully anonymous Catena-X identifier that is registered in CX Digital twin registry. Can be used for vehicles, parts, workshops, etc. | 580d3adf-1981-44a0-a214-13d6ceed9379 | -| vehicleSeries | Vehicle series, normally one level above model. E.g. vehicle series ="Golf", vehicle model="Golf VIII" | Series1 | -| systemPower | Complete power of this vehicle in KW | 110 | -| hybridizationType | Kind of the hybridization in this vehicle | battery electric vehicle | -| softwareCategory | Some OEMs bring in the software as a complete package for all systems. To identify this software, software category and software version is needed. Software category when his car was built | TZGH64738 | -| softwareVersion | Some OEMs bring in the software as complete package for all systems. To identify this software, software category and software version is needed. Software version when his car was built | 3.4.9837.567 | -| cxBPN | Catena-X business partner number of the OEM company | urn:uuid:4789d3adf-cax_qax1-_oem-13d6ceed9379 | -| wmiCode | Short name/code of the vehicle manufacturer according to world manufacturer information(wmi). The wmiCode is the first 3 chars of the vehicle identification number. | CAX | -| wmiDescription | Name of OEM according to NHTSA or other authorities. Has to be compliant with linked wmiCode attribute. | CatenaX Test OEM | -| colorId | Color code describes the code of a specific color of one vehicle | LY7W | -| colorDescription | Color name describes the color of the color code as a written word | Light grey | -| numberOfDoors | Describes the number of doors of a vehicle | 5 | -| kbaBody | Vehicle variant - Body shapes according to German KBA | Limousine | -| nhtsaBody | Vehicle variant - Body shapes according to US NHTSA | Cargo Van | -| equipmentDescription | The equipment variants description | Sport seats | -| equipmentIdentifier | The identifier of a specific equipment | SDCF34 | -| group | Grouping the special equipment into categories like (e.g. interior) | Interior | -| plantDescription | Long name of the production plant of the vehicle | Wolfsburg | -| plantIdentifier | Plant id of the final assembly of the vehicle | 4711 | -| productionDate | Production date of the vehicle | 2018-01-15T00:00:00 | -| countryCode | Vehicle sold country in ISO 3166 alpha 3 | DEU | -| countryGroup | Region where this car was sold | Europe | -| soldDate | Sold date of the vehicle = warranty start date for this vehicle | 03.02.2018 | -| engineDescription | Description of the engine | 2.0 Diesel | -| engines.engineId | OEM-specific identifier/type of the installed engine | Type100 | -| engineProductionDate | Date when the engine was produced | 2017-10-20T00:00:00 | -| engineSeries | Engine series | Series10 | -| installDate | Date when the engine was installed | 2018-01-10T00:00:00 | -| power | Engine power is the power that an engine can put out | 110 | -| serialNumber | serial number of the installed engine | b11c7587a | -| size | Cubic capacity in a combustion engine - not available in battery-electric vehicles | 1998 | -| kbaFuelType | Description of the fuel according German KBA | Diesel | -| nhtsaFuelType | Description of the fuel according US NHTSA | Diesel | - -Github Links to semantic data models: - -[CX-00037 Vehicle Product Description](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.vehicle.product_description) - -[CX-00091 Fleet Vehicles](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.fleet.vehicles) - -### Fleet Diagnostic Data - -Data model for vehicle diagnostic data suitable for mass data transfer. Diagnostic data coming from multiple vehicles that are affected by an quality issue + Diagnostic data from similar vehicles that are not affected by an quality issue. - -**Remark**: The table contains an overview about the data content as explanation. For the implementation of the valid entity naming and semantic structure please reference to the model definition in Github. - -| Entity name | Entity description | Example | -|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------| -| workShopId | OEM internal workshop ID | 8632208 | -| type | Indicator whether this DTC was stored as error or Info | Error | -| swVersion | Current version of the software on this ECU | AA | -| swPartNumber | SW part number of this ecu | SW_A | -| softwareVersion | Software version of this car during the session - only available for OEMs that have a software category on vehicle level | 3.5.0001.001 | -| softwareCategory | Software category of this car during the session - only available for OEMs that have a software category on vehicle level | TZGH64738 | -| sessionId | Format is OEM-specific: A unique session identifier within one OEM. | APD5889H7J6OZV5KR80D0D470833L0A_20190407 | -| readOutDate | Date when this ECU information was read out from the diagnostic session | 2022-10-12T03:59:00 | -| qualityTaskId | A unique quality task identifier, where these lists of session data belong to. Optional to ensure that also diagnostic data without quality task can be exchanged. | BPN-811_2022_000001 | -| occurenceMileage | Mileage in km when the DTC occurred the first time | 30 | -| occurenceDateTime | Date and time when the DTC occurred the first time/was recorded the first time in the ECU | 2022-01-30T14:48:54 | -| occurenceCounterTotal | Counter how often this DTC was set in total | 22 | -| name | Name of ECU | ABS | -| mileage | Current mileage counter of the car during the diagnostic session | 120 | -| measurementUnit | The unit of measurement for the environment condition value. | rpm | -| longitude | Longitude of this workshop | 53,14968808 | -| latitude | Latitude of this workshop | 17,23471843 | -| isMilOn | Describes whether this DTC set the MIL (malfunction indicator light) in the dashboard | true | -| hwVersion | Hardware version of ECU | V1 | -| hwPartNumber | Hardware part number of ECU | HW_A1 | -| fullName | Combined string of DTC name plus the so called DTC sub type or DTC failure byte. Both string values are concatenated using a "-" as eparator. DTC name is: B\|C\|P\|U + 4 hex chars DTC failure byte: 2 hex chars In some rare cases this could be just a hex string | P0001-00 | -| fullDescription | Description of DTC and failure byte. Both description strings are concatenated using a "-" as separator | Catena-X test dtc 1 | -| freezeFrame | Undecoded freeze frame from ECU. The freeze frame records many parameters of the DTC and surrounding parameters like outside temperature when the DTC was set. It is a very long HEX string with many OEM-specific and ECU-specific content in | Example_freeze_frame | -| faultPathDescription | OEM-specific description of DTC fault path | Shortage to plus | -| faultPath | OEM-specific: Fault path for this DTC. Allows further analysis | 1000761 | -| eventValue | The value of this event. For example, the calibration file used. | CAL366474-4848 | -| eventId | OEM-specific: Primary key for this event | ABS_CAL1234 | -| eventDescription | The description of the event | Calibration of ABS ecu with calib file - see value | -| eventCreationDate | Date and time when this event occured | 2022-10-12T03:59:00 | -| ecuSerialPartNumber | Unique serial number of ECU | 60284BD6790 | -| ecuSerialPartNumber | Serial number of ECU | 60284BD6790 | -| ecuSerialPartNumber | Serial number of ECU | 60284BD6790 | -| ecuSerialPartNumber | Serial number of ECU | 60284BD6790 | -| dtcList.state | OEM-specific state of DTC: 0;1 (permanent/temporary/intermediate), could also be a string with permanent, temporary, intermediate, etc. | permanent | -| dtcHexValue | Hex value of this DTC | 4337499FF | -| dtcHexValue | Hex value of this DTC | 4337499FF | -| dtcHexValue | Hex value of this DTC | 4337499FF | -| description | Long name of ECU | Anti-blocking control unit | -| creationDate | Date-timestamp for this session according to ISO 8601 when this session was created. Depending on OEM this attribute reflects the start or end date of one diagnostic session. | 2022-02-04T14:48:54 | -| countryCode | Country code in ISO 3166-1 alpha-3 codes, where this session took place | DEU | -| conditionValue | The numeric value (if applicable) of the stored environment condition at the time of the DTC. | 4000 | -| conditionId | OEM-specific: Primary key for this condition consists of unique identifier of env. condition and DTC | DTC1_EnvCond1 | -| conditionDescription | The description of the environment condition/information | RPM | -| conditionCreationDate | Date and time when this condition/information was created. | 2022-10-12T03:59:00 | -| catenaXId | A fully anonymous Catena-X identifier that is registered in the C-X Digital twin registry. This property can be used for vehicles, parts, workshops, etc. Optional: Not always available | urn:uuid:f5a1a3e716-cax_-qax1-test-1a8c38ea27 | -| catenaXId | A fully anonymous Catena-X identifier that is registered in the C-X Digital twin registry. This property can be used for vehicles, parts, workshops, etc. Optional: Not always available | urn:uuid:b11c7587af-cax_-qax1-car-f810a2cadc | -| assemblyPartNumberVersion | OEM-specific ECU assembly version | 1 | -| assemblyPartNumber | OEM-specific ECU assembly from hardware and software | V039352784 | -| anonymizedVIN | OEM-specific hashed VIN; link to car data over pseudonymized/hashed VIN or Catena-X unique digital twin identifier | APD5889H7J6OZV5KR80D0D470833L0A | - -Github Link to semantic data model: [CX-00038 Fleet Diagnostic Data](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.fleet.diagnostic_data) - -### Fleet Claim Data - -Customer complaints that are linked to this QualityTask +Data about the exchange of potentially faulty parts. - -**Remark**: The table contains an overview about the data content as explanation. For the implementation of the valid entity naming and semantic structure please reference to the model definition in Github. - -| Entity name | Entity description | Example | -|----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| -| claimId | Claim ID is unique for each OEM | B798JI26D | -| qualityTaskId | Reference to a Quality Task: A unique identifier. The company creating this quality task sets this identifier. The identifier should contain the BPN to make it unique inside the CX network. | BPN-811_2022_000001 | -| listOfDiagnosticSessionId | References to a list of diagnostic session IDs | APD5889H7J6OZV5KR80D0D470833L0A_20190407 | -| repairMileage | Mileage of the car when the claim was reported | 120 | -| repairDate | References the date when the claim was initially reported | 43562 | -| technicianComment | Short description of the claim from the technician | Technician comment | -| customerComment | Short description of the claim from customer view (vehicle owner) | Customer comment | -| damageCode | OEM-specific damage code | G300 | -| vehicleCatenaXId | Catena-X car ID /digital twin of car | urn:uuid:b11c7587af-cax_-qax1-car-f810a2cadc | -| anonymizedVIN | OEM-specific hashed VIN; link to car data over pseudonymized/hashed VIN or Catena-X unique digital twin identifier | APD5889H7J6OZV5KR80D0D470833L0A | -| isPartReplaced | Flag is set if part was replaced. true: replaced false: not replaced | true | -| isPartCausal | Flag set to true if part was causing the problem. true: part caused the problem. false: part did not cause the problem. | true | -| amountOfReplacedParts | Counter for non-serial parts which have been replaced | 1 | -| replacedPart.name | OEM specific name of the part | zehn | -| replacedPart.number | OEM specific part number | 8D34393E7FFE | -| replacedPart.catenaXId | A fully anonymous Catena-X identifier that is registered in C-X Digital twin registry. This property is being used for vehicles, parts, workshops, etc. Optional, not always available. | urn:uuid:b11c7587af-cax_-qax1-part-f810a2cadc | -| replacedPart.serialNumber | OEM serial part number of the part - only available for serial parts | 1 | -| replacedPart.supplierId | OEM-specific ID of the supplier that manufactured the part that was put out - available if known | ZF2064600502 | -| sparePart.name | OEM specific name of the part | zehn | -| sparePart.number | OEM specific part number | 8D34393E7FFE | -| sparePart.catenaXId | A fully anonymous Catena-X identifier that is registered in C-X Digital twin registry. This property is being used for vehicles, parts, workshops, etc. Optional, not always available. | urn:uuid:b11c7587af-cax_-qax1-part-f810a2cad6 | -| sparePart.serialNumber | OEM serial part number of the part - only available for serial parts | 1000 | -| sparePart.supplierId | OEM-specific ID of the supplier that manufactured the part that was put in - available if known | ZF2064600502 | - -Github Link to semantic data model: [CX-00039 Fleet Claim Data](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.fleet.claim_data) - -**Supplier Data**: Data structured in the following semantic models are to be delivered by Supplier (Tier n). - -### Manufactured Parts Quality Information - -A selection of manufacturing-related parameters that help to solve a quality issue. - -**Remark**: The table contains an overview about the data content as explanation. For the implementation of the valid entity naming and semantic structure please reference to the model definition in Github. - -| Entity name | Entity description | Example | -|-----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| -| catenaXId | The fully anonymous Catena-X ID of the manufactured part only available after digital twin registry is fully operational | urn:uuid:b11c7587af-cax_-qax1-part-f810a2cadc | -| qualityTaskId | A unique quality task identifier where this manufacturing information belongs to. Optional to ensure that there is also data exchange without having a quality task. | BPN-811_2022_000001 | -| manufacturerId | Identifier assigned by the manufacturer for this specific part. In case of common parts: This identifier is not unique. | 123-0.740-3434-A | -| manufacturerSerialPartNumber | Serial part number given by the manufacturer. Not available for common parts. | 436347347.4343884384.FTG.000001 | -| nameAtManufacturer | Name of the manufactured part as given by the manufacturer | zehn_Supplier | -| date | Production date of the component | 2018-10-01T14:24:00 | -| country | Country code where the part was manufactured | DEU | -| plantId | Manufacturer-specific identifier of theproduction plant of this part | 00001 | -| plantDescription | Manufacturer-specific description of the production plant of this part | Supplier_Plant_1 | -| batchId | Manufacturer-specific batch identifier: In which batch was this part manufactured | 20181001_14 | -| productionLine | On which production line was this part produced | Line_1 | -| hasBeenReworked | Indicator whether this part was reworkedduring manufacturing and before delivery | FALSE | -| numberOfConductedEOLTests | Number how often this part went through the EOL test | 1 | -| addtionalInformation.key | Key identifier for this additional information | SteelQuality | -| addtionalInformation.value | Value for this additional information | StainlessSteel | - -Github Link to semantic data model: [CX-00041 Manufactured Parts Quality Information](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.manufactured_parts_quality_information) - -### Parts Analyses - -Analyses results of replaced and potentially faulty parts, that are linked to this Quality Task. - -**Remark**: The table contains an overview about the data content as explanation. For the implementation of the valid entity naming and semantic structure please reference to the model definition in Github. - -| Entity name | Entity description | Example | -|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| -| anonymizedVin | OEM-specific hashed VIN; link to car data over pseudonymized/hashed VIN or Catena-X unique digital twin identifier | 3747429FGH382923974682 | -| manufacturerAnalysisID | Component manufacturer specific identifier of the analysis process | TIER-647439403403 | -| customerAnalysisID | Customer specific identifier of the analysis process | OE-43673473438 | -| catenaXIdentifier | The fully anonymous Catena-X ID of the analyzed part - only available after digital twin registry is fully operational | urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9000 | -| qualityTaskId | A unique quality task identifier to which this list of parts analysis belongs to | BPN-811_2022_000001 | -| manufacturerPartIdentifier | Part Id of the analyzed part as assigned by the manufacturer of the part. The Part Id identifies the part type and is not unique for each serial part. | 123-0.740-3434-A | -| manufacturerSerialPartNumber | Serial Part Number of the analyzed part as assigned by the manufacturer of the part. The serial part number is unique for each serial part. Not available for all kinds of parts | 436347347.4343884384.FTG.000001 | -| customerPartIdentifier | Part ID as assigned by Original Equipment Manufacturer (OEM) | 8D34393E7FFE | -| nameAtManufacturer | Name of the analyzed part as assigned by the manufacturer of the part | zehn_Supplier | -| status | Status of this part analysis | new | -| isDefect | True: Analysis turned out that analyzed part is defect according to part's specification. | false | -| resultsDescription | Detailed description of part analysis results | Corrosion on component part_A | - -Github Link to semantic data model: [CX-00040 Parts Analyses](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.parts_analyses) - -## Logic & Schema - -### Business Logic - -![quality kit business logic diagram](@site/static/img/quality-kit_business-logic-min.png) - -The prerequisite for faster faster problem solving is the earliest possible detection of a problem (early warning) and the fastest possible understanding of the error chain and cause (root cause analysis). Early Warning in general has to be realized at all relevant points along the value chain. - -**Early Warning** in the **Field**, an early warning system for issues in a vehcile fleet, enables the earliest possible detection of quality problems in products in vehicles after delivery. Vehicle data from the OEM is used for the analysis, in particular fault codes that are stored in ECUs and read out during a workshop visit or frequently "over the air". Increases in product-specific fault codes across the vehicle population provide a reliable indicator of quality problems much earlier than through parts replacement and analysis. - -**Early Warning** in the **Production** focuses on early detection in the production of products. Various practical scenarios have been developed and the corresponding technical requirements specified. If, for example, a supplier discovers that a delivered product has a quality defect, the customer can be informed by means of notification. The functionality of traceability (Catena-X Use Case Traceability) in the supply chain makes it possible to trace in which vehicle or follow-up product the affected components are installed. Remedial measures can thus be applied specifically to a limited quantity. - -If a problem is detected by early warning in the field or in production, a data-based **Root Cause Analysis** is started. The aim is to derive hypotheses regarding the cause and effect relationship from the shared database of the customer and supplier and to verify them together. With the Catena-X network functions, this transparency can be achieved much faster. If the root cause is known more quickly, effective counter measures can be defined and implemented much faster. - -### Architecture Overview - -![independant architecture r3_2 chart](@site/static/img/quality-kit_general_app-independant_architecture-R3_2-min.jpg) - -The tier-1 receives data on vehicle master data, existing claims and DTCs. Once the data is received, the Tier-1 supplier is analyzing the data in order to detect patterns based on which DTCs and claims can be explained. The data is shared and consumed as assets via the companies' EDC while the authorization is managed via the the shared services of the consortia. - -#### Quality Components - -| Subsystem | Description | -|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Data Provisioning | This component provides a company's data to the Catena-X network by transforming it into the Catena-X format and publishing it. In Catena-X, data must be provided to the network based on existing standards from the other Kits. One example that can be used is the Connector Kit that builds a component based on the IDS protocol, e.g. the Connector of the Eclipse Dataspace Components (EDC). The data format used for Quality data is based on the aspects (Sub-)models published in the Semantic Hub. | -| Internal Systems | Existing internal systems of a Catena-X partner which provide data to Quality components. - For Data Provisioning: The data provided to Catena-X via the EDC should be fetched from a partner's internal system. e. g. quality claims, defect code collection system | -| Quality App | Enables traceability functionalities like quality alerts or notifications. When a Traceability App fetches data for digital twins (submodels), there are two options: - Directly access the partner's EDC (and the Digital Twin Registry) to connect to other partner's EDC and retrieve the data from ther - Use a local IRS service to get the data and let the IRS handle the EDC and Digital Twin Registry communication. | - -#### Catena-X Core Services - -| Subsystem | Description | -|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Eclipse Dataspace Components (EDC) | The Connector of the Eclipse Dataspace Components provides a framework for sovereign, inter-organizational data exchange. It will implement 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. [Repository of the Catena-X specific EDC](https://github.com/eclipse-tractusx/tractusx-edc). | -| SSI → MIW | The Self-Sovereign Identity is also a life long identity,( when credentials are created and the MIW is not reachable) , the other verifiers should be able to check and validate exisiting valid credentials from distributed databases, directory or DLT. The MIW (also called "Custodian") provides a private/public key pair and related DID for a legal entity along with the onboarding. | -| Discovery Service | The EDC / dataspace discovery interface is a CX network public available endpoint which can get used to retrieve EDC endpoints and the related BPNs, as well as search for endpoints via the BPN. | - -## Business Process - -To realize the **Business Logic** described in the Quality Kit - -![quality kit business process diagram](@site/static/img/quality-kit_business-process-min.png) - -all steps of the **Business Process** (described in the [Development View](https://confluence.catena-x.net/display/BDPQ/WORK+IN+PROGRESS+-+Quality+KIT+-+Development+View)), like data provisioning and consuming by the involved partner companies, are realized in compliance with the [Catena-X Data Governance Framework](https://catena-x.net/en/catena-x-introduce-implement/governance-framework-for-data-space-operations). Under this link you can find the latest version of the framework regulations as download. The documents are seperated in the following levels: - -![quality kit data offering diagram](@site/static/img/quality-kit_data-offering-min.png) - - -**Data Space Level**: 10 Golden Rules of Catena-X - -**Use Case Level**: Quality Management specific policy (not released yet) - -**Data Offering** and **Usage Level** are defined by bi-lateral aligned policies and contracts between the cooperating partner companies. Content is currently in definition. - -## Standards - -Our relevant standards can be downloaded from the official [Catena-X Standard Library:](https://catena-x.net/de/standard-library) - -- [CX - 0036 Semantic Model Quality Task](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/PLM_Quality_Use_Case_Live_Quality_Loops/CX_-_0036_Semantic_Model_Quality_Task_v_1.0.1.pdf) - -- [CX - 0037 Semantic Model Vehicle Product Description (to be updated when published)](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/PLM_Quality_Use_Case_Live_Quality_Loops/CX_-_0037_Semantic_Model_Vehicle_Product_Description_v_1.0.1.pdf) - -- [CX - 0038 Semantic Model Fleet Diagnostic Data](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/PLM_Quality_Use_Case_Live_Quality_Loops/CX_-_0038_Semantic_Model_Fleet_Diagnostic_Data__v_1.0.1.pdf) - -- [CX - 0039 Semantic Model Fleet Claim Data](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/PLM_Quality_Use_Case_Live_Quality_Loops/CX_-_0039_Semantic_Model_Fleet_Claim_Data__v_1.0.1.pdf) - -- [CX - 0040 Semantic Model Parts Analyses](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/PLM_Quality_Use_Case_Live_Quality_Loops/CX_-_0040_Semantic_Model_Parts_Analyses_v_1.0.1.pdf) - -- [CX - 0041 Semantic Model Manufactured Parts Quality Information](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/PLM_Quality_Use_Case_Live_Quality_Loops/CX_-_0041_Semantic_Model_Manufactured_Parts_Quality_Information_v_1.0.1.pdf) - -- [CX - 0071 - Triangle Quality Early Warning Field and Root Cause (to be updated when published)](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Archiv/Update_Juli_23_R_3.2/CX-0071-TriangleQualityEarlyWarningFieldandRootCause-v1.0.0.pdf) - - diff --git a/docs-kits_versioned_docs/version-23.09/kits/Quality-Kit/page_changelog.md b/docs-kits_versioned_docs/version-23.09/kits/Quality-Kit/page_changelog.md deleted file mode 100644 index d620b715b35..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Quality-Kit/page_changelog.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: Quality Kit Changelog -title: Changelog -description: 'Quality Kit' -sidebar_position: 1 ---- - -![Quality kit banner](@site/static/img/QualityKitIcon.png) - -### Quality KIT - -## [0.1.0] - 2023-08-18 - -### Added - -- Initial version of the Kit including adoption, operation and development view - -### Changed - -- ./. - -### Removed - -- ./. diff --git a/docs-kits_versioned_docs/version-23.09/kits/Quality-Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-23.09/kits/Quality-Kit/page_software-operation-view.md deleted file mode 100644 index 1e04e1f40a3..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Quality-Kit/page_software-operation-view.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: Operation View Quality Kit -title: Operation View -description: 'Quality Kit' -sidebar_position: 3 ---- - -![Quality kit banner](@site/static/img/QualityKitIcon.png) - -### Quality KIT - -Based on the information provided in the Quality KIT, it is possible to share quality related data between OEM and Tier n, use own and provide custom Quality Apps. The data sharing process, described in the [Development View](/docs-kits/next/kits/Quality-Kit/Software%20Development%20View/Specification%20Quality%20Kit) consists only standard Catena-X core components. Additional Quality KIT specific code or API are not provided and implementation therefor not necessary. - -An overview about the interaction of the different modules is provided in the following video: - - diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Notification API/get-quality-notification.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Notification API/get-quality-notification.api.mdx deleted file mode 100644 index fe4d5c4550c..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Notification API/get-quality-notification.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: get-quality-notification -title: "getQualityNotification" -description: "Resolves a quality notification" -sidebar_label: "getQualityNotification" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Quality notification"],"description":"Resolves a quality notification","operationId":"getQualityNotification","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["notificationId","senderBPN","senderAddress","recipientBPN"],"properties":{"notificationId":{"type":"string","format":"uuid","example":"a7954026-3aff-4b6c-92bf-04671ef2fa46","description":"A UUIDv4 to uniquely identify a quality notification."},"senderBPN":{"type":"string","example":"BPNL00000003BW3S","description":"The business partner number (BPN) of the sender. Actually, this value is not used to resolve the quality notification. Rather, it is used to do a plausibility check."},"senderAddress":{"type":"string","format":"uri","example":"https://edc.company-xyz.io/BPNL00000003BW3S","description":"The Eclipse Dataspace Connector (EDC) URL of the sender. Actually, this value is not used to resolve the quality notification. Rather, it is used to do a plausibility check."},"recipientBPN":{"type":"string","example":"BPNL00000003BV4H","description":"The business partner number (BPN) of the receiver. Actually, this value is not used to resolve the quality notification. Rather, it is used to do a plausibility check."},"messageId":{"type":"string","format":"uuid","example":"c2801472-5f87-41a7-9a25-b0939c4e0dff","description":"A UUIDv4 to uniquely identify an individual quality notification message. If this parameter is provided, the message for this messageId is resolved. If this parameter is not provided, then the last available message is resolved."}}}}}},"responses":{"200":{"description":"Quality notification was resolved successfully","content":{"application/json":{"schema":{"type":"object","required":["notificationId","senderBPN","senderAddress","recipientBPN","severity","status","messageId"],"properties":{"notificationId":{"type":"string","format":"uuid","example":"a7954026-3aff-4b6c-92bf-04671ef2fa46","description":"A UUIDv4 to uniquely identify a quality notification."},"senderBPN":{"type":"string","example":"BPNL00000003BW3S","description":"The business partner number (BPN) of the sender."},"senderAddress":{"type":"string","format":"uri","example":"https://edc.company-xyz.io/BPNL00000003BW3S","description":"The Eclipse Dataspace Connector (EDC) URL of the sender."},"recipientBPN":{"type":"string","example":"BPNL00000003BV4H","description":"The business partner number (BPN) of the receiver."},"severity":{"type":"string","enum":["MINOR","MAJOR","CRITICAL","LIFE-THREATENING"],"example":"CRITICAL","description":"The severity of the quality notification describes its criticality."},"status":{"type":"string","enum":["CREATED","SENT","RECEIVED","ACKNOWLEDGED","ACCEPTED","DECLINED","CLOSED"],"example":"SENT","description":"The status of the quality notification."},"targetDate":{"type":"string","format":"date-time","example":"2022-07-28T14:41:13.214Z","description":"The date and time when a processing of the notification is expected by the sender."},"messageId":{"type":"string","format":"uuid","example":"c2801472-5f87-41a7-9a25-b0939c4e0dff","description":"A UUIDv4 to uniquely identify an individual quality notification message."}}}}}},"400":{"description":"Request body was malformed"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Could not resolve the quality notification, because a quality notification with that notificationId does not exist"},"405":{"description":"Method not allowed"}},"method":"post","path":"/qualitynotifications/resolve","servers":[{"url":"/"}],"jsonRequestBodyExample":{"notificationId":"a7954026-3aff-4b6c-92bf-04671ef2fa46","senderBPN":"BPNL00000003BW3S","senderAddress":"https://edc.company-xyz.io/BPNL00000003BW3S","recipientBPN":"BPNL00000003BV4H","messageId":"c2801472-5f87-41a7-9a25-b0939c4e0dff"},"info":{"title":"Notification API","description":"Notification API","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"1.1.0"},"postman":{"name":"get Quality Notification","description":{"content":"Resolves a quality notification","type":"text/plain"},"url":{"path":["qualitynotifications","resolve"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Traceability Kit/Software Development View/Notification API/notification-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getQualityNotification - - - -Resolves a quality notification - -
Request Body
- -Quality notification was resolved successfully - -
Schema
- -Request body was malformed - -
- -Not authorized - -
- -Forbidden - -
- -Could not resolve the quality notification, because a quality notification with that notificationId does not exist - -
- -Method not allowed - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Notification API/notification-api.info.mdx b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Notification API/notification-api.info.mdx deleted file mode 100644 index e5c5a6a50f4..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Notification API/notification-api.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: notification-api -title: "Notification API" -description: "Notification API" -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: 1.1.0 - -# Notification API - - - -Notification API - - - \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Notification API/receive-quality-notification.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Notification API/receive-quality-notification.api.mdx deleted file mode 100644 index f52262f0055..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Notification API/receive-quality-notification.api.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: receive-quality-notification -title: "receiveQualityNotification" -description: "Receives a new quality notification" -sidebar_label: "receiveQualityNotification" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Quality notification"],"description":"Receives a new quality notification","operationId":"receiveQualityNotification","requestBody":{"content":{"application/json":{"schema":{"required":["header","content"],"type":"object","properties":{"header":{"type":"object","required":["notificationId","senderBPN","senderAddress","recipientBPN","classification","severity","status","messageId"],"properties":{"notificationId":{"type":"string","format":"uuid","example":"a7954026-3aff-4b6c-92bf-04671ef2fa46","description":"A UUIDv4 to uniquely identify a quality notification."},"senderBPN":{"type":"string","example":"BPNL00000003BW3S","description":"The business partner number (BPN) of the sender."},"senderAddress":{"type":"string","format":"uri","example":"https://edc.company-xyz.io/BPNL00000003BW3S","description":"The Eclipse Dataspace Connector (EDC) URL of the sender."},"recipientBPN":{"type":"string","example":"BPNL00000003BV4H","description":"The business partner number (BPN) of the receiver."},"classification":{"type":"string","enum":["QM-Investigation","QM-Alert"],"example":"QM-Investigation","description":"The classification defines the type of quality notification."},"severity":{"type":"string","enum":["MINOR","MAJOR","CRITICAL","LIFE-THREATENING"],"example":"CRITICAL","description":"The severity of the quality notification describes its criticality."},"relatedNotificationId":{"type":"string","format":"uuid","example":"7895a39d-c4ef-4b75-b39f-cae8207a262f","description":"A UUIDv4 to uniquely identify a related quality notification."},"status":{"type":"string","enum":["CREATED","SENT","RECEIVED","ACKNOWLEDGED","ACCEPTED","DECLINED","CLOSED"],"example":"SENT","description":"The status of the quality notification."},"targetDate":{"type":"string","format":"date-time","example":"2022-07-28T14:41:13.214Z","description":"The date and time when a processing of the notification is expected by the sender."},"messageId":{"type":"string","format":"uuid","example":"c2801472-5f87-41a7-9a25-b0939c4e0dff","description":"A UUIDv4 to uniquely identify an individual quality notification message. In case of an initial sending of a notification the messageId has to be a newly generated UUIDv4."}}},"content":{"type":"object","required":["listOfAffectedItems"],"properties":{"information":{"type":"string","maxLength":1000,"example":"Gear boxes loose oil while driving."},"listOfAffectedItems":{"type":"array","items":{"type":"string"},"example":["urn:uuid:57e4e3c1-a6f0-46a0-90df-1fb17cbc157d","urn:uuid:e4da568b-8cf1-4f5f-a96a-cf26265b2c72"]}}}}}}}},"responses":{"201":{"description":"Quality notification was received successfully"},"400":{"description":"Request body was malformed"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"405":{"description":"Method not allowed"},"409":{"description":"Could not accept the send quality notification, because a quality notification with that notificationId already exists"},"422":{"description":"Could not accept the send quality notification even though it is syntactically correct. The quality notification is not accepted, because of semantic reasons (e.g., an affected item is not known by the receiver)."}},"method":"post","path":"/qualitynotifications/receive","servers":[{"url":"/"}],"jsonRequestBodyExample":{"header":{"notificationId":"a7954026-3aff-4b6c-92bf-04671ef2fa46","senderBPN":"BPNL00000003BW3S","senderAddress":"https://edc.company-xyz.io/BPNL00000003BW3S","recipientBPN":"BPNL00000003BV4H","classification":"QM-Investigation","severity":"CRITICAL","relatedNotificationId":"7895a39d-c4ef-4b75-b39f-cae8207a262f","status":"SENT","targetDate":"2022-07-28T14:41:13.214Z","messageId":"c2801472-5f87-41a7-9a25-b0939c4e0dff"},"content":{"information":"Gear boxes loose oil while driving.","listOfAffectedItems":["urn:uuid:57e4e3c1-a6f0-46a0-90df-1fb17cbc157d","urn:uuid:e4da568b-8cf1-4f5f-a96a-cf26265b2c72"]}},"info":{"title":"Notification API","description":"Notification API","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"1.1.0"},"postman":{"name":"receive Quality Notification","description":{"content":"Receives a new quality notification","type":"text/plain"},"url":{"path":["qualitynotifications","receive"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Traceability Kit/Software Development View/Notification API/notification-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## receiveQualityNotification - - - -Receives a new quality notification - -
Request Body
    header object required
    content object required
- -Quality notification was received successfully - -
- -Request body was malformed - -
- -Not authorized - -
- -Forbidden - -
- -Method not allowed - -
- -Could not accept the send quality notification, because a quality notification with that notificationId already exists - -
- -Could not accept the send quality notification even though it is syntactically correct. The quality notification is not accepted, because of semantic reasons (e.g., an affected item is not known by the receiver). - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Notification API/sidebar.js b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Notification API/sidebar.js deleted file mode 100644 index 27414ca3715..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Notification API/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Traceability Kit/Software Development View/Notification API/notification-api"},{"type":"category","label":"Quality notification","link":{"type":"generated-index","title":"Quality notification","slug":"/category/kits/Traceability Kit/Software Development View/Notification API/quality-notification"},"items":[{"type":"doc","id":"kits/Traceability Kit/Software Development View/Notification API/receive-quality-notification","label":"receiveQualityNotification","className":"api-method post"},{"type":"doc","id":"kits/Traceability Kit/Software Development View/Notification API/update-quality-notification","label":"updateQualityNotification","className":"api-method post"},{"type":"doc","id":"kits/Traceability Kit/Software Development View/Notification API/get-quality-notification","label":"getQualityNotification","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Notification API/update-quality-notification.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Notification API/update-quality-notification.api.mdx deleted file mode 100644 index 6c1a5d53fe7..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Notification API/update-quality-notification.api.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: update-quality-notification -title: "updateQualityNotification" -description: "Updates a quality notification" -sidebar_label: "updateQualityNotification" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Quality notification"],"description":"Updates a quality notification","operationId":"updateQualityNotification","requestBody":{"content":{"application/json":{"schema":{"required":["header"],"type":"object","properties":{"header":{"type":"object","required":["notificationId","senderBPN","senderAddress","recipientBPN","status","messageId"],"properties":{"notificationId":{"type":"string","format":"uuid","example":"a7954026-3aff-4b6c-92bf-04671ef2fa46","description":"A UUIDv4 to uniquely identify a quality notification. Actually, this value cannot be updated. Rather, it is used to do a plausibility check."},"senderBPN":{"type":"string","example":"BPNL00000003BW3S","description":"The business partner number (BPN) of the sender. Actually, this value cannot be updated. Rather, it is used to do a plausibility check."},"senderAddress":{"type":"string","format":"uri","example":"https://edc.company-xyz.io/BPNL00000003BW3S","description":"The Eclipse Dataspace Connector (EDC) URL of the sender. Actually, this value cannot be updated. Rather, it is used to do a plausibility check."},"recipientBPN":{"type":"string","example":"BPNL00000003BV4H","description":"The business partner number (BPN) of the receiver. Actually, this value cannot be updated. Rather, it is used to do a plausibility check."},"severity":{"type":"string","enum":["MINOR","MAJOR","CRITICAL","LIFE-THREATENING"],"example":"CRITICAL","description":"The severity of the quality notification describes its criticality."},"status":{"type":"string","enum":["CREATED","SENT","RECEIVED","ACKNOWLEDGED","ACCEPTED","DECLINED","CLOSED"],"example":"SENT","description":"The status of the quality notification."},"targetDate":{"type":"string","format":"date-time","example":"2022-07-28T14:41:13.214Z","description":"The date and time when a processing of the notification is expected by the sender."},"messageId":{"type":"string","format":"uuid","example":"c2801472-5f87-41a7-9a25-b0939c4e0dff","description":"A UUIDv4 to uniquely identify an individual quality notification message. In case of an update of a notification the messageId must be a newly generated UUIDv4. It must not be an existing messageId."}}},"content":{"type":"object","properties":{"information":{"type":"string","maxLength":1000,"example":"Gear boxes loose oil while driving."}}}}}}}},"responses":{"200":{"description":"Quality notification was updated successfully"},"400":{"description":"Request body was malformed"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Could not update the quality notification, because a quality notification with that notificationId does not exist"},"405":{"description":"Method not allowed"},"422":{"description":"Could not update the quality notification even though the request is syntactically correct. The quality notification update is not accepted, because of semantic reasons (e.g., status cannot be changed)."}},"method":"post","path":"/qualitynotifications/update","servers":[{"url":"/"}],"jsonRequestBodyExample":{"header":{"notificationId":"a7954026-3aff-4b6c-92bf-04671ef2fa46","senderBPN":"BPNL00000003BW3S","senderAddress":"https://edc.company-xyz.io/BPNL00000003BW3S","recipientBPN":"BPNL00000003BV4H","severity":"CRITICAL","status":"SENT","targetDate":"2022-07-28T14:41:13.214Z","messageId":"c2801472-5f87-41a7-9a25-b0939c4e0dff"},"content":{"information":"Gear boxes loose oil while driving."}},"info":{"title":"Notification API","description":"Notification API","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"1.1.0"},"postman":{"name":"update Quality Notification","description":{"content":"Updates a quality notification","type":"text/plain"},"url":{"path":["qualitynotifications","update"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Traceability Kit/Software Development View/Notification API/notification-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## updateQualityNotification - - - -Updates a quality notification - -
Request Body
    header object required
    content object
- -Quality notification was updated successfully - -
- -Request body was malformed - -
- -Not authorized - -
- -Forbidden - -
- -Could not update the quality notification, because a quality notification with that notificationId does not exist - -
- -Method not allowed - -
- -Could not update the quality notification even though the request is syntactically correct. The quality notification update is not accepted, because of semantic reasons (e.g., status cannot be changed). - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Unique ID Push API/receive-unique-id-push-notification.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Unique ID Push API/receive-unique-id-push-notification.api.mdx deleted file mode 100644 index 3e94a998ff4..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Unique ID Push API/receive-unique-id-push-notification.api.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: receive-unique-id-push-notification -title: "receiveUniqueIdPushNotification" -description: "Receives a Traceability Unique Id push notification" -sidebar_label: "receiveUniqueIdPushNotification" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Unique ID Push Notification"],"description":"Receives a Traceability Unique Id push notification","operationId":"receiveUniqueIdPushNotification","requestBody":{"content":{"application/json":{"schema":{"required":["header","content"],"type":"object","properties":{"header":{"type":"object","required":["notificationId","senderBPN","senderAddress","recipientBPN","classification"],"properties":{"notificationId":{"type":"string","format":"uuid","example":"a7954026-3aff-4b6c-92bf-04671ef2fa46","description":"A UUIDv4 to uniquely identify a Unique ID push notification."},"senderBPN":{"type":"string","example":"BPNL00000003BW3S","description":"The business partner number (BPN) of the sender."},"senderAddress":{"type":"string","format":"uri","example":"https://edc.company-xyz.io/BPNL00000003BW3S","description":"The Eclipse Dataspace Connector (EDC) URL of the sender."},"recipientBPN":{"type":"string","example":"BPNL00000003BV4H","description":"The business partner number (BPN) of the receiver."},"classification":{"type":"string","enum":["Child-Relationship"],"example":"Child-Relationship","description":"The classification defines the type of the Unique ID push notification."}}},"content":{"type":"object","required":["listOfItems"],"properties":{"information":{"type":"string","maxLength":1000,"example":"Update of serialized parts and batches for which digital twins were created."},"listOfItems":{"type":"array","items":{"oneOf":[{"type":"object","required":["manufacturerId","manufacturerPartId","partInstanceId","catenaxId"],"properties":{"manufacturerId":{"type":"string","example":"BPNL00000003BW3S","description":"The Business Partner Number (BPNL) of the manufacturer of the serialized part, i.e., the companies main entry."},"manufacturerPartId":{"type":"string","example":"8840838-04","description":"The ID of the type/catalog part (of which the serialized part is an instance of) from the manufacturer."},"customerPartId":{"type":"string","example":"AAX178378","description":"The ID of the type/catalog part (of which the serialized part is an instance of) from the customer."},"partInstanceId":{"type":"string","example":"NO-009284492099792129568369","description":"The serial number of the serialized part from the manufacturer. We assume here that the customer does not have or create its own serial number for a part, but just used the manufacturer's serial number."},"catenaxId":{"type":"string","example":"urn:uuid:d32d3b55-d222-41e9-8d19-554af53124dd","description":"Catena-X ID for a serialized part."}}},{"type":"object","required":["manufacturerId","manufacturerPartId","batchId","catenaxId"],"properties":{"manufacturerId":{"type":"string","example":"BPNL00000003BW3S","description":"The Business Partner Number (BPNL) of the manufacturer of the batch, i.e., the companies main entry."},"manufacturerPartId":{"type":"string","example":"8840838-04","description":"The ID of the type/catalog part (of which the batch is an instance of) from the manufacturer."},"customerPartId":{"type":"string","example":"AAX178378","description":"The ID of the type/catalog part (of which the batch is an instance of) from the customer."},"batchId":{"type":"string","example":"NO-009284492099792129568369","description":"The serial number of the batch from the manufacturer. We assume here that the customer does not have or create its own serial number for a batch, but just used the manufacturer's serial number."},"catenaxId":{"type":"string","example":"urn:uuid:d32d3b55-d222-41e9-8d19-554af53124dd","description":"Catena-X ID for a batch."}}}]}}}}}}}}},"responses":{"201":{"description":"Notification was received successfully"},"400":{"description":"Request body was malformed"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"405":{"description":"Method not allowed"},"409":{"description":"Could not accept the send notification, because a notification with that notificationId already exists"},"422":{"description":"Could not accept the send notification even though it is syntactically correct. The notification is not accepted, because of semantic reasons (e.g., an item is not known by the receiver)."}},"method":"post","path":"/uniqueidpush/receive","servers":[{"url":"/"}],"jsonRequestBodyExample":{"header":{"notificationId":"a7954026-3aff-4b6c-92bf-04671ef2fa46","senderBPN":"BPNL00000003BW3S","senderAddress":"https://edc.company-xyz.io/BPNL00000003BW3S","recipientBPN":"BPNL00000003BV4H","classification":"Child-Relationship"},"content":{"information":"Update of serialized parts and batches for which digital twins were created.","listOfItems":[{"manufacturerId":"BPNL00000003BW3S","manufacturerPartId":"8840838-04","customerPartId":"AAX178378","partInstanceId":"NO-009284492099792129568369","catenaxId":"urn:uuid:d32d3b55-d222-41e9-8d19-554af53124dd"},{"manufacturerId":"BPNL00000003BW3S","manufacturerPartId":"8840838-04","customerPartId":"AAX178378","batchId":"NO-009284492099792129568369","catenaxId":"urn:uuid:d32d3b55-d222-41e9-8d19-554af53124dd"}]}},"info":{"title":"Unique ID Push Notification API","description":"API documentation for Traceability Unique ID Push Notifications","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"1.0.0"},"postman":{"name":"receive Unique Id Push Notification","description":{"content":"Receives a Traceability Unique Id push notification","type":"text/plain"},"url":{"path":["uniqueidpush","receive"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Traceability Kit/Software Development View/Unique ID Push API/unique-id-push-notification-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## receiveUniqueIdPushNotification - - - -Receives a Traceability Unique Id push notification - -
Request Body
    header object required
    content object required
    listOfItems object[] required
    oneOf
- -Notification was received successfully - -
- -Request body was malformed - -
- -Not authorized - -
- -Forbidden - -
- -Method not allowed - -
- -Could not accept the send notification, because a notification with that notificationId already exists - -
- -Could not accept the send notification even though it is syntactically correct. The notification is not accepted, because of semantic reasons (e.g., an item is not known by the receiver). - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Unique ID Push API/sidebar.js b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Unique ID Push API/sidebar.js deleted file mode 100644 index e91341315cc..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Unique ID Push API/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Traceability Kit/Software Development View/Unique ID Push API/unique-id-push-notification-api"},{"type":"category","label":"Unique ID Push Notification","link":{"type":"generated-index","title":"Unique ID Push Notification","slug":"/category/kits/Traceability Kit/Software Development View/Unique ID Push API/unique-id-push-notification"},"items":[{"type":"doc","id":"kits/Traceability Kit/Software Development View/Unique ID Push API/receive-unique-id-push-notification","label":"receiveUniqueIdPushNotification","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Unique ID Push API/unique-id-push-notification-api.info.mdx b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Unique ID Push API/unique-id-push-notification-api.info.mdx deleted file mode 100644 index 2bca1c1059e..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/Unique ID Push API/unique-id-push-notification-api.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: unique-id-push-notification-api -title: "Unique ID Push Notification API" -description: "API documentation for Traceability Unique ID Push Notifications" -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: 1.0.0 - -# Unique ID Push Notification API - - - -API documentation for Traceability Unique ID Push Notifications - - - \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/_category_.json b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/_category_.json deleted file mode 100644 index e5c5b7565a3..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Development View" -} diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/page_software-development-view.md deleted file mode 100644 index 8f866282926..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/Software Development View/page_software-development-view.md +++ /dev/null @@ -1,899 +0,0 @@ ---- -id: Specification Traceability Kit -title: Specification -description: "Traceability Kit" -sidebar_position: 4 ---- - -![Traceability kit banner](@site/static/img/doc-traceability_header-minified.png) - -### Traceability KIT - - - - - -## API Specifications - -### Unique ID Push Notifications - -Unique ID Push notifications are a way for a manufacturer to notify a customer as soon as possible when a new digital twin for a part is available. The solution is based on notification assets in the EDC (which is the same approach that is used for quality alerts & investigations). The customer creates a notification asset in the EDC and the customer's suppliers send their notifications (with the Unique Id) to this notification asset. Details can be found in section [Unique ID Push Notifications](#unique-id-push-notifications-1). - -All endpoints as well as the schema of the notification below are described in detail in the [Unique ID Push API documentation](Unique%20ID%20Push%20API/unique-id-push-notification-api). - -### Traceability Data Offers at EDC - -[Publish Traceability Data Offers at EDC](#publish-traceability-data-offers-at-edc) - - - -## Sample Data - -In the following, example data for submodels are provided. - -### As Planned Submodels Sample Data - -#### Submodel "PartAsPlanned" for a Catalog Part - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.part_as_planned/1.0.1](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.part_as_planned/1.0.1) - -```json -{ - "partTypeInformation": { - "classification": "component", - "manufacturerPartId": "123-0.740-3434-A", - "nameAtManufacturer": "Mirror left" - }, - "validityPeriod": { - "validFrom": "2021-06-14T06:55:29.935Z", - "validTo": "2022-06-14T06:55:29.935Z" - }, - "catenaXId": "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379" -} -``` - -#### Submodel "SingleLevelBomAsPlanned" for a Catalog Part - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_planned/1.1.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_planned/1.1.0) - -```json -{ - "catenaXId": "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d", - "childParts": [ - { - "quantity": { - "quantityNumber": 2.5, - "measurementUnit": "unit:litre" - }, - "createdOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:5daB938E-Cafa-92B3-7ca1-9aD7885e9dC8" - } - ] -} -``` - -#### Submodel SingleLevelUsageAsPlanned for a Catalog Part - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_usage_as_planned/1.1.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_usage_as_planned/1.1.0) - -```json -{ - "parentParts": [ - { - "parentCatenaXId": "urn:uuid:c8B01D5A-ce0B-6Dd4-5bA0-A3e3fcE9cA93", - "quantity": { - "quantityNumber": 2.5, - "measurementUnit": "unit:litre" - }, - "createdOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z" - } - ], - "catenaXId": "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d" -} -``` - -#### Submodel "PartSiteInformationAsPlanned" for a component that is produced at the given site - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.part_site_information_as_planned/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.part_site_information_as_planned/1.0.0) - -```json -{ - "catenaXId": "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379", - "sites": [ - { - "catenaXSiteId": "BPNS1234567890ZZ", - "functionValidUntil": "2025-11-21T11:14:30.825+01:00", - "function": "production", - "functionValidFrom": "2022-11-21T11:14:30.825+01:00" - } - ] -} -``` - -### As Built Submodels Sample Data - -#### Submodel SerialPart - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.serial_part/1.0.1](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.serial_part/1.0.1) - -##### Submodel "SerialPart" for a Vehicle - -```json -{ - "localIdentifiers": [ - { - "key": "manufacturerId", - "value": "BPNL7588787849VQ" - }, - { - "key": "manufacturerPartId", - "value": "95657362-83" - }, - { - "key": "partInstanceId", - "value": "OEM-A-F8LM95T92WJ9KNDD3HA5P" - }, - { - "key": "van", - "value": "OEM-A-F8LM95T92WJ9KNDD3HA5P" - } - ], - "manufacturingInformation": { - "date": "2022-02-04T14:48:54", - "country": "DEU" - }, - "catenaXId": "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379", - "partTypeInformation": { - "manufacturerPartID": "QX-39", - "classification": "product", - "nameAtManufacturer": "Vehicle Model A" - } -} -``` - -##### Submodel "SerialPart" for a Serialized Part (Non-Vehicle) - -```json -{ - "localIdentifiers": [ - { - "key": "manufacturerId", - "value": "BPNL7588787849VQ" - }, - { - "key": "manufacturerPartId", - "value": "95657362-83" - }, - { - "key": "partInstanceId", - "value": "NO-574868639429552535768526" - } - ], - "manufacturingInformation": { - "date": "2022-02-04T14:48:54", - "country": "DEU" - }, - "catenaXId": "urn:uuid:d60b99b0-f269-42f5-94d0-64fe0946ed04", - "partTypeInformation": { - "manufacturerPartID": "95657362-83", - "customerPartId": "798-515297795-A", - "classification": "component", - "nameAtManufacturer": "High Voltage Battery", - "nameAtCustomer": "High Voltage Battery" - } -} -``` - -#### Submodel SingleLevelBomAsBuilt - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_built/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_built/1.0.0) - -##### Submodel "SingleLevelBomAsBuilt" for a Serialized Part - -```json -{ - "catenaXId": "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379", - "childItems": [ - { - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": "unit:piece" - }, - "createdOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "catenaXId": "urn:uuid:d60b99b0-f269-42f5-94d0-64fe0946ed04", - "businessPartner": "BPNL50096894aNXY" - } - ] -} -``` - -##### Submodel "SingleLevelBomAsBuilt" for a Batch - -```json -{ - "catenaXId": "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379", - "childItems": [ - { - "quantity": { - "quantityNumber": 25.0, - "measurementUnit": "unit:kilogram" - }, - "createdOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "catenaXId": "urn:uuid:d60b99b0-f269-42f5-94d0-64fe0946ed04", - "businessPartner": "BPNL50096894aNXY" - } - ] -} -``` - -#### Submodel Batch - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.batch/2.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.batch/2.0.0) - -##### Submodel "Batch" for a Batch of Raw Material - -```json -{ - "localIdentifiers": [ - { - "value": "BID12345678", - "key": "batchId" - } - ], - "manufacturingInformation": { - "date": "2022-02-04T14:48:54", - "country": "HUR" - }, - "catenaXId": "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379", - "partTypeInformation": { - "manufacturerPartId": "123-0.740-3434-A", - "classification": "product", - "nameAtManufacturer": "PA66-GF30", - } -} -``` - -#### Submodel JustInSequencePart - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.just_in_sequence_part/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.just_in_sequence_part/1.0.0) - -##### Submodel "JustInSequencePart" for a non-serialized component - -```json -{ - "localIdentifiers": [ - { - "key": "manufacturerId", - "value": "BPNL7588787849VQ" - }, - { - "key": "jisNumber", - "value": "894651684" - }, - { - "key": "parentOrderNumber", - "value": "OEM-A-F8LM95T92WJ9KNDD3HA5P" - }, - { - "key": "jisCallDate", - "value": "2022-01-24T09:13:34" - } - ], - "manufacturingInformation": { - "date": "2022-02-04T14:48:54", - "country": "DEU" - }, - "catenaXId": "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379", - "partTypeInformation": { - "manufacturerPartID": "84816168424", - "classification": "product", - "nameAtManufacturer": "Black Leather Front Row Seat for Vehicle Model B" - } -} -``` - -> Please note that if a just-in-sequence part is also a serialized part SerialPart should be used instead. - -#### Submodel TractionBatteryCode - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.traction_battery_code/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.traction_battery_code/1.0.0) - -##### Submodel "TractionBatteryCode" for a Battery Cell - -```json -{ - "productType": "cell", - "tractionBatteryCode": "X12CCPM27KLPCLE662382320" -} -``` - -##### Submodel "TractionBatteryCode" for a Battery Module - -```json -{ - "productType": "module", - "tractionBatteryCode": "B54MCPM27KLPCLE6A7519857", - "subcomponents": [ - { - "productType": "cell", - "tractionBatteryCode": "X12CCPM27KLPCLE662382320" - }, - { - "productType": "cell", - "tractionBatteryCode": "X12CCPM27KLPCLE662382321" - } - ] -} -``` - -##### Submodel "TractionBatteryCode" for a Battery Pack - -```json -{ - "productType": "pack", - "tractionBatteryCode": "4A6PCPM27KLPCLE742946319", - "subcomponents": [ - { - "productType": "module", - "tractionBatteryCode": "B54MCPM27KLPCLE6A7519857", - "subcomponents": [ - { - "productType": "cell", - "tractionBatteryCode": "X12CCPM27KLPCLE662382320" - }, - { - "productType": "cell", - "tractionBatteryCode": "X12CCPM27KLPCLE662382321" - } - ] - }, - { - "productType": "module", - "tractionBatteryCode": "B54MCPM27KLPCLE6A7519858", - "subcomponents": [ - { - "productType": "cell", - "tractionBatteryCode": "X12CCPM27KLPCLE662382322" - }, - { - "productType": "cell", - "tractionBatteryCode": "X12CCPM27KLPCLE662382323" - } - ] - } - ] -} -``` - - -## Reference Implementation - -For a reference implementation, take a look at the open-source Trace-X app. More information are provided in the [Operation View](../page_software-operation-view.md) section. - - -## Documentation in the Context of Development - -### Data Provisioning - -The following diagram shows a basic data processing flow how a comany's internal data can be transformed into a Traceability-compliant format. It depicts the necessary steps as well as where communication with other services, e.g., Catena-X network services like the Digital Twin Registry, are necessary. Any implementation of this implementation specification can deviate from this basic flow as it's just one way to do it. But it should give a basic idea what the essential steps are. - -![Basic Data FLow](../assets/data_provisioning_data_flow.png) - -#### Register Digital Twins for Traceability - -In Traceability, digital twins for different types of parts are registered at a Digital Twin Registry, e. g. serialized parts, batches, JIS parts or catalog parts. Basic information about how to register digital twins in Catana-X are described in the standard [CX-0002 Digital Twins in Catena-X](https://catena-x.net/de/standard-library). - -> :raised_hand: **Unique ID Push** -> Once a digital twin was created, optionally a Unique ID Push notification can be send to the customer of the part of batch to inform them that a new digital twin is available. - -The following general conventions apply for all these digital twins: - -- id: The AAS ID must be a UUIDv4 in URN format: `urn:uuid:`; -- globalAssetId: the Unique ID of the real-world part for which a digital twin is created. - -> :warning: The AAS ID is not the same id as the Catena-X Unique ID, although they have the same format (UUID) and therefore look the same. A Unique ID identifies real-world parts, whereas a AAS ID identifies a digital twin of such a part. So, don't use the same value for Unique ID and AAS ID. - -##### Property specificAssetIds - -For Traceability, we define some specific asset IDs as mandatory. Mandatory specific asset IDs are used to lookup or search for digital twins. This is a required step by a customer of a part to connect the digital twins of their parts with the digital twins of the suppliers' child parts. To a customer, only the information printed on a real-world part is available and can be used for the lookup. Mandatory specific asset IDs ensure that at least this information is available for the digital twin. - -The following conventions for specific asset IDs apply to all digital twins: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key Availability Description Type
manufacturerId Mandatory The Business Partner Number (BPNL) of the manufacturer of the part. BPNL
manufacturerPartId Mandatory The ID of the type/catalog part from the manufacturer. String
customerPartId Optional The ID of the type/catalog part from the customer.
The main reason why this propertiy is optional is that it cannot be guaranteed that every manufacturer knows the customerPartId for their parts. In case the manufacturer knows the customer and the corresponding CustomerPartID of its part though, it is required to add this information for easier lookup and to enable further processes.
- - 		String
assetLifecyclePhase Optional (for DT As-Built)
Mandatory (for DT As-Planned) 		The lifecycle phase of the asset.
  • For serialized parts, batches, and JIS parts, use the value "AsBuilt".
  • For catalog parts, use the value "AsPlanned".
 Enum
- -**For serialized parts, additionally the following conventions apply:** - -| Key | Availability | Description | Type | -| :------------- | :----------- | :------------------------------------------------------------------------------------------- | :----- | -| partInstanceId | Mandatory | The serial number of the part from the manufacturer. | String | -| van | Optional | **Only for vehicles:** The pseudonymized vehicle identification number (VIN) of the vehicle. | String | - -**For batches, additionally the following conventions apply:** - -| Key | Availability | Description | Type | -| :------------- | :----------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----- | -| batchId | Optional | The number of the batch from the manufacturer. | String | -| partInstanceId | Mandatory | Also the number of the batch from the manufacturer.

Currently, we also use the batch number as partInstanceId. This makes looking up digital twins for serialized parts and batches easier as a data consumer only has to specify the partInstanceId no matter if they are looking up a serialized part or a batch. Otherwise, the data consumer would need to know for what type of digital twin it is looking for or it would have to look for both until a match is found. | String | - -**For just-in-sequence (JIS) parts, additionally the following conventions apply:** - -| Key | Availability | Description | Type | -| :---------------- | :----------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----- | -| parentOrderNumber | Optional | A number identifying the just-in-sequence- part's destination parent part. The parent part is typically known upfront to the supplier for just-in-sequence parts. | String | -| jisNumber | Mandatory | A number that is used to identify the call-off that can be assumed unique within the specific just-in-sequence process. This is typically not the sequence number, but the call-off number. | String | -| jisCallDate | Optional | The date of the just-in-sequence call-off as stated on the call-off document itself.
The value must be compliant to ISO 8601: `YYYY-MM-DD` or `YYYY-MM-DDThh:mm:ss` or `YYYY-MM-DDThh:mm:ss±hh:mm` | Date | -| partInstanceId | Mandatory | A composition of `jisNumber`, `parentOrderNumber` (if available), `jisCallDate` (ifavailable). This information is typically known upfront to the supplier `jisNumber`, `partOrderNumber` and `jisCallDate` for just-in-sequence parts. | String | - -> :raised_hand: **Lookup of Digital Twins** -> The lookup for parts can use the customerPartId or the manufacturerPartId. Both, manufacturer and customer must agree upon what part id will be used for the lookup. Otherwise, when the customer would use the customerPartId for the lookup, but the manufacturer would only provide the manufacturerPartId in its digital twins, the lookup would fail every time. **This is decision that a customer must agree upon with each of their suppliers individually.** - -##### Authorization: Visbility of Specific Asset IDs in the DTR - -To enforce a strict need-to-know (and prevent data from being exposed to non-authorized parties), the visibility of entries in the attribute `specificAssetIds` must be protected, i.e.,their visibility must be restricted to authorized parties only. For that, the attribute `externalSubjectId` must be used. Detailed information about this can be found in the [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/category/digital-twin-kit). - -##### Submodel Descriptors - -General conventions for submodel descriptors can be found in the standard [CX-0002 Digital Twins in Catena-X](https://catena-x.net/de/standard-library). This section is based on it and it is recommended to read it first. In this KIT, we extend this standard with some additional conventions. - -Submodel descriptors MUST be compliant to the following additional conventions: - -- `id`: The submodel ID must be a UUIDv4 in URN format: "urn:uuid:<UUIDv4>"; -- `idShort`: the name of the aspect model in camel case, e.g. for aspect SerialPart: "serialPart". - -The actual access information for the EDC is part of the endpoint attribute in the submodel descriptor. - -```json -{ - "interface": "SUBMODEL-3.0", - "protocolInformation": { - "href": "https://edc.data.plane/{path}/submodel", - "endpointProtocol": "HTTP", - "endpointProtocolVersion": ["1.1"], - "subprotocol": "DSP", - "subprotocolBody": "id=123;dspEndpoint=http://edc.control.plane/", - "subprotocolBodyEncoding": "plain", - "securityAttributes": [ - { "type": "NONE", "key": "NONE", "value": "NONE" } - ] - } -} -``` - -The following conventions apply for the endpoint: - -- `interface`, `endpointProtocol`, `endpointProtocolVersion`, `subprotocol`, `subprotocolBodyEncoding`, and `securityAttributes` are set as defined in the [CX-0002 standard](https://catena-x.net/de/standard-library). -- `href`: The endpoint address for the logical operation GetSubmodel that is invoked by a data consumer to get the submodel. It must have the following format: - - `edc.data.plane`: Server and port of the EDC data plane that is providing the submodel. - - `{path}`: This `{path}` string is forwarded to the backend data service by the EDC data plane. Together with the EDC asset information (see below) it must contain all information for the backend data service to return the requested submodel. The actual path depends on the type of backend data service that the data provider uses to handle the request. More details follow below. - - `/submodel`: This `/submodel` string is also forwarded to the backend data service. As AAS Profile SSP-003 of the Submodel Service Specification is mandatory for release 3.2, `href` must have the suffix "/submodel" representing the invokation of the GetSubmodel operation. -- `subprotocolBody`: a semicolon-separated list of parameters used to negotiate the required contract agreement. - - `id=123`: The ID of the EDC asset for which a contract negitiation should be intiated. This ID is also called dataset ID as it is stored as `https://www.w3.org/ns/dcat/dataset.@id` in a catalog entry. This ID must be set by the data provider when creating the asset. Do not confuse this EDC asset ID (dataset ID) with other IDs that might be defined additionally for an EDC asset, e.g., `https://w3id.org/edc/v0.0.1/ns/id` (often refered to as `edc:id`). - - `dspEndpoint`: Server and port of the EDC control plane used for contract negotiation. - -> :raised_hand: **Backend Data Service for Submodels** -According to [CX-0002](https://catena-x.net/de/standard-library), the backend data service identified via `href`and the filter criteria in `subprotocolBody` MUST be conformant to the Asset Administration Shell Profile SSP-003 of the Submodel Service Specification and must at least support the logical operation GetSubmodel. In release 3.2, only the logical parameter Content=Value must be supported via path suffix "/submodel/$value". This might change in later releases. - -With this approach, the EDC asset structure must no longer follow the "one EDC asset per submodel" rule (as in Release 3.1 and before), but gives data providers more flexibility how to create EDC assets for their digital twins and submodels based on how they use `{path}`. - -###### Option 1: Same EDC Asset Structure as in Release 3.1 - -Submodels of digital twins are registered in the EDC the same way as for release 3.1: One EDC asset is created for every submodel of a digital twin. - -- `href` must have the following format: `http://edc.data.plane/submodel` -- `subprotocolBody` must have the following format: `id={edcAssetId};dspEndpoint=http://edc.control.plane` -- edcAssetId is the id of the EDC asset for the submodel. It must have the following format "{aasIdentifier}-{submodelIdentifier}" with - - aasIdentifier: the id of the digital twin (id property in the AAS descriptor) - - submodelIdentifier: the id of the submodel (id property in the submodel descriptor) - -Here's an example how such a submodel descriptor could look like: - -```json -"submodelDescriptors": [ - { - "idShort": "serialPart", - "id": "urn:uuid:7effd7f4-6353-4401-9547-c54b420a22a0", - "semanticId": { - "type": "ExternalReference", - "keys": [ - { - "type": "GlobalReference", - "value": "urn:samm:io.catenax.serial_part:1.0.1#SerialPart" - } - ] - }, - "endpoints": [ - { - "interface": "SUBMODEL-3.0", - "protocolInformation": { - "href": "https://edc.data.plane/submodel", - "endpointProtocol": "HTTP", - "endpointProtocolVersion": ["1.1"], - "subprotocol": "DSP", - "subprotocolBody": "id=urn:uuid:75e98d67-e09e-4388-b2f6-ea0a0a642bfe-urn:uuid:7effd7f4-6353-4401-9547-c54b420a22a0;dspEndpoint=http://edc.control.plane/", - "subprotocolBodyEncoding": "plain", - "securityAttributes": [ - { "type": "NONE", "key": "NONE", "value": "NONE" } - ] - } - } - ] - } -] -``` - -In this example, the `path` part in the `href` is empty, as the EDC asset referenced in `subprotocolBody` directly points to a service returning the correct submodel (set up correctly with its dataAddress in the data provider's EDC). - -###### Option 2: EDC Asset Structure on Catalog Part Level - - A data provider can link several submodel endpoints to the same EDC asset (referenced by its id). This allows to create only one EDC asset (per aspect model) for a catalog part and link all submodels (of the same aspect model) for serialized parts of the catalog part to the same EDC asset. The data provider would still need to create separate EDC assets per aspect model as in most cases different usage policies are used for aspect models. - -If a data provider no longer creates EDC assets on the level of submodels, the EDC can no longer authorize a request on a submodel-level. For example: If EDC assets are created per catalog part, the EDC can only authorize if the requestor is allowed to see parts of these type in general; if the requestor is allowed to see a actual serialized part, must be authorized by the backend data service executing the request. - -Here's an example how such a submodel descriptor could look like: - -```json -"submodelDescriptors": [ - { - "idShort": "serialPart", - "id": "urn:uuid:7effd7f4-6353-4401-9547-c54b420a22a0", - "semanticId": { - "type": "ExternalReference", - "keys": [ - { - "type": "GlobalReference", - "value": "urn:samm:io.catenax.serial_part:1.0.1#SerialPart" - } - ] - }, - "endpoints": [ - { - "interface": "SUBMODEL-3.0", - "protocolInformation": { - "href": "https://edc.data.plane/urn%3Auuid%3A75e98d67-e09e-4388-b2f6-ea0a0a642bfe-urn%3Auuid%3A7effd7f4-6353-4401-9547-c54b420a22a0/submodel", - "endpointProtocol": "HTTP", - "endpointProtocolVersion": ["1.1"], - "subprotocol": "DSP", - "subprotocolBody": "id=urn:uuid:1475f313-0a83-4e2b-b705-a100eebcb7d7;dspEndpoint=http://control-plane.edc.catena-x.net/", - "subprotocolBodyEncoding": "plain", - "securityAttributes": [ - { "type": "NONE", "key": "NONE", "value": "NONE" } - ] - } - } - ] - } -] -``` - -The path part of the `href` property contains the information for the backend data service which digital twin's submodel to return while the EDC asset ID is used for several endpoints. The path part here is just an example as it depends on the type of backend data service the data provider uses. - -The above options are only two examples how a submodel's endpoint can be created. As long as it's compliant with the above conventions (including [CX-0002](https://catena-x.net/de/standard-library)) a data provider can also use any other EDC asset structure. - -###### Data Consumption with AAS Submodel Descriptor Endpoints - -The endpoint `href` in the submodel descriptor cannot be used directly to contact an EDC and access the data in Catena-X. - -- A data consumer must first identify the protocol that must be used to retrieve the submodel data based on the `subprotocol`. For data transfers in Catena-X, this is "DSP" -- With `href`, the data consumer calls the local operation GetSubmodel as specified by the suffix "/submodel". As only the logical parameter "Content" must be supported in release 3.2, "/$value" must be appended to `href` by the data consumer. - If the `href` endpoint is called with operations or parameter values not yet supported, the error response 501 "Not Implemented" must be returned according to [CX-0002](https://catena-x.net/de/standard-library). -- Then, the data consumer must use the information in the `subprotocolBody` to perform a contract negotiation for the EDC asset referenced by `id` with the EDC control plane of the data provider specified by `dspEndpoint`. -- Finally, using the id from the contract agreement with the control plane, the data consumer initiates the data transfer with the EDC data plane of the data provider referenced in the `href`. The enriched path part of the `href` (see bullet point 2) is passed to data provider data plane by the data consumer as a parameter for the backend data service that actually executes the request and returns the submodel. - -All these steps must be handled by the data consumer that want to retrieve the submodel data of a digital twin. - -#### Lookup for Digital Twins in the Digital Twin Registry - -For a data provider, there are currently the following steps where they have to lookup digital twins of other partners in the Catena-X network. - -- The data provider must use the local IDs for a serialized part or batch (manufacturer, part number, serial or batch number) and for a just-in-sequence part (manufacturer, parentOrderNumber, jisNumber, jisCallDate) to lookup the AAS ID of the digital twin of this serialized part, batch or just-in-sequence part. The AAS descriptor with this ID contains the Unique ID of the serialized part, batch or just-in-sequence (as globalAssetId) that is used to create SingleLevelBomAsBuilt submodel. - -- The data provider must use the local IDs for a catalog part (manufacturer, part number) to lookup the AAS ID of the digital twin of this catalog part. The AAS descriptor with this ID contains the Unique ID of the catalog part (as globalAssetId) that is used to create the SingleLevelBoMAsPlanned submodel. - -For a data consumer, there are currently the following steps where they have to lookup digital twins of other partners in the Catena-X network. - -- The data consumer in the Traceability use case in most cases will use the Unique ID of a part to lookup the digital twin (more precisely, its AAS ID) of this part. -- The data consumer from another use case (e.g., Circular Economy), might either use the Unique ID of a part (if known) or the local IDs of a part to lookup the part's digital twin (AAS ID) depending on what is available in the use case. - -##### Lookup up a Digital Twin with Local IDs - -The local IDs of a serialized part (manufacturer, part number, serial number) are stored as specific asset IDs in the AAS descriptor of the digital twin. From the Digital Twin Registry API, the following function can be used for this lookup `GET /lookup/shells`. - -All Asset identifier key-value-pairs used as parameter to this lookup function are combined using AND. An example query would look like this: `https://URL/registry/lookup/shells?assetIds=%5B%7B%22key%22%3A%20%22manufacturerId%22,%22value%22%3A%20%22BPNL7588787849VQ%22%7D,%7B%22key%22%3A%20%22manufacturerPartId%22,%22value%22%3A%20%2295657362-83%22%7D,%7B%22key%22%3A%20%22partInstanceId%22,%22value%22%3A%20%22NO-574868639429552535768526%22%7D%5D` - -**The assetIds value looks like this unencoded (but with additional spaces and linebreaks):** - -```json -[ - { - "key": "manufacturerId", - "value": "BPNL7588787849VQ" - }, - { - "key": "manufacturerPartId", - "value": "95657362-83" - }, - { - "key": "partInstanceId", - "value": "NO-574868639429552535768526" - } -] -``` - -The lookup (for serialized parts/batches as well as catalog parts) can use the customer or the manufacturer part id (manufacturerPartId or manufacturerPartId). - -- For a digital twin, adding the customer part id to the specific asset IDs is optional. The main reason for this is that it cannot be guaranteed that every manufacturer knows the customer part id for their parts. But, if they know it, it is recommended to always add the customer part id to the specifiAssetId property for easier lookup (by customers). -- A customer that wants to do a lookup for a supplier's digital twin, must first decide what id they want to use for the lookup. This depends on the information that is available to them. - - If the customer knows the manufacturer part id, they should use the manufacturer part id for the lookup as the manufacturer part id is guaranteed to be available in the digital twin (as the manufacturer part id is a mandatory property). - - If the customer does not know the manufacturer part id, they must use the customer part id (i.e., their own part id). In that case they must make sure that their suppliers register their digital twins with this information (as the customer part id is optional) as part of the specific asset IDs. This is decision that a customer must agree upon with each of their suppliers individually. - -As a result, the AAS ID of the digital twin with this local IDs is returned. The AAS ID can then be used to retrieve details about the digital twin, i.e. the digital twin's AAS descriptor including submodel descriptors. - -**Example result for looking up a digital twin with local IDs:** - -```json -["urn:uuid:c227a880-b82b-40f7-846c-3942ddf26c29"] -``` - -Note that this query can return more than one AAS ID depending on the local IDs uniquely identifying a digital twin or not. - -Currently, even if more than one digital twin is returned in a lookup, these digital twins should have different submodels assigned to them. These submodels should be disjunct and not overlap. This means that you can use the submodel to filter out the correct digital twin. - -- If there are returned more than one digital twin with the same submodel (based on their semanticId), this is considered an error. Processing should be canceled and an error message should be reported. - -The next section describes to modify the lookup to additionally restrict the results to digital twins with a specific submodel type based on it's semanticId. - -#### Unique ID Push Notifications - -Unique ID Push notifications are a way for a manufacturer to notify a customer as soon as possible when a new digital twin for a part is available. - -The solution is based on notification assets in the EDC (which is the same approach that is used for quality alerts & investigations). The customer creates a notification asset in the EDC and the customer's suppliers send their notifications (with the Unique Id) to this notification asset. As this notification asset is a general EDC asset - as for all EDC assets - access policies, usage policies and contract definitions must be created. - -> :raised_hand: It is important to understand that the customer (receiver) creates EDC asset and policies, and thus, the supplier (sender) of the Unique ID push notification must check during the EDC negotiation process if the conditions the receiver offers are acceptable for the sender. - -##### Prerequisites and Constraints - -In order to be able to push Unique ID(s) of part(s) to the correct partner, it is required that the data provider (manufacturer) pushing the Unique IDs is aware of the BPN of the actual receiver of the part (i.e., the customer) or has enough data in its context to use BPDM functions to determine the BPN Number of the receiver. - -For actively pushing Unique IDs, an EDC is required and the data provider needs to be enabled to execute the complete process including EDC communication and HTTP Push (i.e., HTTP POST) of the payload. - -Secondly, EDCs are being used for the exchange and it is currently required to offer a HTTP POST API to receive the Unique IDs push at the receiver's side. This API needs to be registered in the EDC Catalog as a data offer and requires specific properties to be set to standardized values, as this allows discover-ability. Details still tbd. - -##### Unique ID Push Process Overview - -How the actual process is triggered is application specific. It is recommended to trigger the push of Unique IDs towards the customer after the Goods Issue has been booked, since commonly at that point the serial numbers/batch numbers of the parts being delivered are fixed in the logistics process and shall be contained in delivery documents, EDI Messages and/or any internal representation of the received items (non-Catena-X communication). - -The Unique ID push is initiated by the supplier (acting as sender) towards their customer (acting as receiver). Since the Unique ID of the asset (i.e., serial unit / batch) is unknown in the logistics process, the message needs to include local identifiers to be matched towards the information from the delivery documents and furthermore the internal data of the recipient's traceability solution. - -Upon receipt of the message, the customer needs to match the local identifiers with its internal traceability records and attach each Unique ID to the respective data set. How this is done is depending on the customer's internal systems: - -- If there is an object for incoming deliveries, this event could be updated. - Alternatively, if only production events are tracked, the data could be integrated at this point into the data provisioning pipeline's data structure for consumed materials. -- In the end this enables the customer to integrate the child parts into the SingleLevelBomAsBuilt aspect. - -![Unique ID Push Process](../assets/unique_id_push_process.png) - - - -##### Schema of Unique ID Push Notifications - -The notifications send to inform a customer about the creating of a new digital twin for one of the parts they received have a standardized format. - -All endpoints as well as the schema of the notification below are described in detail in the [Unique ID Push API documentation](Unique%20ID%20Push%20API/unique-id-push-notification-api). - -> Adding the customer part id to the notification is optional. The main reason for this is that it cannot be guaranteed that every manufacturer knows the customer part id for their parts. But, in case the manufacturer knows the customer and the corresponding customer part id of its part though, it is required to always add the customer part id to the notification. - -##### Notification Receiver (Customer) - -Here is a short overview what the receiver has to do when they want to support Unique Id Push notifications. This is an optional feature. - -- The receiver in this scenario is the customer of a part. -- The receiver must create a EDC asset in their EDC that works as the endpoint for receiving notifications. Also, access & usage policies as described below must be configured. -- The EDC in which the notification EDC asset was created must be registered at the Discovery Service (so that the sender can find the partner's EDC which should receive notifications) -- When the Receiver receives a Unique Id Push notification, it must process this notification after it was received by the EDC (in a Backend Data Service) -- How the Receiver processes the notification is up to them, but the following steps are recommended: - - Verify the correctness of the data in the notification (i.e., the receiver is actually the customer of this part). - - Store the notification data for later. - - Use this data when the digital twin for the part into which the delivered part is built into is created instead of doing a lookup to a supplier's Digital Twin Registry. - -###### EDC Asset - -The EDC asset can be created using the EDC Data Management API. The following conventions apply for the properties of this asset: - -```apacheconf -"asset:prop:id": "uniqueidpushnnotification-receipt" -"asset:prop:type": "notification.trace.uniqueidpush" -"asset:prop:notificationtype": "uniqueidpush" -"asset:prop:notificationmethod": "receive" -``` - -###### EDC Policies - -_More information about the Policies with detailed descriptions, payloads etc. are described on the [Adoption View](../page_adoption-view.md) page._ - -**Access Policies** -A data provider can decide on its own what access policies they want to define for their notification asset. Based on the purpose of the asset, all suppliers of the data provider should in general be allowed to send notifications to this asset. Therefore, either a public access policy or a BPN-based access policy (allowing all suppliers) should be used. - -**Usage Policies** -In general, a data provider is free to decide which usage policies to define for its assets. For notifications, though, the data provider is actually the receiver of notifications, i.e., the usage policy here has the purpose to define what the data provider does or is allowed to do with the notifications. It's something the sender of the notification has to rely on and accept when sending its notification. - -Keep in mind that usage policies currently aren't technically enforced by the EDC or other components. - -> :raised_hand: **Usage Policy for Unique ID Push** -> The Unique ID push notification endpoints are protected with a purpose-based usage policy and "R3-1_UniqueIDPush" as purpose. - -###### Backend Data Service to Process Unique ID Push Notifications - -The receiver must setup a backend data service that provides an HTTP Endpoint for notifications. All endpoints as well as the schema of the notification below are described in detail in the [Unique ID Push API documentation](Unique%20ID%20Push%20API/unique-id-push-notification-api). - -##### Notification Sender (Manufacturer, Supplier) - -Here is a short overview what the sender has to do when they want to support Unique Id Push notifications. This is an optional feature. - -- The Sender in this scenario is the manufacturer or supplier of a part. -- When a new digital twin for a part was created, the manufacturer is responsible to send a Unique Id Push notification for this twin to the customer of this part. -- It is recommended to send this notification as soon as possible, i.e., directly after the digital twin was created. - -###### Mapping BPN to EDC URL with Discovery Service API - -The sender must first find the EDC of the customer to which the notification should be sent to. For this, the BPN of the customer is required. With this, the Discovery Service can be used to query for all EDCs of the customer. After that, the data catalog of each of these EDCs must be queried for the notification EDC asset as described above. If this notification EDC asset is found in one of these EDCs, the notification can be sent. - -There should only be one EDC which provides the notification EDC asset for Unique Id Push. If more than one EDC (for the same BPN/partner) are found, this is considered a misconfiguration of the corresponding partner. - -#### Creating Submodels for Digital Twins - -Submodels for Traceability are mostly easy to create by transforming a company's internal data into the target aspect model, i.e. SerialPart or Batch. Transformations are mostly straightforward in these cases. - -The only special step in creating these two submodels is the initial creation of the Unique ID for the corresponding serialized parts or batches. - -##### Creation of Submodel SingleLevelBomAsBuilt - -The creation of the submodel SingleLevelBomAsBuilt is more complicated. This submodel contains the Unique ID of the manufacturer's part (attribute catenaXId) which is created - as described above - when the part's SerialPart or Batch submodel is created. But it also contains the Unique IDs of the built-in parts (attributes childItems.catenaXId), as shown in the following example: - -```json -{ - "catenaXId": "urn:uuid:d261e0fa-36f5-4128-875e-0f5735f5a535", - "childItems": [ - { - "quantity": { - "quantityNumber": 1, - "measurementUnit": "unit:piece" - }, - "createdOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "catenaXId": "urn:uuid:9dc1b6fb-94e7-4911-9e39-abf06c4941d2", - "businessPartner": "SingleLevelBomAsBuilt" - }, - { - "quantity": { - "quantityNumber": 1, - "measurementUnit": "unit:piece" - }, - "createdOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "catenaXId": "urn:uuid:d17bbf68-6cb7-4045-b3ae-67f41403d098", - "businessPartner": "SingleLevelBomAsBuilt" - } - ] -} -``` - -For the build-in parts (child items), their Unique ID is not known to the manufacturer initially. Only know are the local ids that are printed on the physical part (serialized part or batch), i.e., manufacturer (BPN), manufacturer part id and serial or batch number. To get the Unique ID of a built-in part, a data provider therefore has to do the following: - -- Get all necessary local ids for the built-in part: - - manufacturer (BPN), manufacturer part id and serial number for serialized parts - - manufacturer (BPN), manufacturer part id and batch number for batches -- The next step is about getting the Unique ID of all built-in parts. There are two ways: - - Unique IDs might for built-in parts might already be available locally if Unique ID Push is supported by the data provider and the suppliers of the built-in parts. - - Query a supplier's Digital Twin Registry to find the digital twin for this built-in part - -###### Unique ID Push - -Once the digital twin was created, optionally a Unique ID Push notification can be send by the manufacturer of the part to the customer of the serialized part of batch to inform the customer that information about a serialized part or batch is available as a digital twin. This is an optional process and both, the manufacturer of a part as well as the customer of the part must support Unique ID Push notifications. - -For more information, see [Unique ID Push Notifications](#unique-id-push-notifications) - -###### Query a Digital Twin Registry to find the digital twin for this built-in part - -- Querying digital twins is described in [Lookup for Digital Twins in the Digital Twin Registry](#lookup-for-digital-twins-in-the-digital-twin-registry) - - Note that the query parameters differ depending on what type of digital twin is looked up. - - Currently though, no matter if you want to lookup serialized parts or batches, you can use partInstanceId (using the serial number or the batch number as search parameter value). - - For Batch digital twins, the key batchId might be provided optionally. As this key is not mandatory currently, you cannot rely on this key being available when looking for Batch digital twins. - - To understand why, take a look at how these digital twins are created, especially their specific asset IDs: [Creating Submodels for Digital Twins](#creating-submodels-for-digital-twins) - - The result of this query will be the AAS ID of the digital twin. -- Use this AAS ID to get the AAS Descriptor including all Submodel Descriptors of this digital twin. The AAS Descriptor contains the Submodel Descriptor SerialPart or Batch (depending on the digital twin type). -- Fetch the submodel SerialPart or Batch (depending on the digital twin type) from the EDC that is referenced in the corresponding Submodel Descriptor. -- The submodel then contains the Unique ID of the built-in part in its catenaXId attribute. - -These steps have to be repeated for all built-in parts by the manufacturer. After that, the manufacturer has all information to create the SingleLevelBomAsBuilt. - -#### Publish Traceability Data Offers at EDC - -With the changes of Release 3.2 regarding the submodel endpoints in the DTR, the actual EDC asset structure for submodels is no longer restricted by use case conventions and can be decided by the data provider. - -##### Data Provider Tasks - -Basically, as a data provider you have to do the following - -- Implement a Backend Data Service (BDS) for every asset that is provided via the EDC. It does not have to be a different BDS for each asset - you can use the same BDS for several assets (to be verified). -- The BDS must support the Asset Administration Shell Profile SSP-003 of the Submodel Service Specification (see [standard CX-0002](https://catena-x.net/de/standard-library) for more details). -- The BDS must use the REST API data plan for data transmission. -- The BDS must verify that it only returns data to the data consumer that is compliant to the EDC asset and data offer for which data is queried and authorize the request accordingly. diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/assets/architecture_level_1.png b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/assets/architecture_level_1.png deleted file mode 100644 index d1d02ec1a58..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/assets/architecture_level_1.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/assets/data_provisioning_data_flow.png b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/assets/data_provisioning_data_flow.png deleted file mode 100644 index 89cb01b93fb..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/assets/data_provisioning_data_flow.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/assets/traceability_customer-journey.png b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/assets/traceability_customer-journey.png deleted file mode 100644 index 1ab1dc00fbe..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/assets/traceability_customer-journey.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/assets/unique_id_push_process.png b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/assets/unique_id_push_process.png deleted file mode 100644 index 7d038364355..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/assets/unique_id_push_process.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/page_adoption-view.md deleted file mode 100644 index d165b83c11f..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/page_adoption-view.md +++ /dev/null @@ -1,413 +0,0 @@ ---- -id: Adoption View Traceability Kit -title: Adoption View -description: 'Traceability Kit' -sidebar_position: 2 ---- - -![Traceability kit banner](@site/static/img/doc-traceability_header-minified.png) - -### Traceability KIT - - - -## Vision & Mission - -### Vision - -The aim of the Traceability KIT is to trace parts and materials across the entire value chain to enable data driven use cases over all n-tier levels without compromising data sovereignty. This KIT enables data and app providers to deliver solutions for building data chains and to send quality notifications on all levels and industries. - -### Mission - -The Traceability KIT provides the necessary standards, aspect models, APIs, logics, and processes on how to build a data sovereign data chain and send quality notifications. This is done via the standardized creation of digital twins of components and vehicles as well as the logical linking to their sub-components (Bill of Material, BoM). The default visibility of digital twins and their respective semantic models follows the one-up/one-down principle. This enables businesses to track and trace products, components, material, and software along the value chain for all product lifecycle stages. - -All described specifications in the KIT are based on Catena-X standards like Data Space Connector, Asset Administration Shell (AAS), and Digital Twin Registry (DTR). They refer to other Catena-X KITs like the Connector KIT (EDC), Data Chain KIT (Item Relation Ship, IRS) and Business Partner KIT to ensure interoperability and data sovereignty according to IDSA and Gaia-X principles. - -Furthermore, APIs and data models enable partners to send quality notifications in a standardized way while already knowing which parts of their direct customer and suppliers are affected and which are not. Moreover, the KIT is compatible with the data chain KIT to allow apps and business to traverse through the data chains over n-tier levels to enable further use cases like Circular Economy. - -In the current version, the KIT supports the creation of data chains for the life cycle contexts “as built” and “as planned”. Further lifecycle contexts, e.g., as maintained will be supported in the future. Overall, the KIT represents the backbone to build data chains for use cases based on vehicles and parts. It empowers app providers to develop a Catena-X Traceability application and data provider to implement their digital twins and the connection to their subcomponents themselves. - -### Customer Journey - -With the Traceability KIT, we support the Catena-X customer journey for our adopters and solutions providers. - -![Customer Journey](assets/traceability_customer-journey.png) - - -## Business Value - -Through the standardized specifications described in the “Traceability-KIT” – for example the semantic models and APIs – application and service providers can reduce investment and implementation costs to integrate new Catena-X services. Furthermore, application and service providers can enter potential new markets within the PLM & Quality domain. Data Provider and Businesses are able to build data sovereign data chains to enable data driven use – also for other domains like sustainability. - - -## Use Case - -### Status Quo / Today’s challenge - -From Traceability's perspective, the main challenge within the automotive industry is to define and implement inter-organizational end-to-end data chains across the whole automotive supply chain to empower data driven use cases. Details regarding the challenges are: - -- Missing standards to trace serialized and non-serialized hardware and software components. This includes the datatype, data format and data description (semantics) as well as the data exchange. The existing regulatory requirements that every company within the industry faces today are being solved with individual, proprietary solutions. - -- The digital maturity is diverging within the automotive industry. For bigger companies it is a challenge to receive overall structured data from multiple different suppliers on a broad scale. Smaller companies struggle to generate and provide those data in a fully digitized way. - -- Current solutions are either costly due to expensive distributed ledgers or cannot guarantee trust and data sovereignty based on the GAIA-X and IDSA principles including the regulation of access and usage policies regarding data chains. Therefore, no end-to-end data exchange and cooperation has been achieved as of today. - -### Benefits - -#### OEM and large automotive suppliers - -For OEM and large automotive suppliers: The Traceability solution from Catena-X enables companies to identify products affected by a defect faster and more precisely and thus avoiding general and inaccurate recalls. Through this targeted containment, companies can save both time and money with fewer actions for their customers. Moreover, the Traceability solution enables businesses to rapidly identify the affected part and the corresponding supplier after receiving an alert from the customer. This leads to faster and, therefore, cheaper problem-solving for all parties and less complicated claim management. Furthermore, suppliers can prove compliance of their supply chain to upcoming regulations such as the Supply Chain Act. - -#### SME - -The developed and simple-to-use Traceability solutions support SMEs in their mission to digitize the shop floor and communication with customers and suppliers. Today, in order to provide data to their customers and suppliers, SMEs are obligated to use several, proprietary B2B-interfaces from their customers. With Catena-X aiming to have only one digital interface for all customers and suppliers, it increases the ease of data exchange and saves IT resources. Furthermore, due to the Catena-X data sovereignty principles, all participants know what happens with their data. This increases trust in the data exchange. - -#### Solution Provider - -Solution providers have the potential to scale customer groups and access new market potentials via marketplace and shared service network. - -### Example - Industry Problem - -The KIT enables business to start Quality Investigations and send Quality Alerts in a standardized way while already knowing which parts of your direct customer and suppliers are affected and which are not. - -Through the introduction of unique Catena-X IDs, companies can register digital twins for vehicles, products, components, and raw materials and uniquely identify them within the whole Catena-X ecosystem. Building on that, it is possible to interconnect the registered digital twins of different companies to create a coherent automotive data chain from end-to-end. Furthermore, those twins can easily be complemented with further data like material information to enable further use cases like Circular Economy. - - -## Tutorials - -The following video gives an overview of the presented Traceability Use Case. - - - - - - - -## Semantic Models - -### Bill of Material (BoM) - -A bill of material resembles the structure of an end product. It is a list of all raw materials, sub-assemblies and sub-components that are needed to manufacture the end procuct. -At Catena-X Traceability we consider more than one single BoM. The BoM changes during the lifecyle and therefore, we are talking about different BoMs in different lifecycles. - -#### BoM Representations - -##### Single-Level BOM - -A single-level BOM represents one level of an assembly and does not include any lower-level subassemblies. - -##### Multi-Level BOM - -A Multi-Level Bill of Materials (BOM) is a [bill of materials (BOM)](https://www.bterrell.com/sage-accpac-erp/manufacturing/definition-multi-level-bom/definition-bom/) that lists the components, assemblies, and materials required to make a part. It provides a display of all components that are directly or indirectly used in a parent item. When an item is a subcomponent, blend, intermediate, etc., all of its components, including purchased parts and [raw materials](https://www.bterrell.com/sage-accpac-erp/manufacturing/definition-multi-level-bom/definition-bom/definition-raw-materials/), are also exhibited. A multilevel structure can be illustrated by a tree with several levels. A multi-level BOM is created by connecting a series of individual single level BOMs together. - -##### Flattened BOM - -Flattening BOM means the intermediate levels in the BOM are removed and the lowest level is directly connected to the highest level. - -#### BoM Lifecycle Stages - -BoM LifeCycleStage concept based on STEP AP242 with slight adoptions in layout & wording: - -- Each instance can be identified by unique (within the organization) serial number (SN). -- The ‘multi-SN’ (multi Serial number) describes product defined with a generic part or item -- The ‘one per SN’ (one per Serial number) describes product defined with an individual part or item - -| Name |Identifier Step |Implemented CX |Identifier CX| Description |Purpose |Creating time of BoM | BoM Ausprägungen | one/more fix suppliers | -| :--- | :----:|:----: |:----: |:----: | :----: |:----: |:----: |:----: | -| **AsDesigned (AsDeveloped)** | multi-SN | Currently Not Implemented |Part number*
may not be the specific part number but a code that describes a part
(technische Produktbeschreibung) |BoM asDesigned is generated in the design phase of a new product including alternative parts. |Build up the initial BoM in design phase of a new automotive product including alternative parts
Expected to have research & development part descriptions instead of specific part numbers |starting 2 years before SoP (for e.g. of a new vehicle project) |150% incl. variants which will not be used later |partly known
can be open at this point of time | -| **AsPlanned** | multi-SN | **Implemented** |Part number|BoM AsPlanned is used to plan the manufacturing process including alternative parts. |BoM AsPlanned is used to plan manufacturing including alternative parts.
Sourcing will most likely be based on this (besides key parts which start earlier) |starting 1,5 years before building the first component |120% of all variants are covered, incl. possibly multiple suppliers for the same component |fixed suppliers, could be more than one supplier per part| -| **AsOrdered** | one per SN | Currently Not Implemented |Part number | BoM AsOrdered is used for manufacturing realization. | BoM that is used for manufacturing realization.
This is the list of parts & components currently used for manufactoring after start of production (SOP) or shortly before.| fixed order
(production order or custom order)|100% exact order is known |fixed suppliers, could be more than one supplier per part| -| **AsBuilt** | one per SN | **Implemented**|Serial number / batch number | BoM AsBuilt describes a product as manufactured. | BoM as a component is built or manufactured.
During manufactoring of for e.g. a vehicle the serial numbers & batch numbers are documented (German: Verbaudokumentation).
This leads to one BoM per built car|during building process or directly after finishing|100% |one specific supplier| -| **AsSupported / AsFlying / AsMaintained / AsOperated** | one per SN | Currently Not Implemented |Serial number / batch number | BoM AsMaintained describes the product after purchasing by a customer and updates by maintenance. | BoM after for e.g. a vehicle was picked up by the customer. Changes to live cycle before may apply due to maintenance or repair work e.g. exchange of parts, liquids, ...|Starts when customer has picked up the product, updating if any change is done|100% inkl. replaced parts, incl. history of exchanged parts |one specific supplier| -| **AsRecycled** | - |Currently Not Implemented| Serial number / batch number | BoM AsRecycled describes the BoM after the recycling of the product. | Requirement for Batteries.||100% || - -Two of the considered BoMs are already implemented in the use case Traceability and will be described as follows. - -### Overview "AsPlanned" - -#### Short introduction: what is a BoM AsPlanned? - -The BoM AsPlanned is the generic list of all possible catalogue parts & materials for a specific vehical project and the supply chain from OEM to raw material suppliers. The BoM is also called 120% which means that it includes alternative parts / materials (e.g. LED headlights and XENON headlights) and parts for certain markets. It will be set up way before Start of Production (SOP) and be updated if the contents are updated. It is used for Sourcing / Production Planning and always reflects the current state of parts / materials build into this specific vehicle project. - -The BoM AsPlanned also includes all versions of parts like changed parts. It has to enable parts/materials provided from multiple manufacturers or the same manufacturer at different production sites. Additionally it must be possible to map relations of the same part/material to different customers. - -The complexity of generic is much higher than BoM AsBuilt. It is used for technical topics, e.g., Supply Chain Act, DCM. - -#### Definition Status of the BoM AsPlanned - -Defined - -- Digital Twins - - Digtial Twin "PartType" - -- Traceability data aspect models - - Aspect model "PartAsPlanned" - - Aspect model "SingleLevelBoMAsPlanned" - - Aspect model "SingelLevelUsageAsPlanned" - - Aspect model "PartSiteInformationAsPlanned" - -### AsPlanned Aspect Models - -#### 1. PartAsPlanned - -A Part as Planned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status in a specific version. - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.part_as_planned/1.0.1](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.part_as_planned/1.0.1) - -#### 2. SingelLevelBomAsPlanned - -The single-level Bill of Material represents one sub-level of an assembly and does not include any lower-level subassemblies. In 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. - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_planned/1.1.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_planned/1.1.0) - -#### 3. SingelLevelUsageAsPlanned - -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 a 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. - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_usage_as_planned/1.1.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_usage_as_planned/1.1.0) - -#### 4. PartSiteInformationAsPlanned - -The aspect provides site related information for a given as planned item (i.e. a part type or part instance that is uniquely identifiable within Catena-X via its Catena-X ID). 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. - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.part_site_information_as_planned/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.part_site_information_as_planned/1.0.0) - -### Overview "AsBuilt" - -#### Short introduction: what is a BoM AsBuilt? - -A BoM AsBuilt resembles a single vehicle, which means that each vehicle built has its own individual BoM asBuilt. The BoM includes all part/components which either have a serial number, batch number, JIS number (sequence number) or a combination out of these. This means, that there is a direct and specific connection between a parent and a child part/component so that an accurate and exact traceability is possible. - -Also, the BoM is called 100%, as there are no alternative parts included but only built parts. Therefore, it will be set up when a part is produced and can be connected to its parent and child parts. - -In Catena-X the BoM asBuilt is used for technical topics, e.g., Quality, Battery Passport (CE). - -#### Definition Status of the BoM AsBuilt - -Defined - -- Digital Twins - - Digital Twin Serialized Part - - Digital Twin Batch - - Digital Twin Vehicle -- Build up the basic chain - - Aspect model "SerialPart" - - Aspect model "AssemblyPartRelation" - - Aspect model "Batch" - - Aspect model "JustInSequencePart" - - Aspect model "TractionBatteryCode" - -### AsBuilt Aspect Models - -#### 1. SerialPart - -A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial numbers or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number) - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.serial_part/1.0.1](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.serial_part/1.0.1) - -#### 2. SingleLevelBomAsBuilt - -The aspect provides the child parts (one structural level down) which the given object assembles. - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_built/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_built/1.0.0) - -#### 3. Batch - -A batch is a quantity of (semi-) finished products or (raw) material product that have been produced under the same circumstances (e.g. same production location), as specified groups or amounts, within a certain time frame. Every batch can differ in the number or amount of products. Different batches can have varied specifications, e.g., different colors. A batch is identified via a Batch ID. - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.batch/2.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.batch/2.0.0) - -#### 4. JustInSequencePart - -A just-in-sequence part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a combination of several IDs related to a just-in-sequence process. - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.just_in_sequence_part/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.just_in_sequence_part/1.0.0) - -#### 5. TractionBatteryCode - -The aspect provides the information of the Traction battery code of a battery cell, a battery module or a battery pack according to the chinese standard GB/T 34014-2017. Furthermore, it provides the traction battery codes for the assembled sub parts of the component, e.g. Traction battery code of a battery module plus all the traction battery codes of the assembled battery cells of this battery module. - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.traction_battery_code/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.traction_battery_code/1.0.0) - - -## Logic & Schema - -### Building Block Architecture Overview - -This architecture overview only shows Catena-X Core Services that are directly accessed by Traceability components, e.g. the EDC is shown, but not the DAPS which is accessed by the EDC, but not directly by the Data Provisioning component. - -![Architecture - Level 1](assets/architecture_level_1.png) - -#### Traceability Components - -| Subsystem | Description | -|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Data Provisioning | This component provides a company's data to the Catena-X network by transforming it into the Catena-X format and publishing it. In Catena-X, data must be provided to the network based on existing standards from the other Kits. One example that can be used is the Connector Kit that builds a component based on the DSP protocol, e.g. the Connector of the Eclipse Dataspace Components (EDC). As standard for digital twins, the Asset Administration Shell standard is used - this is relevant for registering digital twins (in the Digital Twin Registry) as well as for providing digital twin data. The data format used for Traceability data is based on the BAMM aspects models published in the Semantic Hub. | -| Traceability App | Enables traceability functionalities like quality alerts or notifications. When a Traceability App fetches data for digital twins (submodels), there are two options:
  • Directly access the partner's EDC and DTR to connect to other partner's EDC and retrieve the data from ther
  • Use a local IRS service to get the data and let the IRS handle the EDC and DTR communication.
| -| Internal Systems | Existing internal systems of a Catena-X partner which provide data to Traceability components.
  • For Data Provisioning: The data provided to Catena-X via the EDC should be fetched from a partner's internal PLM and parts master data systems.
  • For Traceability Apps: A Traceability App may show more data to a user than just the data that is provided to Catena-X (and fetched via the Data Provisioning component). The business scope of COTS software is bigger than just Traceability and they have existing interfaces to fetch all data they need for their business functionality (and not only Traceability data).
Both components can also send data back to internal systems. That's at the discretion of the Catena-X partner and neither required nor prohibited by the Traceability use case. | - -#### Catena-X Core Services - -| Subsystem | Description | -|:-----------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Digital Twin Registry | The Digital Twin Registry acts as an address book for Digital Twins. Data Providers register their Digital Twins in their own Digital Twin Registry. Data consumers query the Digital Twin Registries to find Digital Twins and interact with them further. A Digital Twin contains endpoint references to Submodel endpoints. Calling a Submodel endpoint returns data compliant to a semantic model. A semantic model describes the data that a Submodel endpoint returns.

[Repository of the Digital Twin Registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry). | -| Item Relationship Service (IRS) | The IRS is providing a technical API Endpoint in the Catena-X Network, which builds an item tree representation of given digital twins stored across the industry. Therefore it is a key component for the Network to provide data chains along the value chain in the industry.

[Repository of the IRS](https://github.com/eclipse-tractusx/item-relationship-service). | -| Eclipse Dataspace Components (EDC) | The Connector of the Eclipse Dataspace Components provides a framework for sovereign, inter-organizational data exchange. It will implement the International Data Spaces standard 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.

[Repository of the Catena-X specific EDC](https://github.com/eclipse-tractusx/tractusx-edc). | -| Discovery Service | The EDC / dataspace discovery interface is a CX network public available endpoint which can get used to retrieve EDC endpoints and the related BPNs, as well as search for endpoints via the BPN. | - - -## Business Process - -To enable data sovereignty, access and usage policies are important to protect the data assets of a data provider in the EDC, described in the following. Further details are described in the [CX - 0018 Sovereign Data Exchange](#standards) standard. - -### Access Policies - -To decide which company has access to the data assets, access policy should be used. Note that without protecting data assets with access policies, they become publicly available in the Catena-X network which is not recommended. Therefore, every asset should be protected and only be made available for specific companies, identified through their business partner number (BPN). - -#### BPN Access Policy - -This policy allows limiting access to a data offer based on a list of specific BPNs. This translates to the following functionality: - -- The data offer creator will be able to create a policy listing all the BPN that can access the data offer -- This means that only the connectors registered in the Catena-X network with the BPN listed in the policy can see the data offer and accept it (for the creation of data contracts and subsequent data exchange) - - -Examples including a JSON payload for single and multiple BPN are described on [this page in the tractus-x EDC repository](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/edc-extensions/bpn-validation) or in the [Business Partner Validation Extension part of the Connector Kit](../tractusx-edc/edc-extensions/business-partner-validation/). - -### Usage Policies - -To decide which company can use the data asset under specific conditions, usage policies (or contract policies) are used. Therefore, they are more specific than access policies and only used just after access is granted. Currently, the usage policies aren't technically enforced but based on a legal framework (keep this in mind when publishing data assets). - -Policies are defined based on the [W3C ODRL format](https://www.w3.org/TR/odrl-model/). This allows a standardized way of formulating policy payloads. It further allows to stack different constraints with the `odrl:and` operator. Therefore, every data provider can decide on his or her own under which conditions their data assets are shared in the network. It is recommended to restrict the data usage for all traceability aspects. An example of one usage policy containing three different constraints is shown and described in the following: - -```json -{ - "@context": { - "odrl": http://www.w3.org/ns/odrl/2/ - }, - "@type": "PolicyDefinitionRequestDto", - "@id": "", // Important for the contract definition - "policy": { - "@type": "Policy", - "odrl:permission": [ - { - "odrl:action": "USE", - "odrl:constraint": { - "@type": "LogicalConstraint", - "odrl:and": [ // All of the following three constraints have to be fullfilled (and, not or) - // First constraint to verify the the Catena-X membership - { - "@type": "Constraint", - "odrl:leftOperand": "Membership", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "active" - }, - // Second constraint to verify if the framework agreement for the traceability use case is accepted - { - "@type": "Constraint", - "odrl:leftOperand": "FrameworkAgreement.traceability", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "active" - }, - // Third constraint to define the specific purpose, further detailed in the framework agreement - { - "@type": "Constraint", - "odrl:leftOperand": "PURPOSE", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "" // See list in the framework agreement - } - ] - } - } - ] - } -} -``` - -#### Membership Policy - -To verify the participants Catena-X membership, the `Membership` verifiable credential can be used. In case of a policy, the data can only be used from verified Catena-X members. The payload is shown in the first constraint-part of the example above and described in detail in the [EDC part of the SSI documentation](https://github.com/eclipse-tractusx/ssi-docu/blob/main/docs/architecture/cx-3-2/edc/policy.definitions.md#1-membership-constraint). - -```json -{ - "@type": "Constraint", - "odrl:leftOperand": "Membership", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "active" -} -``` - -#### Framework Agreement Policy - -To verify if a participant accepted the framework agreement of a specific use case created by the [Catena-X association](https://catena-x.net/en/about-us/the-association), the `FrameworkAgreement.traceability` verifiable credential can be used for the traceability framework agreement. In case of a policy, the data can only be used from accepted and verified traceability framework agreement members. This is shown in the second constraint-part of the example above and described in detail in the [EDC part of the SSI documentation](https://github.com/eclipse-tractusx/ssi-docu/blob/main/docs/architecture/cx-3-2/edc/policy.definitions.md#35-traceability). - -```json -{ - "@type": "Constraint", - "odrl:leftOperand": "FrameworkAgreement.traceability", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "active" -} -``` - -#### Purpose-based Policy - -To further restrict the data usage, a purpose-based policy can be used. If, for example, the purpose mentions a quality investigation, this means that the data usage is only allowed for handling and working on the quality investigation. All possible purposes and their meanings are defined in the traceability framework agreement. This allows to create a uniform understanding and a standardized set of payloads in the network by connecting technical strings to legal agreements. - -It is highly recommended to only use this purpose-based policy together with the [Framework Agreement Policy](#framework-agreement-policy). Only with both together it can be ensured that the payload of the purpose policy is agreed by the other part and is based on the same set. - -Details about the endpoint and payload can be found in the [Transfer Data sample in the tractus-x EDC repository](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/docs/samples/Transfer%20Data.md#2-setup-data-offer) or in the [Connector Kit API documentation of the policy definition API](tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/create-policy-definition). - -```json -{ - "@type": "Constraint", - "odrl:leftOperand": "PURPOSE", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "" -} -``` - -The `` have to be replaced with one purpose string defined in the framework agreement. - -### Contract Definitions - -In the EDC, every policy is associated with a contract. Thus, a contract definition is needed. Details about the endpoint and payload can be found in the [Transfer Data sample in the tractus-x EDC repository](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/docs/samples/Transfer%20Data.md#2-setup-data-offer) or in the [Connector Kit API documentation of the contract definition API](../tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/edc-contract-definition-api). - -When using an above mentioned [Access Policy](#access-policies), their `id` needs to be included as a value of the `accessPolicyId` key in the contract definition. When using an above mentioned [Usage Policy](#usage-policies), their `id` needs to be included as a value of the `contractPolicyId` key in the contract definition. - -### Verifiable Credentials - -Verifiable Credentials (VC) are part of the Self-Sovereign Identity (SSI) standard by the W3C. Details about Catena-X specific VCs can be found in the [CX - 0016 Company Attribute Verification](#standards) standard. As mentioned there, it offers a `UseCaseFrameworkConditionCX` type allowing a data provider to check if specific conditions, like a signed use case contract as introduced in the [Purpose-base Usage Policy section](#purpose-based-policy), are agreed. Further technical documentation are presented in the [SSI Docu](https://github.com/eclipse-tractusx/ssi-docu/tree/main/docs/architecture) repository. - - -## Standards - -Our relevant standards can be downloaded from the official [Catena-X Standard Library](https://catena-x.net/de/standard-library): - -- [CX - 0018 Sovereign Data Exchange](https://catena-x.net/de/standard-library) -- [CX - 0019 Aspect Model: Serial Part](https://catena-x.net/de/standard-library) -- [CX - 0020 Aspect Model: Single Level BoMAsBuilt](https://catena-x.net/de/standard-library) -- [CX - 0021 Aspect Model: Batch](https://catena-x.net/de/standard-library) -- [CX - 0022 Notification Process](https://catena-x.net/de/standard-library) -- [CX - 0023 Notification API](https://catena-x.net/de/standard-library) -- [CX - 0042 Aspect Model: Single Level BomAsPlanned](https://catena-x.net/de/standard-library) -- [CX - 0043 Semantic Model: Part AsPlanned](https://catena-x.net/de/standard-library) -- [CX - 0093 Aspect Model TractionBatteryCode](https://catena-x.net/de/standard-library) -- [CX - 0094 Aspect Model Part Site Information AsPlanned](https://catena-x.net/de/standard-library) diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/page_changelog.md b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/page_changelog.md deleted file mode 100644 index 443fe8010a0..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/page_changelog.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -id: Traceability Kit Changelog -title: Changelog -description: 'Traceability Kit' -sidebar_position: 1 ---- - -![Traceability kit banner](@site/static/img/doc-traceability_header-minified.png) - -### Traceability KIT - -All notable changes to this Kit will be documented in this file. - -## [2.0.0] - 2023-09-28 - -Compatible for release 23.09 (also known as 3.2). - -### Added - -- **Adoption View:** - - TractionBatteryCode aspect model - - Information about Verifiable Credentials -- **Development View:** - - TractionBatteryCode aspect model - -### Changed - -- **General:** - - Updated all parts of the KIT related to the digital twin registry as the DTR now has a decentralized architecture - - Updated SerialPartTypization 1.1.1 to SerialPart 1.0.1 - - Updated AssemblyPartRelationship 1.1.1 to SingleLevelBomAsBuilt 1.0.0 - - Updated aspect model Batch from version 1.0.2 to 2.0.0 ([Release Notes](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.batch/RELEASE_NOTES.md)) - - Fixed references to deprecated releases -- **Adoption View:** - - Updated description of the policy section (Access Policies, Usage Policies, Contract Definitions) - - Updated relevant standards for release 3.2 -- **Development View:** - - Updated documentation because of the migration to the new standard AAS v3.0 by the DTR - - Updated conventions for submodel descriptors and EDC asset structure to give data provides more flexibility in how to create EDC assets for submodels of digital twins - - Setting the visibility of entries in a digital twin's specifid asset IDs is now mandatory to ensure need-know - - Removed optional customer attributes from example for Batch aspect model - -### Removed - -- **Adoption View:** - - Policy payloads are removed and replaced by specific documentation links - -## [1.0.1] - 2023-04-14 - -Compatible for release 3.1. - -### Added - -- **Adoption View:** - - Traceability tutorial video - - Customer journey - -### Changed - -- ./. - -### Removed - -- ./. - -## [1.0.0] - 2023-04-12 - -Compatible for release 3.1. - -### Added - -- Initial version of the Kit including adoption, operation and development view + two API specifications (Notification API, Unique ID Push API) - -### Changed - -- ./. - -### Removed - -- ./. diff --git a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/page_software-operation-view.md deleted file mode 100644 index c06853648d8..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/Traceability Kit/page_software-operation-view.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: Operation View Traceability Kit -title: Operation View -description: 'Traceability Kit' -sidebar_position: 3 ---- - -![Traceability kit banner](@site/static/img/doc-traceability_header-minified.png) - -### Traceability KIT - - - -Based on the information provided in this KIT, it is possible to create and operate an own, custom -Traceability app. One open-source example is the **Trace-X app** in conjunction with the **Simple -Data Exchanger (SDE)** for data provisioning. For further information regarding -their usage, configuration and deployment, follow these resources: - -- [Trace-X Frontend GitHub Repository](https://github.com/eclipse-tractusx/traceability-foss) -- [Trace-X Backend GitHub Repository](https://github.com/eclipse-tractusx/traceability-foss-backend) -- [Trace-X Installation Guide](https://github.com/eclipse-tractusx/traceability-foss/blob/main/frontend/INSTALL.md) -- [SDE Frontend GitHub Repository](https://github.com/eclipse-tractusx/dft-frontend) -- [SDE Backend GitHub Repository](https://github.com/eclipse-tractusx/dft-backend) diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/CHANGELOG.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/CHANGELOG.md deleted file mode 100644 index 8cb5dc3e4ef..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/CHANGELOG.md +++ /dev/null @@ -1,87 +0,0 @@ -# Changelog - -![Connector kit banner](@site/static/img/ConnectorKitIcon.png) - -## Connector KIT - -All notable changes to this Kit will be documented in this file. - -## [0.5.0] - 2023-08-09 - -

Changed

- -- preparation for release Tractus-X EDC 0.5.0 - -## [0.4.0] - 2023-07-07 - -

Added

- -- documentation to deal with the new managament-api -- documentation to deal with the new SSI -- tractusx-edc open api documentation -- legacy connector documentation which works with daps -- migration guide to edc version 0.5.x - -

Changed

- -- helm charts reference now to the edc version 0.5.0-rc5 -- restructuring of the openAPI documentation -- postmancollection contains the new management-api - -

Removed

- -- chart documentation for tractusx-connector-app -- unused files like charts, values.yaml -- decision records - -## [0.3.0] - 2023-05-16 - -

Added

- -- chart documentation for tractusx-connector-azure-vault - -

Changed

- -- helm chart documentation -> added needed properties and information about self-signed certificates for testing - -

Removed

- -- chart documentation for tractusx-connector-app -- unused files like charts, values.yaml - -## [0.2.0] - 2023-04-28 - -

Added

- -- documentation of the control-plane-adapter extension -- openAPI documentation of the control-plane-adapter extension -- documentation of the observability-api-customization -- migration documentation -- postman collection - -

Changed

- -- helm chart version for the edc components is now 0.3.3 -- switched the whole documentation structure from product-edc to tractusx-edc -- switched build tool from maven to gradle -- restructured the whole documentation structure and order - -

Removed

- -- ./. - -## [0.1.0] - 2023-03-01 - -

Added

- -- documentation of the management-api -- documentation of adoption view -- documentation of software development view - -

Changed

- -- ./. - -

Removed

- -- ./. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/README.md deleted file mode 100644 index 08664b5a8d5..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/README.md +++ /dev/null @@ -1,84 +0,0 @@ -# Tractus-X EDC (Eclipse Dataspace Connector) - -[![Contributors][contributors-shield]][contributors-url] -[![Stargazers][stars-shield]][stars-url] -[![Apache 2.0 License][license-shield]][license-url] -[![Latest Release][release-shield]][release-url] - -[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=eclipse-tractusx_tractusx-edc&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=eclipse-tractusx_tractusx-edc) - -Container images and deployments of the Eclipse Dataspace Components for the Tractus-X project. - -Please also refer to: - -- [Our docs](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/docs) -- [Our Releases](https://github.com/eclipse-tractusx/tractusx-edc/releases) -- [Eclipse Dataspace Components](https://github.com/eclipse-edc/Connector) -- [Report Bug / Request Feature](https://github.com/eclipse-tractusx/tractusx-edc/issues) - -## About The Project - -The project provides pre-built control- and data-plane [docker](https://www.docker.com/) images -and [helm](https://helm.sh/) charts of -the [Eclipse DataSpaceConnector Project](https://github.com/eclipse-edc/Connector). - -## Inventory - -The eclipse data space connector is split up into Control-Plane and Data-Plane, whereas the Control-Plane functions as -administration layer and has responsibility of resource management, contract negotiation and administer data transfer. -The Data-Plane does the heavy lifting of transferring and receiving data streams. - -Depending on your environment there are different derivatives of the control-plane prepared: - -- [edc-controlplane-postgresql-azure-vault](edc-controlplane/edc-controlplane-postgresql-azure-vault) with dependency onto - - [Azure Key Vault](https://azure.microsoft.com/en-us/services/key-vault/#product-overview) - - [PostgreSQL 8.2 or newer](https://www.postgresql.org/) -- [edc-controlplane-postgresql-hashicorp-vault](edc-controlplane/edc-controlplane-postgresql-hashicorp-vault) with - dependency onto - - [Hashicorp Vault](https://www.vaultproject.io/) - - [PostgreSQL 8.2 or newer](https://www.postgresql.org/) - -Derivatives of the Data-Plane can be found here - -- [edc-dataplane-azure-vault](edc-dataplane/edc-dataplane-azure-vault) with dependency onto - - [Azure Key Vault](https://azure.microsoft.com/en-us/services/key-vault/#product-overview) -- [edc-dataplane-hashicorp-vault](edc-dataplane/edc-dataplane-hashicorp-vault) with dependency onto - - [Hashicorp Vault](https://www.vaultproject.io/) - -For testing/development purposes: - -- [edc-runtime-memory](edc-controlplane/edc-runtime-memory) - -## Getting Started - -### Build - -Build Tractus-X EDC together with its Container Images - -```shell -./gradlew dockerize -``` - -## License - -Distributed under the Apache 2.0 License. -See [LICENSE](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE) for more information. - - - - -[contributors-shield]: https://img.shields.io/github/contributors/eclipse-tractusx/tractusx-edc.svg?style=for-the-badge - -[contributors-url]: https://github.com/eclipse-tractusx/tractusx-edc/graphs/contributors - -[stars-shield]: https://img.shields.io/github/stars/eclipse-tractusx/tractusx-edc.svg?style=for-the-badge - -[stars-url]: https://github.com/eclipse-tractusx/tractusx-edc/stargazers - -[license-shield]: https://img.shields.io/github/license/eclipse-tractusx/tractusx-edc.svg?style=for-the-badge - -[license-url]: https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE - -[release-shield]: https://img.shields.io/github/v/release/eclipse-tractusx/tractusx-edc.svg?style=for-the-badge - -[release-url]: https://github.com/eclipse-tractusx/tractusx-edc/releases diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/charts/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/charts/README.md deleted file mode 100644 index adbaac6af1a..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/charts/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# Helm Charts - -## Chart Linting - -Chart linting is performed using [helm's CT tool](https://github.com/helm/chart-testing). - -Configuration files for [CT](../ct.yaml), [Yamale](../chart_schema.yaml) and [Yamllint](../lintconf.yaml) have been provided. - -## Generate Chart Readme's - -To generate chart README.md files from its respective values.yaml file we use the [helm-docs tool](https://github.com/norwoodj/helm-docs): - -```shell -docker run --rm --volume "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:v1.10.0 -``` - -## Confidential EDC Settings - -Some EDC settings should better not be part of the actual deployment (like credentials to the database or the vault). Therefore, it is possible to deploy a secret with these confidential settings beforehand, and make it known to the deployment by setting the secret name in the `envSecretName` field of the deployment. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/charts/tractusx-connector-azure-vault/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/charts/tractusx-connector-azure-vault/README.md deleted file mode 100644 index 930209d75d1..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/charts/tractusx-connector-azure-vault/README.md +++ /dev/null @@ -1,275 +0,0 @@ -# tractusx-connector-azure-vault - -![Version: 0.5.0](https://img.shields.io/badge/Version-0.5.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.5.0](https://img.shields.io/badge/AppVersion-0.5.0-informational?style=flat-square) - -A Helm chart for Tractus-X Eclipse Data Space Connector. The connector deployment consists of two runtime consists of a -Control Plane and a Data Plane. Note that _no_ external dependencies such as a PostgreSQL database and Azure KeyVault are included. - -This chart is intended for use with an _existing_ PostgreSQL database and an _existing_ Azure KeyVault. - -**Homepage:** - -## Setting up SSI - -### Preconditions - -- the [Managed Identity Walled (MIW)](https://github.com/catenax-ng/tx-managed-identity-wallets) must be running and reachable via network -- the necessary set of VerifiableCredentials for this participant must be pushed to MIW. This is typically done by the - Portal during participant onboarding -- Keycloak must be running and reachable via network -- an account with Keycloak must be created for this BPN and the connector must be able to obtain access tokens -- the client ID and client secret corresponding to that account must be known - -### Preparatory work - -- store your Keycloak client secret in the Azure KeyVault. The exact procedure is as follows: - - ```bash - az keyvault secret set --vault-name --name client-secret --value "$YOUR_CLIENT_SECRET" - ``` - - By default, Tractus-X EDC expects to find the secret under `client-secret`. - -### Configure the chart - -Be sure to provide the following configuration entries to your Tractus-X EDC Helm chart: - -- `controlplane.ssi.miw.url`: the URL -- `controlplane.ssi.miw.authorityId`: the BPN of the issuer authority -- `controlplane.ssi.oauth.tokenurl`: the URL (of Keycloak), where access tokens can be obtained -- `controlplane.ssi.oauth.client.id`: client ID for Keycloak -- `controlplane.ssi.oauth.client.secretAlias`: the alias under which the client secret is stored in the vault. Defaults to `client-secret`. - -### Launching the application - -As an easy starting point, please consider using [this example configuration](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-tests/deployment/src/main/resources/helm/tractusx-connector-test.yaml) -to launch the application. The configuration values mentioned above (`controlplane.ssi.*`) will have to be adapted manually. -Combined, run this shell command to start the in-memory Tractus-X EDC runtime: - -```shell -helm repo add tractusx-edc https://eclipse-tractusx.github.io/charts/dev -helm install my-release tractusx-edc/tractusx-connector-azure-vault --version 0.5.0 \ - -f /tractusx-connector-azure-vault-test.yaml \ - --set vault.azure.name=$AZURE_VAULT_NAME \ - --set vault.azure.client=$AZURE_CLIENT_ID \ - --set vault.azure.secret=$AZURE_CLIENT_SECRET \ - --set vault.azure.tenant=$AZURE_TENANT_ID -``` - -## Source Code - -- - -## Requirements - -| Repository | Name | Version | -|------------|------|---------| -| | postgresql(postgresql) | 12.1.6 | - -## Values - -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| backendService.httpProxyTokenReceiverUrl | string | `""` | | -| controlplane.affinity | object | `{}` | | -| controlplane.autoscaling.enabled | bool | `false` | Enables [horizontal pod autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) | -| controlplane.autoscaling.maxReplicas | int | `100` | Maximum replicas if resource consumption exceeds resource threshholds | -| controlplane.autoscaling.minReplicas | int | `1` | Minimal replicas if resource consumption falls below resource threshholds | -| controlplane.autoscaling.targetCPUUtilizationPercentage | int | `80` | targetAverageUtilization of cpu provided to a pod | -| controlplane.autoscaling.targetMemoryUtilizationPercentage | int | `80` | targetAverageUtilization of memory provided to a pod | -| controlplane.businessPartnerValidation.log.agreementValidation | bool | `true` | | -| controlplane.debug.enabled | bool | `false` | | -| controlplane.debug.port | int | `1044` | | -| controlplane.debug.suspendOnStart | bool | `false` | | -| controlplane.endpoints | object | `{"control":{"path":"/control","port":8083},"default":{"path":"/api","port":8080},"management":{"authKey":"","path":"/management","port":8081},"metrics":{"path":"/metrics","port":9090},"protocol":{"path":"/api/v1/dsp","port":8084}}` | endpoints of the control plane | -| controlplane.endpoints.control | object | `{"path":"/control","port":8083}` | control api, used for internal control calls. can be added to the internal ingress, but should probably not | -| controlplane.endpoints.control.path | string | `"/control"` | path for incoming api calls | -| controlplane.endpoints.control.port | int | `8083` | port for incoming api calls | -| controlplane.endpoints.default | object | `{"path":"/api","port":8080}` | default api for health checks, should not be added to any ingress | -| controlplane.endpoints.default.path | string | `"/api"` | path for incoming api calls | -| controlplane.endpoints.default.port | int | `8080` | port for incoming api calls | -| controlplane.endpoints.management | object | `{"authKey":"","path":"/management","port":8081}` | data management api, used by internal users, can be added to an ingress and must not be internet facing | -| controlplane.endpoints.management.authKey | string | `""` | authentication key, must be attached to each 'X-Api-Key' request header | -| controlplane.endpoints.management.path | string | `"/management"` | path for incoming api calls | -| controlplane.endpoints.management.port | int | `8081` | port for incoming api calls | -| controlplane.endpoints.metrics | object | `{"path":"/metrics","port":9090}` | metrics api, used for application metrics, must not be internet facing | -| controlplane.endpoints.metrics.path | string | `"/metrics"` | path for incoming api calls | -| controlplane.endpoints.metrics.port | int | `9090` | port for incoming api calls | -| controlplane.endpoints.protocol | object | `{"path":"/api/v1/dsp","port":8084}` | dsp api, used for inter connector communication and must be internet facing | -| controlplane.endpoints.protocol.path | string | `"/api/v1/dsp"` | path for incoming api calls | -| controlplane.endpoints.protocol.port | int | `8084` | port for incoming api calls | -| controlplane.env | object | `{}` | | -| controlplane.envConfigMapNames | list | `[]` | | -| controlplane.envSecretNames | list | `[]` | | -| controlplane.envValueFrom | object | `{}` | | -| controlplane.image.pullPolicy | string | `"IfNotPresent"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy) to use | -| controlplane.image.repository | string | `""` | Which derivate of the control plane to use. when left empty the deployment will select the correct image automatically | -| controlplane.image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion | -| controlplane.ingresses[0].annotations | object | `{}` | Additional ingress annotations to add | -| controlplane.ingresses[0].certManager.clusterIssuer | string | `""` | If preset enables certificate generation via cert-manager cluster-wide issuer | -| controlplane.ingresses[0].certManager.issuer | string | `""` | If preset enables certificate generation via cert-manager namespace scoped issuer | -| controlplane.ingresses[0].className | string | `""` | Defines the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use | -| controlplane.ingresses[0].enabled | bool | `false` | | -| controlplane.ingresses[0].endpoints | list | `["protocol"]` | EDC endpoints exposed by this ingress resource | -| controlplane.ingresses[0].hostname | string | `"edc-control.local"` | The hostname to be used to precisely map incoming traffic onto the underlying network service | -| controlplane.ingresses[0].tls | object | `{"enabled":false,"secretName":""}` | TLS [tls class](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) applied to the ingress resource | -| controlplane.ingresses[0].tls.enabled | bool | `false` | Enables TLS on the ingress resource | -| controlplane.ingresses[0].tls.secretName | string | `""` | If present overwrites the default secret name | -| controlplane.ingresses[1].annotations | object | `{}` | Additional ingress annotations to add | -| controlplane.ingresses[1].certManager.clusterIssuer | string | `""` | If preset enables certificate generation via cert-manager cluster-wide issuer | -| controlplane.ingresses[1].certManager.issuer | string | `""` | If preset enables certificate generation via cert-manager namespace scoped issuer | -| controlplane.ingresses[1].className | string | `""` | Defines the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use | -| controlplane.ingresses[1].enabled | bool | `false` | | -| controlplane.ingresses[1].endpoints | list | `["management","control"]` | EDC endpoints exposed by this ingress resource | -| controlplane.ingresses[1].hostname | string | `"edc-control.intranet"` | The hostname to be used to precisely map incoming traffic onto the underlying network service | -| controlplane.ingresses[1].tls | object | `{"enabled":false,"secretName":""}` | TLS [tls class](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) applied to the ingress resource | -| controlplane.ingresses[1].tls.enabled | bool | `false` | Enables TLS on the ingress resource | -| controlplane.ingresses[1].tls.secretName | string | `""` | If present overwrites the default secret name | -| controlplane.initContainers | list | `[]` | | -| controlplane.livenessProbe.enabled | bool | `true` | Whether to enable kubernetes [liveness-probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| controlplane.livenessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| controlplane.livenessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first liveness check | -| controlplane.livenessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a liveness check every 10 seconds | -| controlplane.livenessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| controlplane.livenessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| controlplane.logging | string | `".level=INFO\norg.eclipse.edc.level=ALL\nhandlers=java.util.logging.ConsoleHandler\njava.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter\njava.util.logging.ConsoleHandler.level=ALL\njava.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n"` | configuration of the [Java Util Logging Facade](https://docs.oracle.com/javase/7/docs/technotes/guides/logging/overview.html) | -| controlplane.nodeSelector | object | `{}` | | -| controlplane.opentelemetry | string | `"otel.javaagent.enabled=false\notel.javaagent.debug=false"` | configuration of the [Open Telemetry Agent](https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/) to collect and expose metrics | -| controlplane.podAnnotations | object | `{}` | additional annotations for the pod | -| controlplane.podLabels | object | `{}` | additional labels for the pod | -| controlplane.podSecurityContext | object | `{"fsGroup":10001,"runAsGroup":10001,"runAsUser":10001,"seccompProfile":{"type":"RuntimeDefault"}}` | The [pod security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod) defines privilege and access control settings for a Pod within the deployment | -| controlplane.podSecurityContext.fsGroup | int | `10001` | The owner for volumes and any files created within volumes will belong to this guid | -| controlplane.podSecurityContext.runAsGroup | int | `10001` | Processes within a pod will belong to this guid | -| controlplane.podSecurityContext.runAsUser | int | `10001` | Runs all processes within a pod with a special uid | -| controlplane.podSecurityContext.seccompProfile.type | string | `"RuntimeDefault"` | Restrict a Container's Syscalls with seccomp | -| controlplane.readinessProbe.enabled | bool | `true` | Whether to enable kubernetes [readiness-probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| controlplane.readinessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| controlplane.readinessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first readiness check | -| controlplane.readinessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a readiness check every 10 seconds | -| controlplane.readinessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| controlplane.readinessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| controlplane.replicaCount | int | `1` | | -| controlplane.resources | object | `{}` | [resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for the container | -| controlplane.securityContext.allowPrivilegeEscalation | bool | `false` | Controls [Privilege Escalation](https://kubernetes.io/docs/concepts/security/pod-security-policy/#privilege-escalation) enabling setuid binaries changing the effective user ID | -| controlplane.securityContext.capabilities.add | list | `[]` | Specifies which capabilities to add to issue specialized syscalls | -| controlplane.securityContext.capabilities.drop | list | `["ALL"]` | Specifies which capabilities to drop to reduce syscall attack surface | -| controlplane.securityContext.readOnlyRootFilesystem | bool | `true` | Whether the root filesystem is mounted in read-only mode | -| controlplane.securityContext.runAsNonRoot | bool | `true` | Requires the container to run without root privileges | -| controlplane.securityContext.runAsUser | int | `10001` | The container's process will run with the specified uid | -| controlplane.service.annotations | object | `{}` | | -| controlplane.service.type | string | `"ClusterIP"` | [Service type](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) to expose the running application on a set of Pods as a network service. | -| controlplane.ssi.miw.authorityId | string | `""` | The BPN of the issuer authority | -| controlplane.ssi.miw.url | string | `""` | MIW URL | -| controlplane.ssi.oauth.client.id | string | `""` | The client ID for Keycloak | -| controlplane.ssi.oauth.client.secretAlias | string | `"client-secret"` | The alias under which the client secret is stored in the vault. | -| controlplane.ssi.oauth.tokenurl | string | `""` | The URL (of Keycloak), where access tokens can be obtained | -| controlplane.tolerations | list | `[]` | | -| controlplane.url.protocol | string | `""` | Explicitly declared url for reaching the dsp api (e.g. if ingresses not used) | -| controlplane.volumeMounts | list | `[]` | declare where to mount [volumes](https://kubernetes.io/docs/concepts/storage/volumes/) into the container | -| controlplane.volumes | list | `[]` | [volume](https://kubernetes.io/docs/concepts/storage/volumes/) directories | -| customLabels | object | `{}` | To add some custom labels | -| dataplane.affinity | object | `{}` | | -| dataplane.autoscaling.enabled | bool | `false` | Enables [horizontal pod autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) | -| dataplane.autoscaling.maxReplicas | int | `100` | Maximum replicas if resource consumption exceeds resource threshholds | -| dataplane.autoscaling.minReplicas | int | `1` | Minimal replicas if resource consumption falls below resource threshholds | -| dataplane.autoscaling.targetCPUUtilizationPercentage | int | `80` | targetAverageUtilization of cpu provided to a pod | -| dataplane.autoscaling.targetMemoryUtilizationPercentage | int | `80` | targetAverageUtilization of memory provided to a pod | -| dataplane.aws.accessKeyId | string | `""` | | -| dataplane.aws.endpointOverride | string | `""` | | -| dataplane.aws.secretAccessKey | string | `""` | | -| dataplane.debug.enabled | bool | `false` | | -| dataplane.debug.port | int | `1044` | | -| dataplane.debug.suspendOnStart | bool | `false` | | -| dataplane.endpoints.control.path | string | `"/api/dataplane/control"` | | -| dataplane.endpoints.control.port | int | `8083` | | -| dataplane.endpoints.default.path | string | `"/api"` | | -| dataplane.endpoints.default.port | int | `8080` | | -| dataplane.endpoints.metrics.path | string | `"/metrics"` | | -| dataplane.endpoints.metrics.port | int | `9090` | | -| dataplane.endpoints.proxy.path | string | `"/proxy"` | | -| dataplane.endpoints.proxy.port | int | `8186` | | -| dataplane.endpoints.public.path | string | `"/api/public"` | | -| dataplane.endpoints.public.port | int | `8081` | | -| dataplane.env | object | `{}` | | -| dataplane.envConfigMapNames | list | `[]` | | -| dataplane.envSecretNames | list | `[]` | | -| dataplane.envValueFrom | object | `{}` | | -| dataplane.image.pullPolicy | string | `"IfNotPresent"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy) to use | -| dataplane.image.repository | string | `""` | Which derivate of the data plane to use. when left empty the deployment will select the correct image automatically | -| dataplane.image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion | -| dataplane.ingresses[0].annotations | object | `{}` | Additional ingress annotations to add | -| dataplane.ingresses[0].certManager.clusterIssuer | string | `""` | If preset enables certificate generation via cert-manager cluster-wide issuer | -| dataplane.ingresses[0].certManager.issuer | string | `""` | If preset enables certificate generation via cert-manager namespace scoped issuer | -| dataplane.ingresses[0].className | string | `""` | Defines the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use | -| dataplane.ingresses[0].enabled | bool | `false` | | -| dataplane.ingresses[0].endpoints | list | `["public"]` | EDC endpoints exposed by this ingress resource | -| dataplane.ingresses[0].hostname | string | `"edc-data.local"` | The hostname to be used to precisely map incoming traffic onto the underlying network service | -| dataplane.ingresses[0].tls | object | `{"enabled":false,"secretName":""}` | TLS [tls class](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) applied to the ingress resource | -| dataplane.ingresses[0].tls.enabled | bool | `false` | Enables TLS on the ingress resource | -| dataplane.ingresses[0].tls.secretName | string | `""` | If present overwrites the default secret name | -| dataplane.initContainers | list | `[]` | | -| dataplane.livenessProbe.enabled | bool | `true` | Whether to enable kubernetes [liveness-probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| dataplane.livenessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| dataplane.livenessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first liveness check | -| dataplane.livenessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a liveness check every 10 seconds | -| dataplane.livenessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| dataplane.livenessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| dataplane.logging | string | `".level=INFO\norg.eclipse.edc.level=ALL\nhandlers=java.util.logging.ConsoleHandler\njava.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter\njava.util.logging.ConsoleHandler.level=ALL\njava.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n"` | configuration of the [Java Util Logging Facade](https://docs.oracle.com/javase/7/docs/technotes/guides/logging/overview.html) | -| dataplane.nodeSelector | object | `{}` | | -| dataplane.opentelemetry | string | `"otel.javaagent.enabled=false\notel.javaagent.debug=false"` | configuration of the [Open Telemetry Agent](https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/) to collect and expose metrics | -| dataplane.podAnnotations | object | `{}` | additional annotations for the pod | -| dataplane.podLabels | object | `{}` | additional labels for the pod | -| dataplane.podSecurityContext | object | `{"fsGroup":10001,"runAsGroup":10001,"runAsUser":10001,"seccompProfile":{"type":"RuntimeDefault"}}` | The [pod security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod) defines privilege and access control settings for a Pod within the deployment | -| dataplane.podSecurityContext.fsGroup | int | `10001` | The owner for volumes and any files created within volumes will belong to this guid | -| dataplane.podSecurityContext.runAsGroup | int | `10001` | Processes within a pod will belong to this guid | -| dataplane.podSecurityContext.runAsUser | int | `10001` | Runs all processes within a pod with a special uid | -| dataplane.podSecurityContext.seccompProfile.type | string | `"RuntimeDefault"` | Restrict a Container's Syscalls with seccomp | -| dataplane.readinessProbe.enabled | bool | `true` | Whether to enable kubernetes [readiness-probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| dataplane.readinessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| dataplane.readinessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first readiness check | -| dataplane.readinessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a liveness check every 10 seconds | -| dataplane.readinessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| dataplane.readinessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| dataplane.replicaCount | int | `1` | | -| dataplane.resources | object | `{}` | [resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for the container | -| dataplane.securityContext.allowPrivilegeEscalation | bool | `false` | Controls [Privilege Escalation](https://kubernetes.io/docs/concepts/security/pod-security-policy/#privilege-escalation) enabling setuid binaries changing the effective user ID | -| dataplane.securityContext.capabilities.add | list | `[]` | Specifies which capabilities to add to issue specialized syscalls | -| dataplane.securityContext.capabilities.drop | list | `["ALL"]` | Specifies which capabilities to drop to reduce syscall attack surface | -| dataplane.securityContext.readOnlyRootFilesystem | bool | `true` | Whether the root filesystem is mounted in read-only mode | -| dataplane.securityContext.runAsNonRoot | bool | `true` | Requires the container to run without root privileges | -| dataplane.securityContext.runAsUser | int | `10001` | The container's process will run with the specified uid | -| dataplane.service.port | int | `80` | | -| dataplane.service.type | string | `"ClusterIP"` | [Service type](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) to expose the running application on a set of Pods as a network service. | -| dataplane.tolerations | list | `[]` | | -| dataplane.url.public | string | `""` | Explicitly declared url for reaching the public api (e.g. if ingresses not used) | -| dataplane.volumeMounts | list | `[]` | declare where to mount [volumes](https://kubernetes.io/docs/concepts/storage/volumes/) into the container | -| dataplane.volumes | list | `[]` | [volume](https://kubernetes.io/docs/concepts/storage/volumes/) directories | -| fullnameOverride | string | `""` | | -| imagePullSecrets | list | `[]` | Existing image pull secret to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry) | -| install.postgresql | bool | `true` | | -| nameOverride | string | `""` | | -| participant.id | string | `""` | BPN Number | -| postgresql.auth.database | string | `"edc"` | | -| postgresql.auth.password | string | `"password"` | | -| postgresql.auth.username | string | `"user"` | | -| postgresql.enabled | bool | `false` | | -| postgresql.jdbcUrl | string | `"jdbc:postgresql://{{ .Release.Name }}-postgresql:5432/edc"` | | -| postgresql.primary.persistence | string | `nil` | | -| postgresql.readReplicas.persistence.enabled | bool | `false` | | -| serviceAccount.annotations | object | `{}` | | -| serviceAccount.create | bool | `true` | | -| serviceAccount.imagePullSecrets | list | `[]` | Existing image pull secret bound to the service account to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry) | -| serviceAccount.name | string | `""` | | -| tests | object | `{"hookDeletePolicy":"before-hook-creation,hook-succeeded"}` | Configurations for Helm tests | -| tests.hookDeletePolicy | string | `"before-hook-creation,hook-succeeded"` | Configure the hook-delete-policy for Helm tests | -| vault.azure.certificate | string | `nil` | | -| vault.azure.client | string | `""` | | -| vault.azure.name | string | `""` | | -| vault.azure.secret | string | `nil` | | -| vault.azure.tenant | string | `""` | | -| vault.secretNames.transferProxyTokenEncryptionAesKey | string | `"transfer-proxy-token-encryption-aes-key"` | | -| vault.secretNames.transferProxyTokenSignerPrivateKey | string | `nil` | | -| vault.secretNames.transferProxyTokenSignerPublicKey | string | `nil` | | - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.10.0](https://github.com/norwoodj/helm-docs/releases/v1.10.0) diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/charts/tractusx-connector-memory/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/charts/tractusx-connector-memory/README.md deleted file mode 100644 index a907cc22f8d..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/charts/tractusx-connector-memory/README.md +++ /dev/null @@ -1,178 +0,0 @@ -# tractusx-connector-memory - -![Version: 0.5.0](https://img.shields.io/badge/Version-0.5.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.5.0](https://img.shields.io/badge/AppVersion-0.5.0-informational?style=flat-square) - -A Helm chart for Tractus-X Eclipse Data Space Connector based on memory. Please only use this for development or testing purposes, never in production workloads! - -**Homepage:** - -## Setting up SSI - -### Preconditions - -- the [Managed Identity Walled (MIW)](https://github.com/catenax-ng/tx-managed-identity-wallets) must be running and reachable via network -- the necessary set of VerifiableCredentials for this participant must be pushed to MIW. This is typically done by the - Portal during participant onboarding -- Keycloak must be running and reachable via network -- an account with Keycloak must be created for this BPN and the connector must be able to obtain access tokens -- the client ID and client secret corresponding to that account must be known - -### Preparatory work - -- store your Keycloak client secret in the HashiCorp vault. The exact procedure will depend on your deployment of HashiCorp Vault and - is out of scope of this document. But by default, Tractus-X EDC expects to find the secret under `secret/client-secret`. - -### Configure the chart - -Be sure to provide the following configuration entries to your Tractus-X EDC Helm chart: - -- `runtime.ssi.miw.url`: the URL -- `runtime.ssi.miw.authorityId`: the BPN of the issuer authority -- `runtime.ssi.oauth.tokenurl`: the URL (of Keycloak), where access tokens can be obtained -- `runtime.ssi.oauth.client.id`: client ID for Keycloak -- `runtime.ssi.oauth.client.secretAlias`: the alias under which the client secret is stored in the vault. Defaults to `client-secret`. - -### Launching the application - -As an easy starting point, please consider using [this example configuration](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-tests/deployment/src/main/resources/helm/tractusx-connector-test.yaml) -to launch the application. The configuration values mentioned above (`controlplane.ssi.*`) will have to be adapted manually. -Combined, run this shell command to start the in-memory Tractus-X EDC runtime: - -```shell -helm repo add tractusx-edc https://eclipse-tractusx.github.io/charts/dev -helm install my-release tractusx-edc/tractusx-connector-memory --version 0.5.0 \ - -f /tractusx-connector-memory-test.yaml \ - --set vault.secrets="client-secret:$YOUR_CLIENT_SECRET" -``` - -## Source Code - -- - -## Values - -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| backendService.httpProxyTokenReceiverUrl | string | `""` | | -| customLabels | object | `{}` | To add some custom labels | -| daps.clientId | string | `""` | | -| daps.connectors[0].attributes.referringConnector | string | `"http://sokrates-controlplane/BPNSOKRATES"` | | -| daps.connectors[0].certificate | string | `""` | | -| daps.connectors[0].id | string | `"E7:07:2D:74:56:66:31:F0:7B:10:EA:B6:03:06:4C:23:7F:ED:A6:65:keyid:E7:07:2D:74:56:66:31:F0:7B:10:EA:B6:03:06:4C:23:7F:ED:A6:65"` | | -| daps.connectors[0].name | string | `"sokrates"` | | -| daps.paths.jwks | string | `"/jwks.json"` | | -| daps.paths.token | string | `"/token"` | | -| daps.url | string | `"http://{{ .Release.Name }}-daps:4567"` | | -| fullnameOverride | string | `""` | | -| imagePullSecrets | list | `[]` | Existing image pull secret to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry) | -| nameOverride | string | `""` | | -| participant.id | string | `""` | BPN Number | -| runtime.affinity | object | `{}` | | -| runtime.autoscaling.enabled | bool | `false` | Enables [horizontal pod autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) | -| runtime.autoscaling.maxReplicas | int | `100` | Maximum replicas if resource consumption exceeds resource threshholds | -| runtime.autoscaling.minReplicas | int | `1` | Minimal replicas if resource consumption falls below resource threshholds | -| runtime.autoscaling.targetCPUUtilizationPercentage | int | `80` | targetAverageUtilization of cpu provided to a pod | -| runtime.autoscaling.targetMemoryUtilizationPercentage | int | `80` | targetAverageUtilization of memory provided to a pod | -| runtime.businessPartnerValidation.log.agreementValidation | bool | `true` | | -| runtime.debug.enabled | bool | `false` | | -| runtime.debug.port | int | `1044` | | -| runtime.debug.suspendOnStart | bool | `false` | | -| runtime.endpoints | object | `{"control":{"path":"/control","port":8083},"default":{"path":"/api","port":8080},"management":{"authKey":"","path":"/management","port":8081},"protocol":{"path":"/api/v1/dsp","port":8084},"proxy":{"path":"/proxy","port":8186},"public":{"path":"/api/public","port":8086},"validation":{"path":"/validation","port":8082}}` | endpoints of the control plane | -| runtime.endpoints.control | object | `{"path":"/control","port":8083}` | control api, used for internal control calls. can be added to the internal ingress, but should probably not | -| runtime.endpoints.control.path | string | `"/control"` | path for incoming api calls | -| runtime.endpoints.control.port | int | `8083` | port for incoming api calls | -| runtime.endpoints.default | object | `{"path":"/api","port":8080}` | default api for health checks, should not be added to any ingress | -| runtime.endpoints.default.path | string | `"/api"` | path for incoming api calls | -| runtime.endpoints.default.port | int | `8080` | port for incoming api calls | -| runtime.endpoints.management | object | `{"authKey":"","path":"/management","port":8081}` | data management api, used by internal users, can be added to an ingress and must not be internet facing | -| runtime.endpoints.management.authKey | string | `""` | authentication key, must be attached to each 'X-Api-Key' request header | -| runtime.endpoints.management.path | string | `"/management"` | path for incoming api calls | -| runtime.endpoints.management.port | int | `8081` | port for incoming api calls | -| runtime.endpoints.protocol | object | `{"path":"/api/v1/dsp","port":8084}` | dsp api, used for inter connector communication and must be internet facing | -| runtime.endpoints.protocol.path | string | `"/api/v1/dsp"` | path for incoming api calls | -| runtime.endpoints.protocol.port | int | `8084` | port for incoming api calls | -| runtime.endpoints.validation | object | `{"path":"/validation","port":8082}` | validation api, only used by the data plane and should not be added to any ingress | -| runtime.endpoints.validation.path | string | `"/validation"` | path for incoming api calls | -| runtime.endpoints.validation.port | int | `8082` | port for incoming api calls | -| runtime.env | object | `{}` | | -| runtime.envConfigMapNames | list | `[]` | | -| runtime.envSecretNames | list | `[]` | | -| runtime.envValueFrom | object | `{}` | | -| runtime.image.pullPolicy | string | `"IfNotPresent"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy) to use | -| runtime.image.repository | string | `""` | | -| runtime.image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion | -| runtime.ingresses[0].annotations | object | `{}` | Additional ingress annotations to add | -| runtime.ingresses[0].certManager.clusterIssuer | string | `""` | If preset enables certificate generation via cert-manager cluster-wide issuer | -| runtime.ingresses[0].certManager.issuer | string | `""` | If preset enables certificate generation via cert-manager namespace scoped issuer | -| runtime.ingresses[0].className | string | `""` | Defines the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use | -| runtime.ingresses[0].enabled | bool | `false` | | -| runtime.ingresses[0].endpoints | list | `["protocol"]` | EDC endpoints exposed by this ingress resource | -| runtime.ingresses[0].hostname | string | `"edc-control.local"` | The hostname to be used to precisely map incoming traffic onto the underlying network service | -| runtime.ingresses[0].tls | object | `{"enabled":false,"secretName":""}` | TLS [tls class](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) applied to the ingress resource | -| runtime.ingresses[0].tls.enabled | bool | `false` | Enables TLS on the ingress resource | -| runtime.ingresses[0].tls.secretName | string | `""` | If present overwrites the default secret name | -| runtime.ingresses[1].annotations | object | `{}` | Additional ingress annotations to add | -| runtime.ingresses[1].certManager.clusterIssuer | string | `""` | If preset enables certificate generation via cert-manager cluster-wide issuer | -| runtime.ingresses[1].certManager.issuer | string | `""` | If preset enables certificate generation via cert-manager namespace scoped issuer | -| runtime.ingresses[1].className | string | `""` | Defines the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use | -| runtime.ingresses[1].enabled | bool | `false` | | -| runtime.ingresses[1].endpoints | list | `["management","control"]` | EDC endpoints exposed by this ingress resource | -| runtime.ingresses[1].hostname | string | `"edc-control.intranet"` | The hostname to be used to precisely map incoming traffic onto the underlying network service | -| runtime.ingresses[1].tls | object | `{"enabled":false,"secretName":""}` | TLS [tls class](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) applied to the ingress resource | -| runtime.ingresses[1].tls.enabled | bool | `false` | Enables TLS on the ingress resource | -| runtime.ingresses[1].tls.secretName | string | `""` | If present overwrites the default secret name | -| runtime.initContainers | list | `[]` | | -| runtime.livenessProbe.enabled | bool | `true` | Whether to enable kubernetes [liveness-probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| runtime.livenessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| runtime.livenessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first liveness check | -| runtime.livenessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a liveness check every 10 seconds | -| runtime.livenessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| runtime.livenessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| runtime.logging | string | `".level=INFO\norg.eclipse.edc.level=ALL\nhandlers=java.util.logging.ConsoleHandler\njava.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter\njava.util.logging.ConsoleHandler.level=ALL\njava.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n"` | configuration of the [Java Util Logging Facade](https://docs.oracle.com/javase/7/docs/technotes/guides/logging/overview.html) | -| runtime.nodeSelector | object | `{}` | | -| runtime.podAnnotations | object | `{}` | additional annotations for the pod | -| runtime.podLabels | object | `{}` | additional labels for the pod | -| runtime.podSecurityContext | object | `{"fsGroup":10001,"runAsGroup":10001,"runAsUser":10001,"seccompProfile":{"type":"RuntimeDefault"}}` | The [pod security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod) defines privilege and access control settings for a Pod within the deployment | -| runtime.podSecurityContext.fsGroup | int | `10001` | The owner for volumes and any files created within volumes will belong to this guid | -| runtime.podSecurityContext.runAsGroup | int | `10001` | Processes within a pod will belong to this guid | -| runtime.podSecurityContext.runAsUser | int | `10001` | Runs all processes within a pod with a special uid | -| runtime.podSecurityContext.seccompProfile.type | string | `"RuntimeDefault"` | Restrict a Container's Syscalls with seccomp | -| runtime.readinessProbe.enabled | bool | `true` | Whether to enable kubernetes [readiness-probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| runtime.readinessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| runtime.readinessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first readiness check | -| runtime.readinessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a readiness check every 10 seconds | -| runtime.readinessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| runtime.readinessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| runtime.replicaCount | int | `1` | | -| runtime.resources | object | `{}` | [resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for the container | -| runtime.securityContext.allowPrivilegeEscalation | bool | `false` | Controls [Privilege Escalation](https://kubernetes.io/docs/concepts/security/pod-security-policy/#privilege-escalation) enabling setuid binaries changing the effective user ID | -| runtime.securityContext.capabilities.add | list | `[]` | Specifies which capabilities to add to issue specialized syscalls | -| runtime.securityContext.capabilities.drop | list | `["ALL"]` | Specifies which capabilities to drop to reduce syscall attack surface | -| runtime.securityContext.readOnlyRootFilesystem | bool | `true` | Whether the root filesystem is mounted in read-only mode | -| runtime.securityContext.runAsNonRoot | bool | `true` | Requires the container to run without root privileges | -| runtime.securityContext.runAsUser | int | `10001` | The container's process will run with the specified uid | -| runtime.service.annotations | object | `{}` | | -| runtime.service.type | string | `"ClusterIP"` | [Service type](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) to expose the running application on a set of Pods as a network service. | -| runtime.ssi.miw.authorityId | string | `""` | The BPN of the issuer authority | -| runtime.ssi.miw.url | string | `""` | MIW URL | -| runtime.ssi.oauth.client.id | string | `""` | The client ID for Keycloak | -| runtime.ssi.oauth.client.secretAlias | string | `"client-secret"` | The alias under which the client secret is stored in the vault. | -| runtime.ssi.oauth.tokenurl | string | `""` | The URL (of Keycloak), where access tokens can be obtained | -| runtime.tolerations | list | `[]` | | -| runtime.url.protocol | string | `""` | Explicitly declared url for reaching the dsp api (e.g. if ingresses not used) | -| runtime.url.public | string | `""` | | -| runtime.url.readiness | string | `""` | | -| runtime.volumeMounts | list | `[]` | declare where to mount [volumes](https://kubernetes.io/docs/concepts/storage/volumes/) into the container | -| runtime.volumes | list | `[]` | [volume](https://kubernetes.io/docs/concepts/storage/volumes/) directories | -| serviceAccount.annotations | object | `{}` | | -| serviceAccount.create | bool | `true` | | -| serviceAccount.imagePullSecrets | list | `[]` | Existing image pull secret bound to the service account to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry) | -| serviceAccount.name | string | `""` | | -| tests | object | `{"hookDeletePolicy":"before-hook-creation,hook-succeeded"}` | Configurations for Helm tests | -| tests.hookDeletePolicy | string | `"before-hook-creation,hook-succeeded"` | Configure the hook-delete-policy for Helm tests | -| vault.secretNames.transferProxyTokenEncryptionAesKey | string | `"transfer-proxy-token-encryption-aes-key"` | | -| vault.secrets | string | `""` | | -| vault.server.postStart | string | `""` | | - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.10.0](https://github.com/norwoodj/helm-docs/releases/v1.10.0) diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/charts/tractusx-connector/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/charts/tractusx-connector/README.md deleted file mode 100644 index 327aa89763d..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/charts/tractusx-connector/README.md +++ /dev/null @@ -1,278 +0,0 @@ -# tractusx-connector - -![Version: 0.5.0](https://img.shields.io/badge/Version-0.5.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.5.0](https://img.shields.io/badge/AppVersion-0.5.0-informational?style=flat-square) - -A Helm chart for Tractus-X Eclipse Data Space Connector. The connector deployment consists of two runtime consists of a -Control Plane and a Data Plane. Note that _no_ external dependencies such as a PostgreSQL database and HashiCorp Vault are included. - -This chart is intended for use with an _existing_ PostgreSQL database and an _existing_ HashiCorp Vault. - -**Homepage:** - -## Setting up SSI - -### Preconditions - -- the [Managed Identity Walled (MIW)](https://github.com/catenax-ng/tx-managed-identity-wallets) must be running and reachable via network -- the necessary set of VerifiableCredentials for this participant must be pushed to MIW. This is typically done by the - Portal during participant onboarding -- Keycloak must be running and reachable via network -- an account with Keycloak must be created for this BPN and the connector must be able to obtain access tokens -- the client ID and client secret corresponding to that account must be known - -### Preparatory work - -- store your Keycloak client secret in the HashiCorp vault. The exact procedure will depend on your deployment of HashiCorp Vault and - is out of scope of this document. But by default, Tractus-X EDC expects to find the secret under `secret/client-secret`. - -### Configure the chart - -Be sure to provide the following configuration entries to your Tractus-X EDC Helm chart: - -- `controlplane.ssi.miw.url`: the URL -- `controlplane.ssi.miw.authorityId`: the BPN of the issuer authority -- `controlplane.ssi.oauth.tokenurl`: the URL (of Keycloak), where access tokens can be obtained -- `controlplane.ssi.oauth.client.id`: client ID for Keycloak -- `controlplane.ssi.oauth.client.secretAlias`: the alias under which the client secret is stored in the vault. Defaults to `client-secret`. - -### Launching the application - -As an easy starting point, please consider using [this example configuration](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-tests/deployment/src/main/resources/helm/tractusx-connector-test.yaml) -to launch the application. The configuration values mentioned above (`controlplane.ssi.*`) will have to be adapted manually. -Combined, run this shell command to start the in-memory Tractus-X EDC runtime: - -```shell -helm repo add tractusx-edc https://eclipse-tractusx.github.io/charts/dev -helm install my-release tractusx-edc/tractusx-connector --version 0.5.0 \ - -f /tractusx-connector-test.yaml -``` - -## Source Code - -- - -## Requirements - -| Repository | Name | Version | -|------------|------|---------| -| | postgresql(postgresql) | 12.1.6 | -| | vault(vault) | 0.20.0 | - -## Values - -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| backendService.httpProxyTokenReceiverUrl | string | `""` | | -| controlplane.affinity | object | `{}` | | -| controlplane.autoscaling.enabled | bool | `false` | Enables [horizontal pod autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) | -| controlplane.autoscaling.maxReplicas | int | `100` | Maximum replicas if resource consumption exceeds resource threshholds | -| controlplane.autoscaling.minReplicas | int | `1` | Minimal replicas if resource consumption falls below resource threshholds | -| controlplane.autoscaling.targetCPUUtilizationPercentage | int | `80` | targetAverageUtilization of cpu provided to a pod | -| controlplane.autoscaling.targetMemoryUtilizationPercentage | int | `80` | targetAverageUtilization of memory provided to a pod | -| controlplane.businessPartnerValidation.log.agreementValidation | bool | `true` | | -| controlplane.debug.enabled | bool | `false` | | -| controlplane.debug.port | int | `1044` | | -| controlplane.debug.suspendOnStart | bool | `false` | | -| controlplane.endpoints | object | `{"control":{"path":"/control","port":8083},"default":{"path":"/api","port":8080},"management":{"authKey":"","path":"/management","port":8081},"metrics":{"path":"/metrics","port":9090},"protocol":{"path":"/api/v1/dsp","port":8084}}` | endpoints of the control plane | -| controlplane.endpoints.control | object | `{"path":"/control","port":8083}` | control api, used for internal control calls. can be added to the internal ingress, but should probably not | -| controlplane.endpoints.control.path | string | `"/control"` | path for incoming api calls | -| controlplane.endpoints.control.port | int | `8083` | port for incoming api calls | -| controlplane.endpoints.default | object | `{"path":"/api","port":8080}` | default api for health checks, should not be added to any ingress | -| controlplane.endpoints.default.path | string | `"/api"` | path for incoming api calls | -| controlplane.endpoints.default.port | int | `8080` | port for incoming api calls | -| controlplane.endpoints.management | object | `{"authKey":"","path":"/management","port":8081}` | data management api, used by internal users, can be added to an ingress and must not be internet facing | -| controlplane.endpoints.management.authKey | string | `""` | authentication key, must be attached to each 'X-Api-Key' request header | -| controlplane.endpoints.management.path | string | `"/management"` | path for incoming api calls | -| controlplane.endpoints.management.port | int | `8081` | port for incoming api calls | -| controlplane.endpoints.metrics | object | `{"path":"/metrics","port":9090}` | metrics api, used for application metrics, must not be internet facing | -| controlplane.endpoints.metrics.path | string | `"/metrics"` | path for incoming api calls | -| controlplane.endpoints.metrics.port | int | `9090` | port for incoming api calls | -| controlplane.endpoints.protocol | object | `{"path":"/api/v1/dsp","port":8084}` | dsp api, used for inter connector communication and must be internet facing | -| controlplane.endpoints.protocol.path | string | `"/api/v1/dsp"` | path for incoming api calls | -| controlplane.endpoints.protocol.port | int | `8084` | port for incoming api calls | -| controlplane.env | object | `{}` | | -| controlplane.envConfigMapNames | list | `[]` | | -| controlplane.envSecretNames | list | `[]` | | -| controlplane.envValueFrom | object | `{}` | | -| controlplane.image.pullPolicy | string | `"IfNotPresent"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy) to use | -| controlplane.image.repository | string | `""` | Which derivate of the control plane to use. when left empty the deployment will select the correct image automatically | -| controlplane.image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion | -| controlplane.ingresses[0].annotations | object | `{}` | Additional ingress annotations to add | -| controlplane.ingresses[0].certManager.clusterIssuer | string | `""` | If preset enables certificate generation via cert-manager cluster-wide issuer | -| controlplane.ingresses[0].certManager.issuer | string | `""` | If preset enables certificate generation via cert-manager namespace scoped issuer | -| controlplane.ingresses[0].className | string | `""` | Defines the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use | -| controlplane.ingresses[0].enabled | bool | `false` | | -| controlplane.ingresses[0].endpoints | list | `["protocol"]` | EDC endpoints exposed by this ingress resource | -| controlplane.ingresses[0].hostname | string | `"edc-control.local"` | The hostname to be used to precisely map incoming traffic onto the underlying network service | -| controlplane.ingresses[0].tls | object | `{"enabled":false,"secretName":""}` | TLS [tls class](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) applied to the ingress resource | -| controlplane.ingresses[0].tls.enabled | bool | `false` | Enables TLS on the ingress resource | -| controlplane.ingresses[0].tls.secretName | string | `""` | If present overwrites the default secret name | -| controlplane.ingresses[1].annotations | object | `{}` | Additional ingress annotations to add | -| controlplane.ingresses[1].certManager.clusterIssuer | string | `""` | If preset enables certificate generation via cert-manager cluster-wide issuer | -| controlplane.ingresses[1].certManager.issuer | string | `""` | If preset enables certificate generation via cert-manager namespace scoped issuer | -| controlplane.ingresses[1].className | string | `""` | Defines the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use | -| controlplane.ingresses[1].enabled | bool | `false` | | -| controlplane.ingresses[1].endpoints | list | `["management","control"]` | EDC endpoints exposed by this ingress resource | -| controlplane.ingresses[1].hostname | string | `"edc-control.intranet"` | The hostname to be used to precisely map incoming traffic onto the underlying network service | -| controlplane.ingresses[1].tls | object | `{"enabled":false,"secretName":""}` | TLS [tls class](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) applied to the ingress resource | -| controlplane.ingresses[1].tls.enabled | bool | `false` | Enables TLS on the ingress resource | -| controlplane.ingresses[1].tls.secretName | string | `""` | If present overwrites the default secret name | -| controlplane.initContainers | list | `[]` | | -| controlplane.livenessProbe.enabled | bool | `true` | Whether to enable kubernetes [liveness-probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| controlplane.livenessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| controlplane.livenessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first liveness check | -| controlplane.livenessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a liveness check every 10 seconds | -| controlplane.livenessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| controlplane.livenessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| controlplane.logging | string | `".level=INFO\norg.eclipse.edc.level=ALL\nhandlers=java.util.logging.ConsoleHandler\njava.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter\njava.util.logging.ConsoleHandler.level=ALL\njava.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n"` | configuration of the [Java Util Logging Facade](https://docs.oracle.com/javase/7/docs/technotes/guides/logging/overview.html) | -| controlplane.nodeSelector | object | `{}` | | -| controlplane.opentelemetry | string | `"otel.javaagent.enabled=false\notel.javaagent.debug=false"` | configuration of the [Open Telemetry Agent](https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/) to collect and expose metrics | -| controlplane.podAnnotations | object | `{}` | additional annotations for the pod | -| controlplane.podLabels | object | `{}` | additional labels for the pod | -| controlplane.podSecurityContext | object | `{"fsGroup":10001,"runAsGroup":10001,"runAsUser":10001,"seccompProfile":{"type":"RuntimeDefault"}}` | The [pod security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod) defines privilege and access control settings for a Pod within the deployment | -| controlplane.podSecurityContext.fsGroup | int | `10001` | The owner for volumes and any files created within volumes will belong to this guid | -| controlplane.podSecurityContext.runAsGroup | int | `10001` | Processes within a pod will belong to this guid | -| controlplane.podSecurityContext.runAsUser | int | `10001` | Runs all processes within a pod with a special uid | -| controlplane.podSecurityContext.seccompProfile.type | string | `"RuntimeDefault"` | Restrict a Container's Syscalls with seccomp | -| controlplane.readinessProbe.enabled | bool | `true` | Whether to enable kubernetes [readiness-probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| controlplane.readinessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| controlplane.readinessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first readiness check | -| controlplane.readinessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a readiness check every 10 seconds | -| controlplane.readinessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| controlplane.readinessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| controlplane.replicaCount | int | `1` | | -| controlplane.resources | object | `{}` | [resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for the container | -| controlplane.securityContext.allowPrivilegeEscalation | bool | `false` | Controls [Privilege Escalation](https://kubernetes.io/docs/concepts/security/pod-security-policy/#privilege-escalation) enabling setuid binaries changing the effective user ID | -| controlplane.securityContext.capabilities.add | list | `[]` | Specifies which capabilities to add to issue specialized syscalls | -| controlplane.securityContext.capabilities.drop | list | `["ALL"]` | Specifies which capabilities to drop to reduce syscall attack surface | -| controlplane.securityContext.readOnlyRootFilesystem | bool | `true` | Whether the root filesystem is mounted in read-only mode | -| controlplane.securityContext.runAsNonRoot | bool | `true` | Requires the container to run without root privileges | -| controlplane.securityContext.runAsUser | int | `10001` | The container's process will run with the specified uid | -| controlplane.service.annotations | object | `{}` | | -| controlplane.service.type | string | `"ClusterIP"` | [Service type](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) to expose the running application on a set of Pods as a network service. | -| controlplane.ssi.miw.authorityId | string | `""` | The BPN of the issuer authority | -| controlplane.ssi.miw.url | string | `""` | MIW URL | -| controlplane.ssi.oauth.client.id | string | `""` | The client ID for Keycloak | -| controlplane.ssi.oauth.client.secretAlias | string | `"client-secret"` | The alias under which the client secret is stored in the vault. | -| controlplane.ssi.oauth.tokenurl | string | `""` | The URL (of Keycloak), where access tokens can be obtained | -| controlplane.tolerations | list | `[]` | | -| controlplane.url.protocol | string | `""` | Explicitly declared url for reaching the dsp api (e.g. if ingresses not used) | -| controlplane.volumeMounts | list | `[]` | declare where to mount [volumes](https://kubernetes.io/docs/concepts/storage/volumes/) into the container | -| controlplane.volumes | list | `[]` | [volume](https://kubernetes.io/docs/concepts/storage/volumes/) directories | -| customLabels | object | `{}` | To add some custom labels | -| dataplane.affinity | object | `{}` | | -| dataplane.autoscaling.enabled | bool | `false` | Enables [horizontal pod autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) | -| dataplane.autoscaling.maxReplicas | int | `100` | Maximum replicas if resource consumption exceeds resource threshholds | -| dataplane.autoscaling.minReplicas | int | `1` | Minimal replicas if resource consumption falls below resource threshholds | -| dataplane.autoscaling.targetCPUUtilizationPercentage | int | `80` | targetAverageUtilization of cpu provided to a pod | -| dataplane.autoscaling.targetMemoryUtilizationPercentage | int | `80` | targetAverageUtilization of memory provided to a pod | -| dataplane.aws.accessKeyId | string | `""` | | -| dataplane.aws.endpointOverride | string | `""` | | -| dataplane.aws.secretAccessKey | string | `""` | | -| dataplane.debug.enabled | bool | `false` | | -| dataplane.debug.port | int | `1044` | | -| dataplane.debug.suspendOnStart | bool | `false` | | -| dataplane.endpoints.control.path | string | `"/api/dataplane/control"` | | -| dataplane.endpoints.control.port | int | `8083` | | -| dataplane.endpoints.default.path | string | `"/api"` | | -| dataplane.endpoints.default.port | int | `8080` | | -| dataplane.endpoints.metrics.path | string | `"/metrics"` | | -| dataplane.endpoints.metrics.port | int | `9090` | | -| dataplane.endpoints.proxy.path | string | `"/proxy"` | | -| dataplane.endpoints.proxy.port | int | `8186` | | -| dataplane.endpoints.public.path | string | `"/api/public"` | | -| dataplane.endpoints.public.port | int | `8081` | | -| dataplane.env | object | `{}` | | -| dataplane.envConfigMapNames | list | `[]` | | -| dataplane.envSecretNames | list | `[]` | | -| dataplane.envValueFrom | object | `{}` | | -| dataplane.image.pullPolicy | string | `"IfNotPresent"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy) to use | -| dataplane.image.repository | string | `""` | Which derivate of the data plane to use. when left empty the deployment will select the correct image automatically | -| dataplane.image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion | -| dataplane.ingresses[0].annotations | object | `{}` | Additional ingress annotations to add | -| dataplane.ingresses[0].certManager.clusterIssuer | string | `""` | If preset enables certificate generation via cert-manager cluster-wide issuer | -| dataplane.ingresses[0].certManager.issuer | string | `""` | If preset enables certificate generation via cert-manager namespace scoped issuer | -| dataplane.ingresses[0].className | string | `""` | Defines the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use | -| dataplane.ingresses[0].enabled | bool | `false` | | -| dataplane.ingresses[0].endpoints | list | `["public"]` | EDC endpoints exposed by this ingress resource | -| dataplane.ingresses[0].hostname | string | `"edc-data.local"` | The hostname to be used to precisely map incoming traffic onto the underlying network service | -| dataplane.ingresses[0].tls | object | `{"enabled":false,"secretName":""}` | TLS [tls class](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) applied to the ingress resource | -| dataplane.ingresses[0].tls.enabled | bool | `false` | Enables TLS on the ingress resource | -| dataplane.ingresses[0].tls.secretName | string | `""` | If present overwrites the default secret name | -| dataplane.initContainers | list | `[]` | | -| dataplane.livenessProbe.enabled | bool | `true` | Whether to enable kubernetes [liveness-probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| dataplane.livenessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| dataplane.livenessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first liveness check | -| dataplane.livenessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a liveness check every 10 seconds | -| dataplane.livenessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| dataplane.livenessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| dataplane.logging | string | `".level=INFO\norg.eclipse.edc.level=ALL\nhandlers=java.util.logging.ConsoleHandler\njava.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter\njava.util.logging.ConsoleHandler.level=ALL\njava.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n"` | configuration of the [Java Util Logging Facade](https://docs.oracle.com/javase/7/docs/technotes/guides/logging/overview.html) | -| dataplane.nodeSelector | object | `{}` | | -| dataplane.opentelemetry | string | `"otel.javaagent.enabled=false\notel.javaagent.debug=false"` | configuration of the [Open Telemetry Agent](https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/) to collect and expose metrics | -| dataplane.podAnnotations | object | `{}` | additional annotations for the pod | -| dataplane.podLabels | object | `{}` | additional labels for the pod | -| dataplane.podSecurityContext | object | `{"fsGroup":10001,"runAsGroup":10001,"runAsUser":10001,"seccompProfile":{"type":"RuntimeDefault"}}` | The [pod security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod) defines privilege and access control settings for a Pod within the deployment | -| dataplane.podSecurityContext.fsGroup | int | `10001` | The owner for volumes and any files created within volumes will belong to this guid | -| dataplane.podSecurityContext.runAsGroup | int | `10001` | Processes within a pod will belong to this guid | -| dataplane.podSecurityContext.runAsUser | int | `10001` | Runs all processes within a pod with a special uid | -| dataplane.podSecurityContext.seccompProfile.type | string | `"RuntimeDefault"` | Restrict a Container's Syscalls with seccomp | -| dataplane.readinessProbe.enabled | bool | `true` | Whether to enable kubernetes [readiness-probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| dataplane.readinessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| dataplane.readinessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first readiness check | -| dataplane.readinessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a liveness check every 10 seconds | -| dataplane.readinessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| dataplane.readinessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| dataplane.replicaCount | int | `1` | | -| dataplane.resources | object | `{}` | [resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for the container | -| dataplane.securityContext.allowPrivilegeEscalation | bool | `false` | Controls [Privilege Escalation](https://kubernetes.io/docs/concepts/security/pod-security-policy/#privilege-escalation) enabling setuid binaries changing the effective user ID | -| dataplane.securityContext.capabilities.add | list | `[]` | Specifies which capabilities to add to issue specialized syscalls | -| dataplane.securityContext.capabilities.drop | list | `["ALL"]` | Specifies which capabilities to drop to reduce syscall attack surface | -| dataplane.securityContext.readOnlyRootFilesystem | bool | `true` | Whether the root filesystem is mounted in read-only mode | -| dataplane.securityContext.runAsNonRoot | bool | `true` | Requires the container to run without root privileges | -| dataplane.securityContext.runAsUser | int | `10001` | The container's process will run with the specified uid | -| dataplane.service.port | int | `80` | | -| dataplane.service.type | string | `"ClusterIP"` | [Service type](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) to expose the running application on a set of Pods as a network service. | -| dataplane.tolerations | list | `[]` | | -| dataplane.url.public | string | `""` | Explicitly declared url for reaching the public api (e.g. if ingresses not used) | -| dataplane.volumeMounts | list | `[]` | declare where to mount [volumes](https://kubernetes.io/docs/concepts/storage/volumes/) into the container | -| dataplane.volumes | list | `[]` | [volume](https://kubernetes.io/docs/concepts/storage/volumes/) directories | -| fullnameOverride | string | `""` | | -| imagePullSecrets | list | `[]` | Existing image pull secret to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry) | -| install.postgresql | bool | `true` | | -| install.vault | bool | `true` | | -| nameOverride | string | `""` | | -| networkPolicy.controlplane | object | `{"from":[{"namespaceSelector":{}}]}` | Configuration of the controlplane component | -| networkPolicy.controlplane.from | list | `[{"namespaceSelector":{}}]` | Specify from rule network policy for cp (defaults to all namespaces) | -| networkPolicy.dataplane | object | `{"from":[{"namespaceSelector":{}}]}` | Configuration of the dataplane component | -| networkPolicy.dataplane.from | list | `[{"namespaceSelector":{}}]` | Specify from rule network policy for dp (defaults to all namespaces) | -| networkPolicy.enabled | bool | `false` | If `true` network policy will be created to restrict access to control- and dataplane | -| participant.id | string | `""` | BPN Number | -| postgresql.auth.database | string | `"edc"` | | -| postgresql.auth.password | string | `"password"` | | -| postgresql.auth.username | string | `"user"` | | -| postgresql.jdbcUrl | string | `"jdbc:postgresql://{{ .Release.Name }}-postgresql:5432/edc"` | | -| postgresql.primary.persistence.enabled | bool | `false` | | -| postgresql.readReplicas.persistence.enabled | bool | `false` | | -| serviceAccount.annotations | object | `{}` | | -| serviceAccount.create | bool | `true` | | -| serviceAccount.imagePullSecrets | list | `[]` | Existing image pull secret bound to the service account to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry) | -| serviceAccount.name | string | `""` | | -| tests | object | `{"hookDeletePolicy":"before-hook-creation,hook-succeeded"}` | Configurations for Helm tests | -| tests.hookDeletePolicy | string | `"before-hook-creation,hook-succeeded"` | Configure the hook-delete-policy for Helm tests | -| vault.hashicorp.healthCheck.enabled | bool | `true` | | -| vault.hashicorp.healthCheck.standbyOk | bool | `true` | | -| vault.hashicorp.paths.health | string | `"/v1/sys/health"` | | -| vault.hashicorp.paths.secret | string | `"/v1/secret"` | | -| vault.hashicorp.timeout | int | `30` | | -| vault.hashicorp.token | string | `""` | | -| vault.hashicorp.url | string | `"http://{{ .Release.Name }}-vault:8200"` | | -| vault.injector.enabled | bool | `false` | | -| vault.secretNames.transferProxyTokenEncryptionAesKey | string | `"transfer-proxy-token-encryption-aes-key"` | | -| vault.secretNames.transferProxyTokenSignerPrivateKey | string | `nil` | | -| vault.secretNames.transferProxyTokenSignerPublicKey | string | `nil` | | -| vault.server.dev.devRootToken | string | `"root"` | | -| vault.server.dev.enabled | bool | `true` | | -| vault.server.postStart | string | `nil` | | - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.10.0](https://github.com/norwoodj/helm-docs/releases/v1.10.0) diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/core/edr-core/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/core/edr-core/README.md deleted file mode 100644 index aeb2e2402fa..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/core/edr-core/README.md +++ /dev/null @@ -1,26 +0,0 @@ -# EDR core extension - -This extension provide a base implementation of `EdrManager` and `EdrService` both -required for interacting with the EDR APIs and state machine - -The EDR state machine handle the lifecycle of a negotiated EDR. The negotiation request can be submitted -via EDR APIs, and it will go through two phases: - -- Contract Negotiation -- Transfer Request - -Once the latter has completed the EDR entry will be saved with the associated EDR in the primordial state `NEGOTIATED` -The state machine will also manage the lifecycle and the renewal of the `EDR`. If a token is about to expire it will -transition to the `REFRESHING` state and fire off another transfer process with the same parameter of the expiring -one. Once completed the new `EDR` will be cached and the old ones, with same `assetId` and `agreementId` will transition -into the `EXPIRED` state. Then the state machine will also monitor the `EXPIRED` ones, and will delete them according to the -retention configuration. - -## 1. EDR state machine Configuration - -| Key | Description | Mandatory | Default | -|:--------------------------------------------|:----------------------------------------------------------------------------------------------------|-----------|---------| -| edc.edr.state-machine.iteration-wait-millis | The iteration wait time in milliseconds in the edr state machine | | 1000 | -| edc.edr.state-machine.batch-size | The batch size in the edr negotiation state machine | | 20 | -| edc.edr.state-machine.expiring-duration | The minimum duration on which the EDR token can be eligible for renewal (seconds) | | 60 | -| edc.edr.state-machine.expired-retention | The minimum duration on with the EDR token can be eligible for deletion when it's expired (seconds) | | 60 | diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/README.md deleted file mode 100644 index d7bb35d84b8..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/README.md +++ /dev/null @@ -1,52 +0,0 @@ -# Tractus-X EDC - -The Tractus-X EDC repository creates runnable applications out of EDC extensions from -the [Eclipse DataSpace Connector](https://github.com/eclipse-edc/Connector) repository. - -When running a EDC connector from the Tractus-X EDC repository there are three setups to choose from. They only vary by -using different extensions for - -- Resolving of Connector-Identities -- Persistence of the Control-Plane-State -- Persistence of Secrets (Vault) - -## Connector Setup - -The three supported setups are. - -- Setup 1: Pure in Memory **Not intended for production use!** - - [Control Plane](../edc-controlplane/edc-runtime-memory/README.md) - - [IDS DAPS Extensions](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/iam/oauth2/daps) - - In Memory Persistence done by using no extension - - In Memory Keyvault with seedable secrets. - - [Data Plane](../edc-dataplane/edc-dataplane-azure-vault/README.md) - - [Azure Key Vault Extension](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/vault/azure-vault) -- Setup 2: PostgreSQL & Azure Vault - - [Control Plane](../edc-controlplane/edc-controlplane-postgresql-azure-vault/README.md) - - [IDS DAPS Extensions](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/iam/oauth2/daps) - - [PostgreSQL Persistence Extensions](https://github.com/eclipse-edc/Connector/tree/main/extensions/control-plane/store/sql) - - [Azure Key Vault Extension](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/vault/azure-vault) - - [Data Plane](../edc-dataplane/edc-dataplane-azure-vault/README.md) - - [Azure Key Vault Extension](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/vault/azure-vault) -- Setup 3: PostgreSQL & HashiCorp Vault - - [Control Plane](../edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/README.md) - - [IDS DAPS Extensions](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/iam/oauth2/daps) - - [PostgreSQL Persistence Extensions](https://github.com/eclipse-edc/Connector/tree/main/extensions/control-plane/store/sql) - - [Data Plane](../edc-dataplane/edc-dataplane-hashicorp-vault/README.md) - -## Recommended Documentation - -### This Repository - -- [Update EDC Version from 0.0.x - 0.1.x](migration/Version_0.0.x_0.1.x.md) -- [Application: Control Plane](../edc-controlplane) -- [Application: Data Plane](../edc-dataplane) -- [Extension: Business Partner Numbers](../edc-extensions/business-partner-validation/README.md) -- [Example: Local TXDC Setup](./samples/example-dataspace/README.md) -- [Example: Data Transfer](./samples/Transfer%20Data.md) - -### Eclipse Dataspace Connector - -- [EDC Domain Model](https://github.com/eclipse-edc/Connector/blob/main/docs/developer/architecture/domain-model.md) -- [EDC Open API Spec](https://github.com/eclipse-edc/Connector/blob/main/resources/openapi/openapi.yaml) -- [HTTP Receiver Extension](https://github.com/eclipse-edc/Connector/tree/main/extensions/control-plane/http-receiver) diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/Release.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/Release.md deleted file mode 100644 index 5f2fbd74daf..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/Release.md +++ /dev/null @@ -1,48 +0,0 @@ -# Release - -## Prerequisites - -[![Apache Maven][maven-shield]][maven-url] - -## Update DEPENDENCIES file - -### 1. Setup Eclipse Dash License Tool locally - -For instructions on how to download the Eclipse Dash Tool executable, refer to the -project's [GitHub page](https://github.com/eclipse/dash-licenses#get-it). - -### 2. Generate DEPENDENCIES file - -The following call generates the dependencies file. This list is populated by deriving dependencies using the build tool (i.e., -gradle), analysing them using an IP tool (i.e., Eclipse Dash Tool), and decorating the resulting report with additional -information using a custom script. - -Execute the gradle task `allDependencies` for creating an integrated dependency report over all sub-modules of the -project (including isolated modules). To process the dependencies of a specific module (e.g., an individual launcher) -execute the standard `dependencies` task. - -First, the dependencies of this module are calculated with gradle and passed to the Dash tool: - -```shell -gradle allDependencies | grep -Poh "(?<=\s)[\w.-]+:[\w.-]+:[^:\s]+" | sort | uniq | java -jar /path/org.eclipse.dash.licenses-0.0.1-SNAPSHOT.jar - -summary DEPENDENCIES -``` - -_Note: on some machines (e.g. macOS) [the ack tool](https://beyondgrep.com/install/) should be used instead of `grep`._ - -### 3. Resolve restricted Dependencies - -If a dependency is `restricted`, it is not approved by the Eclipse Foundation, yet. -The Eclipse Bot is able to approve dependencies automatically, if the license can be resolved by ClearlyDefined. - -1. (optional) Visit and harvest the dependency - from maven central. -2. Create the Eclipse IP Issues or ask an Eclipse Commiter to do this for you. - -## 4. Update OpenAPI docs - -As part of the [kits documentation provided for docusaurus](../kit/development-view/page00_development_view.md) we provide an OpenAPI reference. -This refers to the [EDC API](https://github.com/eclipse-edc/Connector/tree/main/resources/openapi) and needs to be updated to the current release. -The yaml files found there are then converted with the [docusaurus openapi plugin](https://www.npmjs.com/package/docusaurus-plugin-openapi-docs). - -[maven-shield]: https://img.shields.io/badge/Apache%20Maven-URL-blue -[maven-url]: https://maven.apache.org diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/coding-principles.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/coding-principles.md deleted file mode 100644 index 624186c4675..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/coding-principles.md +++ /dev/null @@ -1,138 +0,0 @@ -# Coding Principles and Style Guide - -## Fail-fast and Explicit Configuration - -1. Configuration should be loaded and validated at extension initialization so that issues are reported immediately. Do - not lazy-load configuration unless it is required to do so. -2. Settings can be pulled from the extension context and placed into configuration objects, which are passed to services - via their constructor. -3. Service configuration requirements should always be explicit; as a general rule, do not pass a single configuration - object with many values to multiple services. -4. Annotate configuration keys with `@Setting` so that they may be tracked. - -## Errors - -1. Do not throw checked exceptions; always use unchecked exceptions. If an unchecked exception type needs to be defined, - inherit from `org.eclipse.edc.spi.EdcException`. -2. Do not throw exceptions to signal a validation error; report the error (preferably collated) and return an error - response. -3. Throw an unchecked exception if something unexpected happens (e.g. a backing store connection is down after a number - of retries). Note that validation errors are expected. -4. Only throw an exception when there is no remediation possible, i.e. the exception is fatal. Do not throw an exception - if an operation can be retried. -5. Generally, services should return a `org.eclipse.edc.spi.result.Result` (or a suitable subclass). - -## Simplicity - -1. Avoid layers of indirection when they are not needed (e.g. "pass-through methods"). -2. Avoid needlessly wrapping objects, especially primitive datatypes. - -## General Coding Style - -1. Use `var` instead of explicit types (helps with clarity) -2. Avoid `final` in method args and local variables -3. Use `final` in field declarations -4. Avoid `static` fields except in constants or when absolutely necessary (you should be able to provide a reason). -5. Use interfaces to define shared constants -6. Use "minimally required types" (or "smallest possible API"), e.g. use `ObjectMapper` instead of `TypeManager`, or use - a `String` instead of a more complex object containing the String, etc. -7. Use either `public` members, which are documented and tested, or `private` members. -8. Avoid package-private members, especially if only needed for testing -9. Avoid `protected` members unless they're intended to be overridden. -10. Use package-private classes if they're not needed outside the package, e.g. implementation classes -11. Avoid using `enum`s for anything other than named integer enumerations. -12. Avoid using static classes as much as possible. Exceptions to this are helper functions and test utils, etc. as well - as static inner classes. -13. Use only camel case and no prefixes for naming. -14. Avoid unnecessary `this.` except when it is necessary e.g. when there is a name overlap -15. Use static imports, as long as code readability and comprehension is not impacted. For example, - - use `assertThat(...)` instead of `Assertions.assertThat(...)` - - use `format("...",arg1)` instead of `String.format(...)`, but - - avoid `of(item1, item2).map(it -> it.someOperation)...` instead of `Stream.of(item1, item2)`. - Also, avoid static imports if two static methods with the same name would be imported from different classes -16. Avoid `Optional` as method return type or method argument, except when designing a fluent API. Use `null` in - signatures. -17. Avoid cryptic variable names, especially in long methods. Instead, try to write them out, at least to a reasonable - extent. - -## Testing - -1. All handlers and services should have dedicated unit tests with mocks used for dependencies. -2. Prefer unit tests over all other test types: unit > integration/component > e2e -3. When appropriate, prefer composing services via the constructor so that dependencies can be mocked as opposed to - instantiating dependencies directly. -4. Use classes with static test functions to provide common helper methods, e.g. to instantiate an object. -5. Use `[METHOD]_when[CONDITION]_should[EXPECTATION]` as naming template for test methods, - e.g. `verifyInput_whenNull_shouldThrowNpe()` as opposed to `testInputNull()` - -## Data Objects - -1. Use the `Builder` pattern when: - - there are any number of optional constructor args - - there are more than 3 constructor args - - inheriting from an object that fulfills any of the above. In this case use derived builders as well. -2. Although serializability is not the reason we use the builder pattern, it is a strong indication that a builder - should be used. -3. Builders should be named just `Builder` and be static nested classes. -4. Create a `public static Builder newInstance(){...}` method to instantiate the builder -5. Builders have non-public constructors -6. Use single-field builders: a `Builder` instantiates the object it builds in its constructor, and sets the properties - in its builder methods. The `build()` method then only performs verification (optional) and returns the instance. -7. Use `private` constructors for the objects that the builder builds. -8. If there is a builder for an object, use it to deserialize an object, i.e. put Jackson annotations such - as `JsonCreator` and `@JsonBuilder` on builders. -9. Note that the motivation behind use of builders is not for immutability (although that may be good in certain - circumstances). Rather, it is to make code less error-prone and - simpler given the lack of named arguments and optional parameters in Java. - -## Secrets - -1. Only store secrets in the `Vault` and do not hold them in objects that may be persisted to other stores. -2. Do not log secrets or sensitive information. - -## Extensions and Libraries - -1. Extension modules contribute a feature to the runtime such as a service. -2. SPI modules define extensibility points in the runtime. There is a core SPI module that defines extensibility for - essential runtime features. There are other SPI modules that - define extensibility points for optional features such as IDS. -3. Libraries are utility modules that provide classes which may be used by other modules. They do not directly - contribute features to the runtime. -4. An SPI module may only reference other SPI modules and library modules. -5. An Extension module may only reference other SPI modules and library modules. -6. A library module may only reference other library modules. - -## Build - -1. There should only be a root `gradle.properties` that contains build variables. Do not create separate - `gradle.properties` files in a module. -2. For external dependencies, do not reference the version directly. Instead, use - the version catalog feature. - -## Handling Null Return Values - -1. In certain situations, `null` may need to be returned from a method, passed as a parameter, or set on a field. Only - use `Optional` if a method is part of a fluent API. - Since the runtime will rarely require this, the project standard is to use the `org.jetbrains.annotations.Nullable` - and `org.jetbrains.annotations.NotNull` annotations. - -## Objects Serialization/Deserialization - -1. `TypeManager` is the component responsible for json ser/des, you can also use the `ObjectMapper` inside it, but there - should be no other `ObjectMapper` instance. - -## Class Naming - -1. A single implementor of an interface should be named `Impl`. -2. An implementor who is meant to be the default implementation for an interface but other are/can be defined used - instead. - -## Observability - -Services can implement one the following interfaces: `ReadinessProvider`, `LivenessProvider`, `StartupStatusProvider` -and register with the `HealthCheckService`, thus reporting the service's readiness status through the observability API. - -## Streams - -1. Always close explicitly `Stream` objects that are returned by a service/store, since they could carry a connection, - which otherwise would leak. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/postman/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/postman/README.md deleted file mode 100644 index f4a7d2b24a5..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/postman/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# Postman Collection - -## Prerequisites - -[![Postman][postman-shield]][postman-url] - -## Postman - -The Postman app can be used to send and receive EDC messages. - -### Install/Download Postman - -please visit - -### Import Postman collection - -please visit - -## Collection - -The postman collection contains the most common API calls. Please note that the - -- Policy & Negotiation calls come in pairs for the different kinds of policies -- the 'Data' call only works when using the All-In-One Deployment of this repository - -![screenshot](./images/screenshot.png) - -[postman-shield]: https://img.shields.io/badge/Postman-URL-orange -[postman-url]: https://www.postman.com diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/postman/collection.json b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/postman/collection.json deleted file mode 100644 index f88bdf5c7f9..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/postman/collection.json +++ /dev/null @@ -1,906 +0,0 @@ -{ - "info": { - "_postman_id": "7d19adf4-a13c-4c0d-abea-f9e0bebbffb6", - "name": "tractusx-edc_dsp", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "_exporter_id": "6134257" - }, - "item": [ - { - "name": "Create Asset", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Status code is 201\", function () {", - " pm.response.to.have.status(201);", - "});" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"@context\": {},\n \"asset\": {\n \"@type\": \"Asset\",\n \"@id\": \"{{ASSET_ID}}\", \n \"properties\": {\n \"description\": \"Product EDC Demo Asset\"\n }\n },\n \"dataAddress\": {\n \"@type\": \"DataAddress\",\n \"type\": \"HttpData\",\n \"baseUrl\": \"https://jsonplaceholder.typicode.com/todos\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/assets", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "assets" - ] - } - }, - "response": [] - }, - { - "name": "Get all Assets", - "request": { - "method": "POST", - "header": [], - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/assets/request", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "assets", - "request" - ] - } - }, - "response": [] - }, - { - "name": "Get Asset by ID", - "request": { - "method": "GET", - "header": [], - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/assets/{{ASSET_ID}}", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "assets", - "{{ASSET_ID}}" - ] - } - }, - "response": [] - }, - { - "name": "Delete Asset by ID", - "request": { - "method": "DELETE", - "header": [], - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/assets/{{ASSET_ID}}", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "assets", - "{{ASSET_ID}}" - ] - } - }, - "response": [] - }, - { - "name": "Create Policy", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"@context\": {\n \"odrl\": \"http://www.w3.org/ns/odrl/2/\"\n },\n \"@type\": \"PolicyDefinitionRequestDto\",\n \"@id\": \"{{POLICY_ID}}\",\n \"policy\": {\n\t\t\"@type\": \"Policy\",\n\t\t\"odrl:permission\" : [{\n\t\t\t\"odrl:action\" : \"USE\",\n\t\t\t\"odrl:constraint\" : {\n\t\t\t\t\"@type\": \"LogicalConstraint\",\n\t\t\t\t\"odrl:or\" : [{\n\t\t\t\t\t\"@type\" : \"Constraint\",\n\t\t\t\t\t\"odrl:leftOperand\" : \"BusinessPartnerNumber\",\n\t\t\t\t\t\"odrl:operator\" : {\n \"@id\": \"odrl:eq\"\n },\n\t\t\t\t\t\"odrl:rightOperand\" : \"{{POLICY_BPN}}\"\n\t\t\t\t}]\n\t\t\t}\n\t\t}]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/policydefinitions", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "policydefinitions" - ] - } - }, - "response": [] - }, - { - "name": "Get Policy by ID", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"{{POLICY_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"constraints\": []\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/policydefinitions/{{POLICY_ID}}", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "policydefinitions", - "{{POLICY_ID}}" - ] - } - }, - "response": [] - }, - { - "name": "Get all Policies", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"@context\": {\n \"odrl\": \"http://www.w3.org/ns/odrl/2/\"\n },\n \"id\": \"{{POLICY_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"constraints\": []\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/policydefinitions/request", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "policydefinitions", - "request" - ] - } - }, - "response": [] - }, - { - "name": "Delte Policy by ID", - "request": { - "method": "DELETE", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"{{POLICY_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"constraints\": []\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/policydefinitions/{{POLICY_ID}}", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "policydefinitions", - "{{POLICY_ID}}" - ] - } - }, - "response": [] - }, - { - "name": "Create Contract Definitiion", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"@context\": {},\n \"@id\": \"{{CONTRACT_DEFINITION_ID}}\",\n \"@type\": \"ContractDefinition\",\n \"accessPolicyId\": \"{{ACCESS_POLICY_ID}}\",\n \"contractPolicyId\": \"{{CONTRACT_POLICY_ID}}\",\n \"assetsSelector\" : {\n \"@type\" : \"CriterionDto\",\n \"operandLeft\": \"{{EDC_NAMESPACE}}id\",\n \"operator\": \"=\",\n \"operandRight\": \"{{ASSET_ID}}\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/contractdefinitions", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "contractdefinitions" - ] - } - }, - "response": [] - }, - { - "name": "Get Contract Definition by ID", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"{{POLICY_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"constraints\": []\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/contractdefinitions/{{CONTRACT_DEFINITION_ID}}", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "contractdefinitions", - "{{CONTRACT_DEFINITION_ID}}" - ] - } - }, - "response": [] - }, - { - "name": "Get all Contract Definitiions", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/contractdefinitions/request", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "contractdefinitions", - "request" - ] - } - }, - "response": [] - }, - { - "name": "Delte Contract Definition", - "request": { - "method": "DELETE", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"{{POLICY_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"constraints\": []\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/contractdefinitions/{{CONTRACT_DEFINITION_ID}}", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "contractdefinitions", - "{{CONTRACT_DEFINITION_ID}}" - ] - } - }, - "response": [] - }, - { - "name": "Query Catalog", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"@context\": {},\r\n \"protocol\": \"dataspace-protocol-http\",\r\n \"providerUrl\": \"{{PROVIDER_PROTOCOL_URL}}\",\r\n \"querySpec\": {\r\n \"offset\": 0,\r\n \"limit\": 100,\r\n \"filter\": \"\",\r\n \"range\": {\r\n \"from\": 0,\r\n \"to\": 100\r\n },\r\n \"sortField\": \"\",\r\n \"criterion\": \"\"\r\n }\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/catalog/request", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "catalog", - "request" - ] - } - }, - "response": [] - }, - { - "name": "Initiate Negotation", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Body matches string\", function () {", - " var jsonData = pm.response.json();", - " pm.collectionVariables.set(\"NEGOTIATION_ID\", jsonData.id);", - "", - "});" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n\t\"@context\": {\n\t\t\"odrl\": \"http://www.w3.org/ns/odrl/2/\"\n\t},\n\t\"@type\": \"NegotiationInitiateRequestDto\",\n\t\"connectorAddress\": \"{{PROVIDER_PROTOCOL_URL}}\",\n\t\"protocol\": \"dataspace-protocol-http\",\n\t\"connectorId\": \"{{PROVIDER_ID}}\",\n\t\"providerId\": \"{{PROVIDER_ID}}\",\n\t\"offer\": {\n\t\t\"offerId\": \"1:1:46483724-18f1-4dff-87da-f26725dcc59c\",\n\t\t\"assetId\": \"{{ASSET_ID}}\",\n\t\t\"policy\": {\n\t\t\t\"@type\": \"odrl:Set\",\n\t\t\t\"odrl:permission\": {\n\t\t\t\t\"odrl:target\": \"{{ASSET_ID}}\",\n\t\t\t\t\"odrl:action\": {\n\t\t\t\t\t\"odrl:type\": \"USE\"\n\t\t\t\t},\n\t\t\t\t\"odrl:constraint\": {\n\t\t\t\t\t\"odrl:or\": {\n\t\t\t\t\t\t\"odrl:leftOperand\": \"BusinessPartnerNumber\",\n\t\t\t\t\t\t\"odrl:operator\": {\n \"@id\": \"odrl:eq\"\n },\n\t\t\t\t\t\t\"odrl:rightOperand\": \"{{POLICY_BPN}}\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"odrl:prohibition\": [],\n\t\t\t\"odrl:obligation\": [],\n\t\t\t\"odrl:target\": \"{{ASSET_ID}}\"\n\t\t}\n\t}\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/contractnegotiations", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "contractnegotiations" - ] - } - }, - "response": [] - }, - { - "name": "Get all Negotations", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript" - } - }, - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "POST", - "header": [], - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/contractnegotiations/request", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "contractnegotiations", - "request" - ] - } - }, - "response": [] - }, - { - "name": "Cancel Negotation by ID", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript" - } - }, - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "POST", - "header": [], - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/contractnegotiations/7cff6ecb-7e5e-40b8-b101-eba3f2045b1f/cancel", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "contractnegotiations", - "7cff6ecb-7e5e-40b8-b101-eba3f2045b1f", - "cancel" - ] - } - }, - "response": [] - }, - { - "name": "Initiate Transfer", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "pm.collectionVariables.set(\"TRANSFER_ID\", Math.random());" - ], - "type": "text/javascript" - } - }, - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Body matches string\", function () {", - " var jsonData = pm.response.json();", - " pm.collectionVariables.set(\"TRANSFER_PROCESS_ID\", jsonData.id);", - "});" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"@context\": {\n \"odrl\": \"http://www.w3.org/ns/odrl/2/\"\n },\n \"assetId\": \"{{ASSET_ID}}\",\n \"connectorAddress\": \"{{PROVIDER_PROTOCOL_URL}}\",\n \"contractId\": \"\",\n \"dataDestination\": {\n \"properties\": {\n \"type\": \"HttpProxy\"\n }\n },\n \"managedResources\": false,\n \"privateProperties\": {\n \"receiverHttpEndpoint\": \"{{BACKEND_SERVICE}}\"\n },\n \"protocol\": \"dataspace-protocol-http\",\n \"transferType\": {\n \"contentType\": \"application/octet-stream\",\n \"isFinite\": true\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/transferprocesses", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "transferprocesses" - ] - } - }, - "response": [] - }, - { - "name": "Get Transfer by ID", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript" - } - }, - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "GET", - "header": [], - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/transferprocesses/8e428b80-46a5-4325-87e5-592518f7666b", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "transferprocesses", - "8e428b80-46a5-4325-87e5-592518f7666b" - ] - } - }, - "response": [] - }, - { - "name": "Get all Transfers", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript" - } - }, - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/transferprocesses/request", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "transferprocesses", - "request" - ] - } - }, - "response": [] - }, - { - "name": "Initiate EDR Negotation", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Body matches string\", function () {", - " var jsonData = pm.response.json();", - " pm.collectionVariables.set(\"NEGOTIATION_ID\", jsonData.id);", - "", - "});" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n\t\"@context\": {\n\t\t\"odrl\": \"http://www.w3.org/ns/odrl/2/\"\n\t},\n\t\"@type\": \"NegotiationInitiateRequestDto\",\n\t\"connectorAddress\": \"{{PROVIDER_PROTOCOL_URL}}\",\n\t\"protocol\": \"dataspace-protocol-http\",\n\t\"connectorId\": \"{{PROVIDER_ID}}\",\n\t\"providerId\": \"{{PROVIDER_ID}}\",\n\t\"offer\": {\n\t\t\"offerId\": \"1:1:9f9375e3-ed28-449a-8a98-a340f4c20c26\",\n\t\t\"assetId\": \"{{ASSET_ID}}\",\n\t\t\"policy\": {\n\t\t\t\"@type\": \"odrl:Set\",\n\t\t\t\"odrl:permission\": {\n\t\t\t\t\"odrl:target\": \"{{ASSET_ID}}\",\n\t\t\t\t\"odrl:action\": {\n\t\t\t\t\t\"odrl:type\": \"USE\"\n\t\t\t\t},\n\t\t\t\t\"odrl:constraint\": {\n\t\t\t\t\t\"odrl:or\": {\n\t\t\t\t\t\t\"odrl:leftOperand\": \"BusinessPartnerNumber\",\n\t\t\t\t\t\t\"odrl:operator\": \"EQ\",\n\t\t\t\t\t\t\"odrl:rightOperand\": \"{{POLICY_BPN}}\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"odrl:prohibition\": [],\n\t\t\t\"odrl:obligation\": [],\n\t\t\t\"odrl:target\": \"{{ASSET_ID}}\"\n\t\t}\n\t}\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{CONSUMER_ADAPTER_URL}}/edrs", - "host": [ - "{{CONSUMER_ADAPTER_URL}}" - ], - "path": [ - "edrs" - ] - } - }, - "response": [] - }, - { - "name": "Query EDRs Cached", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Body matches string\", function () {", - " var jsonData = pm.response.json();", - " pm.collectionVariables.set(\"NEGOTIATION_ID\", jsonData.id);", - "", - "});" - ], - "type": "text/javascript" - } - } - ], - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{CONSUMER_ADAPTER_URL}}/edrs?assetId={{ASSET_ID}}", - "host": [ - "{{CONSUMER_ADAPTER_URL}}" - ], - "path": [ - "edrs" - ], - "query": [ - { - "key": "assetId", - "value": "{{ASSET_ID}}" - } - ] - } - }, - "response": [] - }, - { - "name": "Get EDR by tp ID", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Body matches string\", function () {", - " var jsonData = pm.response.json();", - " pm.collectionVariables.set(\"NEGOTIATION_ID\", jsonData.id);", - "", - "});" - ], - "type": "text/javascript" - } - } - ], - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{CONSUMER_ADAPTER_URL}}/edrs/4b383155-9147-4912-819e-6172b4a3eb02", - "host": [ - "{{CONSUMER_ADAPTER_URL}}" - ], - "path": [ - "edrs", - "4b383155-9147-4912-819e-6172b4a3eb02" - ] - } - }, - "response": [] - }, - { - "name": "Get Asset Data with proxy", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Body matches string\", function () {", - " var jsonData = pm.response.json();", - " pm.collectionVariables.set(\"NEGOTIATION_ID\", jsonData.id);", - "", - "});" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"assetId\": \"{{ASSET_ID}}\",\n \"endpointUrl\": \"http://plato-dataplane:8080/api/gateway/aas/1\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "http://localhost:8186/proxy/aas/request", - "protocol": "http", - "host": [ - "localhost" - ], - "port": "8186", - "path": [ - "proxy", - "aas", - "request" - ] - } - }, - "response": [] - } - ], - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "value", - "value": "password", - "type": "string" - }, - { - "key": "key", - "value": "X-Api-Key", - "type": "string" - } - ] - }, - "event": [ - { - "listen": "prerequest", - "script": { - "type": "text/javascript", - "exec": [ - "" - ] - } - }, - { - "listen": "test", - "script": { - "type": "text/javascript", - "exec": [ - "" - ] - } - } - ], - "variable": [ - { - "key": "CONSUMER_MANAGEMENT_URL", - "value": "http://localhost:31364/management/v2" - }, - { - "key": "PROVIDER_PROTOCOL_URL", - "value": "http://plato-controlplane:8084/api/v1/dsp" - }, - { - "key": "PROVIDER_MANAGEMENT_URL", - "value": "http://localhost:30279/management/v2" - }, - { - "key": "ASSET_ID", - "value": "1", - "type": "default" - }, - { - "key": "POLICY_ID", - "value": "1", - "type": "default" - }, - { - "key": "CONTRACT_POLICY_ID", - "value": "1", - "type": "default" - }, - { - "key": "ACCESS_POLICY_ID", - "value": "1", - "type": "default" - }, - { - "key": "CONTRACT_DEFINITION_ID", - "value": "1", - "type": "default" - }, - { - "key": "POLICY_BPN", - "value": "BPNSOKRATES", - "type": "default" - }, - { - "key": "NEGOTIATION_ID", - "value": "" - }, - { - "key": "AGREEMENT_ID", - "value": "" - }, - { - "key": "TRANSFER_ID", - "value": "" - }, - { - "key": "TRANSFER_PROCESS_ID", - "value": "" - }, - { - "key": "BACKEND_SERVICE", - "value": "http://backend:8080", - "type": "string" - }, - { - "key": "AGREEMENT-ID", - "value": "" - }, - { - "key": "authCode", - "value": "" - }, - { - "key": "PROVIDER_ID", - "value": "BPNPLATO", - "type": "string" - }, - { - "key": "EDC_NAMESPACE", - "value": "https://w3id.org/edc/v0.0.1/ns/", - "type": "string" - }, - { - "key": "CONSUMER_ADAPTER_URL", - "value": "http://localhost:31364/management/adapter", - "type": "string" - } - ] -} \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/postman/images/screenshot.png b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/postman/images/screenshot.png deleted file mode 100644 index 8a9d231c673..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/postman/images/screenshot.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/run-config.png b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/run-config.png deleted file mode 100644 index 4be2d85ad69..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/run-config.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/scripts/daps_token/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/scripts/daps_token/README.md deleted file mode 100644 index cbc7475ffd6..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/scripts/daps_token/README.md +++ /dev/null @@ -1,27 +0,0 @@ -# DAPS Token Script - -Script to request an IDS token from the DAPS. - -## Usage - -1. Copy your DAPS private key into `key.pem` -2. Edit in the script the following variables - - `token_url` - - `client_id` - - `resource` -3. Run script - - ```bash - ./daps_auth_sh - ``` - -4. Take the `access_token` from the output in use it in IDS messages. The output of the script looks like this: - - ```json - { - "access_token": "eyJ0eXAiOiJhdCtqd3QiLCJraWQiOiI3MDM2MzAwNzVkYTM2N2IxYmZiYjRjY2Q0N2M1Y2ViMGQ5ZjM1MmRmYWU2MzJkMzYxMGMxNzNmMTM1NDI0NmM5IiwiYWxnIjoiUlMyNTYifQ.eyJzY29wZSI6Imlkc2M6SURTX0NPTk5FQ1RPUl9BVFRSSUJVVEVTX0FMTCIsImF1ZCI6WyJodHRwczovL3Blbi10ZXN0LXBsYXRvLXR4ZGMuaW50LmRlbW8uY2F0ZW5hLXgubmV0L2FwaS92MS9pZHMvZGF0YSJdLCJpc3MiOiJodHRwOi8vaWRzLWRhcHM6NDU2Ny8iLCJzdWIiOiI5OTo4MzpBNzoxNzo4NjpGRjo5ODo5MzpDRTpBMDpERDpBMTpGMTozNjpGQTpGNjowRjo3NTowQToyMzprZXlpZDo5OTo4MzpBNzoxNzo4NjpGRjo5ODo5MzpDRTpBMDpERDpBMTpGMTozNjpGQTpGNjowRjo3NTowQToyMyIsIm5iZiI6MTY3ODMxMDE0OSwiaWF0IjoxNjc4MzEwMTQ5LCJqdGkiOiJkZmY5Y2FmOS05NDZiLTQ1YmMtOWY4My0yYmJkMDI4NTlmYWMiLCJleHAiOjE2NzgzMTM3NDksImNsaWVudF9pZCI6Ijk5OjgzOkE3OjE3Ojg2OkZGOjk4OjkzOkNFOkEwOkREOkExOkYxOjM2OkZBOkY2OjBGOjc1OjBBOjIzOmtleWlkOjk5OjgzOkE3OjE3Ojg2OkZGOjk4OjkzOkNFOkEwOkREOkExOkYxOjM2OkZBOkY2OjBGOjc1OjBBOjIzIiwicmVmZXJyaW5nQ29ubmVjdG9yIjoiaHR0cDovL3BsYXRvLWNvbnRyb2xwbGFuZS9CUE5QTEFUTyJ9.JQqt9gCpaG7rLztO5-pJa7HIybVjKog9v0CFXHoVJZgdxMc5nTKZnuwBVHC1PXuWrBiyPxPoNg0TsfRg9DqF8rFD5noarxOJ1S84BF7AUUi3phQzBF26lsmNmOW_gdNBC-8xw1WMo5hRHH56cB64_x4V8T4VwFlSYYrmA5ge_EiPCW_KWF9sNguXBKs8uTbLB3lvTELGTjmZI93tVR-vYuYzW2jxH1PJNW29KJRQcM0D1AiveMs3_ThRjheEvugyh9QIY1RwPXMgYQpSTvoumNuFFTnpR21ueWfSUtU-4Qu9suNTkcaFihvEObXVrhyMja-HjhQaC8i0XsAgY0tT1A", - "expires_in": 3600, - "token_type": "bearer", - "scope": "idsc:IDS_CONNECTOR_ATTRIBUTES_ALL" - } - ``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/scripts/daps_token/daps_auth.sh b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/scripts/daps_token/daps_auth.sh deleted file mode 100755 index 2835a2e6152..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/development/scripts/daps_token/daps_auth.sh +++ /dev/null @@ -1,45 +0,0 @@ -#!/bin/bash - -#################################################### -# Update these variables before running the script # -#################################################### -token_url="https://mydaps/token" -client_id="99:83:A7:17:86:FF:98:93:CE:A0:DD:A1:F1:36:FF:F6:0F:75:0A:23:keyid:99:83:A7:17:86:FF:98:93:CE:A0:DD:A1:F1:36:FA:F6:0F:75:0A:24" -# resource is later used as token audience, so it must be the IDS url of the token receiving connector -resource="https://receiving-connector/api/v1/ids/data" - - -base64_encode() -{ - declare input=${1:-$( The shown picture illustrates only a generic view of the Domain Model and is not intended to show all aspects of the project. - -## Asset - -An asset represents data (databases, files, cache information, etc.) which should be published and shared between -organizations. For each asset, a [`DataAddress`](#data-address) needs to be resolvable. - -## Data address - -A data address is a pointer into the physical storage location where an asset will be stored. - -## Contract - -A contract always contains one or more [`Assets`](#asset) and a single [`Policy`](#policy). The contract construct is -used to define the arrangement between two parties ("consumer" and "provider"). Regarding this arrangement, the contract -passes several stages which are explained below: - -### Contract definition - - Contract definitions associate a policy with assets. A `ContractDefinition` object contains an access policy, a contract - policy, and an asset selector which links the contract to one or more assets. - -### Contract offer - - The contract offer is a dynamic representation of the [`ContractDefinition`](#contract-definition) - for a specific consumer and serves as protocol's data transfer object (DTO) for a particular contract negotiation. - Contract offers are not persisted and will be regenerated on every request. The connector acting as data provider will - generate contract offers only for contract definitions dedicated to the organization or data space participant - operating the requesting connector acting as data consumer. A contract offer is always related to a single asset of - the `ContractDefinition` object (e.g. for a `ContractDefinition` containing three `Asset` objects, the connector will - generate three `ContractOffer` objects). - -### Contract negotiation - - A `ContractNegotiation` captures the current state of the negotiation of a contract (`ContractOffer` -> - `ContractAgreement`) between two parties. This process is inherently asynchronous. - -### Contract agreement - - A contract agreement represents the agreed-upon terms of access and usage of an asset's data between two data space - participants, including a start and an end date and further relevant information. - -## Policy - -Contract policies represent permitted and prohibited actions over a certain asset. These actions can be limited further -by constraints (temporal or spatial) and duties ("e.g. deletion of the data after 30 days"). - -## Transfer process - -After a successful contract negotiation, a `DataRequest` is sent from a consumer connector to a provider connector to -initiate the data transfer. It references the requested [`Asset`](#asset) and [`ContractAgreement`](#contract-agreement) -as well as information about the [data destination](#data-address). - -Similar to the `ContractNegotiation`, this object captures the current state of a data transfer. This process is -inherently asynchronous, so the `TransferProcess` objects are stored in a backing data store (`TransferProcessStore`). diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/add-entry.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/add-entry.api.mdx deleted file mode 100644 index d0e202c230b..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/add-entry.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: add-entry -title: "addEntry" -description: "Adds one datatplane instance to the internal database of the selector" -sidebar_label: "addEntry" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Dataplane Selector"],"description":"Adds one datatplane instance to the internal database of the selector","operationId":"addEntry","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataPlaneInstance"},"allowedDestTypes":{"uniqueItems":true,"type":"array","example":null,"items":{"type":"string","example":null}},"allowedSourceTypes":{"uniqueItems":true,"type":"array","example":null,"items":{"type":"string","example":null}},"lastActive":{"type":"integer","format":"int64","example":null},"turnCount":{"type":"integer","format":"int32","example":null},"url":{"type":"string","format":"url","example":null}},"example":{"@id":"your-dataplane-id","url":"http://somewhere.com:1234/api/v1","allowedSourceTypes":["source-type1","source-type2"],"allowedDestTypes":["your-dest-type"]}}}}},"responses":{"200":{"description":"Entry was added successfully to the database"},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/v2/dataplanes","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@id":"your-dataplane-id","url":"http://somewhere.com:1234/api/v1","allowedSourceTypes":["source-type1","source-type2"],"allowedDestTypes":["your-dest-type"]},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"add Entry","description":{"content":"Adds one datatplane instance to the internal database of the selector","type":"text/plain"},"url":{"path":["v2","dataplanes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## addEntry - - - -Adds one datatplane instance to the internal database of the selector - -
Request Body
- -Entry was added successfully to the database - -
- -Request body was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/call-deprovision-webhook.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/call-deprovision-webhook.api.mdx deleted file mode 100644 index fec02ab0242..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/call-deprovision-webhook.api.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: call-deprovision-webhook -title: "callDeprovisionWebhook" -description: "" -sidebar_label: "callDeprovisionWebhook" -hide_title: true -hide_table_of_contents: true -api: {"tags":["HTTP Provisioner Webhook"],"description":null,"operationId":"callDeprovisionWebhook","parameters":[{"name":"processId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","example":null},"errorMessage":{"type":"string","example":null},"inProcess":{"type":"boolean","example":null},"provisionedResourceId":{"type":"string","example":null}},"example":null}}}},"responses":{"default":{"description":"default response"}},"method":"post","path":"/callback/{processId}/deprovision","servers":[{"url":"/"}],"jsonRequestBodyExample":null,"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"call Deprovision Webhook","description":{"type":"text/plain"},"url":{"path":["callback",":processId","deprovision"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"processId"}]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## callDeprovisionWebhook - -
Path Parameters
Request Body
- -default response - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/call-provision-webhook.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/call-provision-webhook.api.mdx deleted file mode 100644 index 03e4812c84f..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/call-provision-webhook.api.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: call-provision-webhook -title: "callProvisionWebhook" -description: "" -sidebar_label: "callProvisionWebhook" -hide_title: true -hide_table_of_contents: true -api: {"tags":["HTTP Provisioner Webhook"],"description":null,"operationId":"callProvisionWebhook","parameters":[{"name":"processId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"apiKeyJwt":{"type":"string","example":null},"assetId":{"type":"string","example":null},"contentDataAddress":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"hasToken":{"type":"boolean","example":null},"resourceDefinitionId":{"type":"string","example":null},"resourceName":{"type":"string","example":null}},"example":null}}}},"responses":{"default":{"description":"default response"}},"method":"post","path":"/callback/{processId}/provision","servers":[{"url":"/"}],"jsonRequestBodyExample":null,"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"call Provision Webhook","description":{"type":"text/plain"},"url":{"path":["callback",":processId","provision"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"processId"}]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## callProvisionWebhook - -
Path Parameters
Request Body
    contentDataAddress object
- -default response - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/cancel-negotiation.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/cancel-negotiation.api.mdx deleted file mode 100644 index 0896f3cfc3d..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/cancel-negotiation.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: cancel-negotiation -title: "cancelNegotiation" -description: "Requests aborting the contract negotiation. Due to the asynchronous nature of contract negotiations, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state." -sidebar_label: "cancelNegotiation" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Contract Negotiation"],"description":"Requests aborting the contract negotiation. Due to the asynchronous nature of contract negotiations, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state.","operationId":"cancelNegotiation","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Request to cancel the Contract negotiation was successfully received","links":{"poll-state":{"operationId":"getNegotiationState"}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"A contract negotiation with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"deprecated":true,"method":"post","path":"/v2/contractnegotiations/{id}/cancel","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"cancel Negotiation","description":{"content":"Requests aborting the contract negotiation. Due to the asynchronous nature of contract negotiations, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state.","type":"text/plain"},"url":{"path":["v2","contractnegotiations",":id","cancel"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## cancelNegotiation - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Requests aborting the contract negotiation. Due to the asynchronous nature of contract negotiations, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state. - -
Path Parameters
- -Request to cancel the Contract negotiation was successfully received - -
- -Request was malformed, e.g. id was null - -
Schema array
- -A contract negotiation with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/check-health.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/check-health.api.mdx deleted file mode 100644 index 91984211206..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/check-health.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: check-health -title: "checkHealth" -description: "Performs a liveness probe to determine whether the runtime is working properly." -sidebar_label: "checkHealth" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Application Observability"],"description":"Performs a liveness probe to determine whether the runtime is working properly.","operationId":"checkHealth","responses":{"200":{"description":"The runtime is working properly.","content":{"application/json":{"schema":{"type":"object","properties":{"componentResults":{"type":"array","example":null,"items":{"type":"object","properties":{"component":{"type":"string","example":null},"failure":{"type":"object","properties":{"failureDetail":{"type":"string","example":null},"messages":{"type":"array","example":null,"items":{"type":"string","example":null}}},"example":null},"isHealthy":{"type":"boolean","example":null}},"example":null}},"isSystemHealthy":{"type":"boolean","example":null}},"example":null}}}}},"method":"get","path":"/check/health","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"check Health","description":{"content":"Performs a liveness probe to determine whether the runtime is working properly.","type":"text/plain"},"url":{"path":["check","health"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## checkHealth - - - -Performs a liveness probe to determine whether the runtime is working properly. - -
- -The runtime is working properly. - -
Schema
    componentResults object[]
    failure object
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/complete.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/complete.api.mdx deleted file mode 100644 index 9b2b2dc86fa..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/complete.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: complete -title: "complete" -description: "Requests completion of the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received" -sidebar_label: "complete" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Transfer Process Control Api"],"description":"Requests completion of the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received","operationId":"complete","parameters":[{"name":"processId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/transferprocess/{processId}/complete","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"complete","description":{"content":"Requests completion of the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received","type":"text/plain"},"url":{"path":["transferprocess",":processId","complete"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"processId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## complete - - - -Requests completion of the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received - -
Path Parameters
- -Request was malformed, e.g. id was null - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-asset-1.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-asset-1.api.mdx deleted file mode 100644 index ea5910a295c..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-asset-1.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-asset-1 -title: "createAsset_1" -description: "Creates a new asset together with a data address" -sidebar_label: "createAsset_1" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset"],"description":"Creates a new asset together with a data address","operationId":"createAsset_1","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/Asset"},"dataAddress":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"privateProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"definition-id","properties":{"key":"value"},"privateProperties":{"privateKey":"privateValue"},"dataAddress":{"type":"HttpData"}}}}}},"responses":{"200":{"description":"Asset was created successfully. Returns the asset Id and created timestamp","content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"createdAt":{"type":"integer","format":"int64","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"id-value","createdAt":1688465655}}}}},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"409":{"description":"Could not create asset, because an asset with that ID already exists","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/v3/assets","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"definition-id","properties":{"key":"value"},"privateProperties":{"privateKey":"privateValue"},"dataAddress":{"type":"HttpData"}},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"create Asset 1","description":{"content":"Creates a new asset together with a data address","type":"text/plain"},"url":{"path":["v3","assets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## createAsset_1 - - - -Creates a new asset together with a data address - -
Request Body
    dataAddress object
    privateProperties object
  • property name* object
    • properties object
  • property name* object
- -Asset was created successfully. Returns the asset Id and created timestamp - -
Schema
- -Request body was malformed - -
Schema array
- -Could not create asset, because an asset with that ID already exists - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-asset.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-asset.api.mdx deleted file mode 100644 index e02f83083af..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-asset.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: create-asset -title: "createAsset" -description: "Creates a new asset together with a data address" -sidebar_label: "createAsset" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset"],"description":"Creates a new asset together with a data address","operationId":"createAsset","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"asset":{"type":"object","properties":{"createdAt":{"type":"integer","format":"int64","example":null},"dataAddress":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"id":{"type":"string","example":null},"privateProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}},"example":null},"dataAddress":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null}},"example":null}}}},"responses":{"200":{"description":"Asset was created successfully. Returns the asset Id and created timestamp","content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"createdAt":{"type":"integer","format":"int64","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"id-value","createdAt":1688465655}}}}},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"409":{"description":"Could not create asset, because an asset with that ID already exists","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"deprecated":true,"method":"post","path":"/v2/assets","servers":[{"url":"/"}],"jsonRequestBodyExample":null,"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"create Asset","description":{"content":"Creates a new asset together with a data address","type":"text/plain"},"url":{"path":["v2","assets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## createAsset - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Creates a new asset together with a data address - -
Request Body
    asset object
    dataAddress object
    privateProperties object
  • property name* object
    • properties object
  • property name* object
    • dataAddress object
- -Asset was created successfully. Returns the asset Id and created timestamp - -
Schema
- -Request body was malformed - -
Schema array
- -Could not create asset, because an asset with that ID already exists - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-contract-definition.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-contract-definition.api.mdx deleted file mode 100644 index 109efe0dad0..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-contract-definition.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-contract-definition -title: "createContractDefinition" -description: "Creates a new contract definition" -sidebar_label: "createContractDefinition" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Contract Definition"],"description":"Creates a new contract definition","operationId":"createContractDefinition","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/ContractDefinition"},"accessPolicyId":{"type":"string","example":null},"assetsSelector":{"type":"array","example":null,"items":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/Criterion"},"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"Criterion","operandLeft":"fieldName","operator":"=","operandRight":"some value"}}},"contractPolicyId":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"definition-id","accessPolicyId":"asset-policy-id","contractPolicyId":"contract-policy-id","assetsSelector":[]}}}}},"responses":{"200":{"description":"contract definition was created successfully. Returns the Contract Definition Id and created timestamp","content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"createdAt":{"type":"integer","format":"int64","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"id-value","createdAt":1688465655}}}}},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"409":{"description":"Could not create contract definition, because a contract definition with that ID already exists","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/v2/contractdefinitions","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"create Contract Definition","description":{"content":"Creates a new contract definition","type":"text/plain"},"url":{"path":["v2","contractdefinitions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"*/*"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\""}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## createContractDefinition - - - -Creates a new contract definition - -
Request Body
    assetsSelector object[]
- -contract definition was created successfully. Returns the Contract Definition Id and created timestamp - -
Schema
- -Request body was malformed - -
Schema array
- -Could not create contract definition, because a contract definition with that ID already exists - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-entry.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-entry.api.mdx deleted file mode 100644 index 86f700b2a66..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-entry.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-entry -title: "createEntry" -description: "Creates an entry for a particular BPN" -sidebar_label: "createEntry" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Business Partner Group"],"description":"Creates an entry for a particular BPN","operationId":"createEntry","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"groups":{"uniqueItems":true,"type":"array","example":null,"items":{"type":"string","example":null}}},"example":{"@context":{"tx":"https://w3id.org/tractusx/v0.0.1/ns/"},"@id":"tx:BPN000001234","tx:groups":["group1","group2","group3"]}}}}},"responses":{"204":{"description":"The object was successfully created"},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"409":{"description":"An entry already exists for that BPN"}},"method":"post","path":"/business-partner-groups","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@context":{"tx":"https://w3id.org/tractusx/v0.0.1/ns/"},"@id":"tx:BPN000001234","tx:groups":["group1","group2","group3"]},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"create Entry","description":{"content":"Creates an entry for a particular BPN","type":"text/plain"},"url":{"path":["business-partner-groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## createEntry - - - -Creates an entry for a particular BPN - -
Request Body
- -The object was successfully created - -
- -Request body was malformed - -
Schema array
- -An entry already exists for that BPN - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-policy-definition.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-policy-definition.api.mdx deleted file mode 100644 index 5152dbec5c7..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-policy-definition.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-policy-definition -title: "createPolicyDefinition" -description: "Creates a new policy definition" -sidebar_label: "createPolicyDefinition" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Policy Definition"],"description":"Creates a new policy definition","operationId":"createPolicyDefinition","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/PolicyDefinition"},"policy":{"type":"object","properties":{"@type":{"type":"string","example":null,"enum":["SET","OFFER","CONTRACT"]},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null}},"example":null},"target":{"type":"string","example":null}},"example":null}},"permissions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":"circular()","target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"definition-id","policy":{"@context":"http://www.w3.org/ns/odrl.jsonld","@type":"Set","uid":"http://example.com/policy:1010","permission":[{"target":"http://example.com/asset:9898.movie","action":"display","constraint":[{"leftOperand":"spatial","operator":"eq","rightOperand":"https://www.wikidata.org/wiki/Q183","comment":"i.e Germany"}]}]}}}}}},"responses":{"200":{"description":"policy definition was created successfully. Returns the Policy Definition Id and created timestamp","content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"createdAt":{"type":"integer","format":"int64","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"id-value","createdAt":1688465655}}}}},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"409":{"description":"Could not create policy definition, because a contract definition with that ID already exists","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/v2/policydefinitions","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"definition-id","policy":{"@context":"http://www.w3.org/ns/odrl.jsonld","@type":"Set","uid":"http://example.com/policy:1010","permission":[{"target":"http://example.com/asset:9898.movie","action":"display","constraint":[{"leftOperand":"spatial","operator":"eq","rightOperand":"https://www.wikidata.org/wiki/Q183","comment":"i.e Germany"}]}]}},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"create Policy Definition","description":{"content":"Creates a new policy definition","type":"text/plain"},"url":{"path":["v2","policydefinitions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## createPolicyDefinition - - - -Creates a new policy definition - -
Request Body
    policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -policy definition was created successfully. Returns the Policy Definition Id and created timestamp - -
Schema
- -Request body was malformed - -
Schema array
- -Could not create policy definition, because a contract definition with that ID already exists - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/decline-negotiation.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/decline-negotiation.api.mdx deleted file mode 100644 index f6ee5a16784..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/decline-negotiation.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: decline-negotiation -title: "declineNegotiation" -description: "Requests cancelling the contract negotiation. Due to the asynchronous nature of contract negotiations, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state." -sidebar_label: "declineNegotiation" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Contract Negotiation"],"description":"Requests cancelling the contract negotiation. Due to the asynchronous nature of contract negotiations, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state.","operationId":"declineNegotiation","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Request to decline the Contract negotiation was successfully received","links":{"poll-state":{"operationId":"getNegotiationState"}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"A contract negotiation with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"deprecated":true,"method":"post","path":"/v2/contractnegotiations/{id}/decline","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"decline Negotiation","description":{"content":"Requests cancelling the contract negotiation. Due to the asynchronous nature of contract negotiations, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state.","type":"text/plain"},"url":{"path":["v2","contractnegotiations",":id","decline"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## declineNegotiation - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Requests cancelling the contract negotiation. Due to the asynchronous nature of contract negotiations, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state. - -
Path Parameters
- -Request to decline the Contract negotiation was successfully received - -
- -Request was malformed, e.g. id was null - -
Schema array
- -A contract negotiation with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete-contract-definition.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete-contract-definition.api.mdx deleted file mode 100644 index cbfb024c97a..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete-contract-definition.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: delete-contract-definition -title: "deleteContractDefinition" -description: "Removes a contract definition with the given ID if possible. DANGER ZONE: Note that deleting contract definitions can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations." -sidebar_label: "deleteContractDefinition" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Contract Definition"],"description":"Removes a contract definition with the given ID if possible. DANGER ZONE: Note that deleting contract definitions can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations.","operationId":"deleteContractDefinition","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Contract definition was deleted successfully"},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"A contract definition with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"delete","path":"/v2/contractdefinitions/{id}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"delete Contract Definition","description":{"content":"Removes a contract definition with the given ID if possible. DANGER ZONE: Note that deleting contract definitions can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations.","type":"text/plain"},"url":{"path":["v2","contractdefinitions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## deleteContractDefinition - - - -Removes a contract definition with the given ID if possible. DANGER ZONE: Note that deleting contract definitions can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations. - -
Path Parameters
- -Contract definition was deleted successfully - -
- -Request was malformed, e.g. id was null - -
Schema array
- -A contract definition with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete-edr.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete-edr.api.mdx deleted file mode 100644 index 9bd3a565aec..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete-edr.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: delete-edr -title: "deleteEdr" -description: "Delete an EDR with the given transfer process ID" -sidebar_label: "deleteEdr" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Control Plane EDR Api"],"description":"Delete an EDR with the given transfer process ID","operationId":"deleteEdr","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"The EDR cached","content":{"application/json":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null}}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"An EDR with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"delete","path":"/edrs/{id}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"delete Edr","description":{"content":"Delete an EDR with the given transfer process ID","type":"text/plain"},"url":{"path":["edrs",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## deleteEdr - - - -Delete an EDR with the given transfer process ID - -
Path Parameters
- -The EDR cached - -
Schema
- -Request was malformed, e.g. id was null - -
Schema array
- -An EDR with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete-entry.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete-entry.api.mdx deleted file mode 100644 index ec4c6a9d606..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete-entry.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: delete-entry -title: "deleteEntry" -description: "Deletes the entry for a particular BPN" -sidebar_label: "deleteEntry" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Business Partner Group"],"description":"Deletes the entry for a particular BPN","operationId":"deleteEntry","parameters":[{"name":"bpn","in":"path","description":"The business partner number","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"204":{"description":"The object was successfully deleted"},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"No entry for the given BPN was found"}},"method":"delete","path":"/business-partner-groups/{bpn}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"delete Entry","description":{"content":"Deletes the entry for a particular BPN","type":"text/plain"},"url":{"path":["business-partner-groups",":bpn"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The business partner number","type":"text/plain"},"type":"any","value":"","key":"bpn"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## deleteEntry - - - -Deletes the entry for a particular BPN - -
Path Parameters
- -The object was successfully deleted - -
- -Request body was malformed - -
Schema array
- -No entry for the given BPN was found - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete-policy-definition.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete-policy-definition.api.mdx deleted file mode 100644 index 050f026ab93..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete-policy-definition.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: delete-policy-definition -title: "deletePolicyDefinition" -description: "Removes a policy definition with the given ID if possible. Deleting a policy definition is only possible if that policy definition is not yet referenced by a contract definition, in which case an error is returned. DANGER ZONE: Note that deleting policy definitions can have unexpected results, do this at your own risk!" -sidebar_label: "deletePolicyDefinition" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Policy Definition"],"description":"Removes a policy definition with the given ID if possible. Deleting a policy definition is only possible if that policy definition is not yet referenced by a contract definition, in which case an error is returned. DANGER ZONE: Note that deleting policy definitions can have unexpected results, do this at your own risk!","operationId":"deletePolicyDefinition","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Policy definition was deleted successfully"},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"An policy definition with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"409":{"description":"The policy definition cannot be deleted, because it is referenced by a contract definition","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"delete","path":"/v2/policydefinitions/{id}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"delete Policy Definition","description":{"content":"Removes a policy definition with the given ID if possible. Deleting a policy definition is only possible if that policy definition is not yet referenced by a contract definition, in which case an error is returned. DANGER ZONE: Note that deleting policy definitions can have unexpected results, do this at your own risk!","type":"text/plain"},"url":{"path":["v2","policydefinitions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## deletePolicyDefinition - - - -Removes a policy definition with the given ID if possible. Deleting a policy definition is only possible if that policy definition is not yet referenced by a contract definition, in which case an error is returned. DANGER ZONE: Note that deleting policy definitions can have unexpected results, do this at your own risk! - -
Path Parameters
- -Policy definition was deleted successfully - -
- -Request was malformed, e.g. id was null - -
Schema array
- -An policy definition with the given ID does not exist - -
Schema array
- -The policy definition cannot be deleted, because it is referenced by a contract definition - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete.api.mdx deleted file mode 100644 index 5250dba6f1c..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: delete -title: "delete" -description: "Send `DELETE` data query to the Data Plane." -sidebar_label: "delete" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Data Plane public API"],"description":"Send `DELETE` data query to the Data Plane.","operationId":"delete","responses":{"400":{"description":"Missing access token"},"403":{"description":"Access token is expired or invalid"},"500":{"description":"Failed to transfer data"}},"method":"delete","path":"/{any}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"delete","description":{"content":"Send `DELETE` data query to the Data Plane.","type":"text/plain"},"url":{"path":[":any"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"DELETE"}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## delete - - - -Send `DELETE` data query to the Data Plane. - -
- -Missing access token - -
- -Access token is expired or invalid - -
- -Failed to transfer data - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/deprovision-transfer-process.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/deprovision-transfer-process.api.mdx deleted file mode 100644 index 43cb69dab32..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/deprovision-transfer-process.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: deprovision-transfer-process -title: "deprovisionTransferProcess" -description: "Requests the deprovisioning of resources associated with a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. This may take a long time, so clients must poll the /{id}/state endpoint to track the state." -sidebar_label: "deprovisionTransferProcess" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Transfer Process"],"description":"Requests the deprovisioning of resources associated with a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. This may take a long time, so clients must poll the /{id}/state endpoint to track the state.","operationId":"deprovisionTransferProcess","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Request to deprovision the transfer process was successfully received","links":{"poll-state":{"operationId":"getTransferProcessState"}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"A contract negotiation with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/v2/transferprocesses/{id}/deprovision","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"deprovision Transfer Process","description":{"content":"Requests the deprovisioning of resources associated with a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. This may take a long time, so clients must poll the /{id}/state endpoint to track the state.","type":"text/plain"},"url":{"path":["v2","transferprocesses",":id","deprovision"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## deprovisionTransferProcess - - - -Requests the deprovisioning of resources associated with a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. This may take a long time, so clients must poll the /{id}/state endpoint to track the state. - -
Path Parameters
- -Request to deprovision the transfer process was successfully received - -
- -Request was malformed, e.g. id was null - -
Schema array
- -A contract negotiation with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/fail.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/fail.api.mdx deleted file mode 100644 index 4dcafb13ed1..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/fail.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: fail -title: "fail" -description: "Requests completion of the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received" -sidebar_label: "fail" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Transfer Process Control Api"],"description":"Requests completion of the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received","operationId":"fail","parameters":[{"name":"processId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"errorMessage":{"type":"string","example":null}},"example":null}}}},"responses":{"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/transferprocess/{processId}/fail","servers":[{"url":"/"}],"jsonRequestBodyExample":null,"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"fail","description":{"content":"Requests completion of the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received","type":"text/plain"},"url":{"path":["transferprocess",":processId","fail"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"processId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## fail - - - -Requests completion of the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received - -
Path Parameters
Request Body
- -Request was malformed, e.g. id was null - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/find-1.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/find-1.api.mdx deleted file mode 100644 index 568d2f8def3..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/find-1.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: find-1 -title: "find_1" -description: "Finds the best fitting data plane instance for a particular query" -sidebar_label: "find_1" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Dataplane Selector"],"description":"Finds the best fitting data plane instance for a particular query","operationId":"find_1","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/SelectionRequest"},"destination":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"source":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"strategy":{"type":"string","example":null}},"example":{"source":{"@type":"https://w3id.org/edc/v0.0.1/ns/DataAddress","type":"test-src1"},"destination":{"@type":"https://w3id.org/edc/v0.0.1/ns/DataAddress","type":"test-dst2"},"strategy":"you_custom_strategy"}}}}},"responses":{"200":{"description":"The DataPlane instance that fits best for the given selection request","content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataPlaneInstance"},"allowedDestTypes":{"uniqueItems":true,"type":"array","example":null,"items":{"type":"string","example":null}},"allowedSourceTypes":{"uniqueItems":true,"type":"array","example":null,"items":{"type":"string","example":null}},"lastActive":{"type":"integer","format":"int64","example":null},"turnCount":{"type":"integer","format":"int32","example":null},"url":{"type":"string","format":"url","example":null}},"example":{"@id":"your-dataplane-id","url":"http://somewhere.com:1234/api/v1","allowedSourceTypes":["source-type1","source-type2"],"allowedDestTypes":["your-dest-type"]}}}}},"204":{"description":"No suitable DataPlane instance was found"},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/v2/dataplanes/select","servers":[{"url":"/"}],"jsonRequestBodyExample":{"source":{"@type":"https://w3id.org/edc/v0.0.1/ns/DataAddress","type":"test-src1"},"destination":{"@type":"https://w3id.org/edc/v0.0.1/ns/DataAddress","type":"test-dst2"},"strategy":"you_custom_strategy"},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"find 1","description":{"content":"Finds the best fitting data plane instance for a particular query","type":"text/plain"},"url":{"path":["v2","dataplanes","select"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## find_1 - - - -Finds the best fitting data plane instance for a particular query - -
Request Body
    destination object
    source object
- -The DataPlane instance that fits best for the given selection request - -
Schema
- -No suitable DataPlane instance was found - -
- -Request body was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/find.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/find.api.mdx deleted file mode 100644 index aeb497b528f..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/find.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: find -title: "find" -description: "Finds the best fitting data plane instance for a particular query" -sidebar_label: "find" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Dataplane Selector"],"description":"Finds the best fitting data plane instance for a particular query","operationId":"find","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/SelectionRequest"},"destination":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"source":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"strategy":{"type":"string","example":null}},"example":{"source":{"@type":"https://w3id.org/edc/v0.0.1/ns/DataAddress","type":"test-src1"},"destination":{"@type":"https://w3id.org/edc/v0.0.1/ns/DataAddress","type":"test-dst2"},"strategy":"you_custom_strategy"}}}}},"responses":{"200":{"description":"The DataPlane instance that fits best for the given selection request","content":{"*/*":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataPlaneInstance"},"allowedDestTypes":{"uniqueItems":true,"type":"array","example":null,"items":{"type":"string","example":null}},"allowedSourceTypes":{"uniqueItems":true,"type":"array","example":null,"items":{"type":"string","example":null}},"lastActive":{"type":"integer","format":"int64","example":null},"turnCount":{"type":"integer","format":"int32","example":null},"url":{"type":"string","format":"url","example":null}},"example":{"@id":"your-dataplane-id","url":"http://somewhere.com:1234/api/v1","allowedSourceTypes":["source-type1","source-type2"],"allowedDestTypes":["your-dest-type"]}}}}},"204":{"description":"No suitable DataPlane instance was found"},"400":{"description":"Request body was malformed","content":{"*/*":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/select","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"find","description":{"content":"Finds the best fitting data plane instance for a particular query","type":"text/plain"},"url":{"path":["select"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"*/*"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\""}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## find - - - -Finds the best fitting data plane instance for a particular query - -
Request Body
    destination object
    source object
- -The DataPlane instance that fits best for the given selection request - -
Schema
- -No suitable DataPlane instance was found - -
- -Request body was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-agreement-by-id.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-agreement-by-id.api.mdx deleted file mode 100644 index 694ea619cfa..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-agreement-by-id.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-agreement-by-id -title: "getAgreementById" -description: "Gets an contract agreement with the given ID" -sidebar_label: "getAgreementById" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Contract Agreement"],"description":"Gets an contract agreement with the given ID","operationId":"getAgreementById","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"The contract agreement","content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/ContractAgreement"},"assetId":{"type":"string","example":null},"consumerId":{"type":"string","example":null},"contractSigningDate":{"type":"integer","format":"int64","example":null},"policy":{"type":"object","properties":{"@type":{"type":"string","example":null,"enum":["SET","OFFER","CONTRACT"]},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null}},"example":null},"target":{"type":"string","example":null}},"example":null}},"permissions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":"circular()","target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null},"providerId":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"https://w3id.org/edc/v0.0.1/ns/ContractAgreement","@id":"negotiation-id","providerId":"provider-id","consumerId":"consumer-id","assetId":"asset-id","contractSigningDate":1688465655,"policy":{"@context":"http://www.w3.org/ns/odrl.jsonld","@type":"Set","@id":"offer-id","permission":[{"target":"asset-id","action":"display"}]}}}}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"An contract agreement with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"get","path":"/v2/contractagreements/{id}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get Agreement By Id","description":{"content":"Gets an contract agreement with the given ID","type":"text/plain"},"url":{"path":["v2","contractagreements",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getAgreementById - - - -Gets an contract agreement with the given ID - -
Path Parameters
- -The contract agreement - -
Schema
    policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -Request was malformed, e.g. id was null - -
Schema array
- -An contract agreement with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-agreement-for-negotiation.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-agreement-for-negotiation.api.mdx deleted file mode 100644 index 43a8a011b64..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-agreement-for-negotiation.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-agreement-for-negotiation -title: "getAgreementForNegotiation" -description: "Gets a contract agreement for a contract negotiation with the given ID" -sidebar_label: "getAgreementForNegotiation" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Contract Negotiation"],"description":"Gets a contract agreement for a contract negotiation with the given ID","operationId":"getAgreementForNegotiation","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"The contract agreement that is attached to the negotiation, or null","content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/ContractAgreement"},"assetId":{"type":"string","example":null},"consumerId":{"type":"string","example":null},"contractSigningDate":{"type":"integer","format":"int64","example":null},"policy":{"type":"object","properties":{"@type":{"type":"string","example":null,"enum":["SET","OFFER","CONTRACT"]},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null}},"example":null},"target":{"type":"string","example":null}},"example":null}},"permissions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":"circular()","target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null},"providerId":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"https://w3id.org/edc/v0.0.1/ns/ContractAgreement","@id":"negotiation-id","providerId":"provider-id","consumerId":"consumer-id","assetId":"asset-id","contractSigningDate":1688465655,"policy":{"@context":"http://www.w3.org/ns/odrl.jsonld","@type":"Set","@id":"offer-id","permission":[{"target":"asset-id","action":"display"}]}}}}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"An contract negotiation with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"get","path":"/v2/contractnegotiations/{id}/agreement","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get Agreement For Negotiation","description":{"content":"Gets a contract agreement for a contract negotiation with the given ID","type":"text/plain"},"url":{"path":["v2","contractnegotiations",":id","agreement"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getAgreementForNegotiation - - - -Gets a contract agreement for a contract negotiation with the given ID - -
Path Parameters
- -The contract agreement that is attached to the negotiation, or null - -
Schema
    policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -Request was malformed, e.g. id was null - -
Schema array
- -An contract negotiation with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-all.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-all.api.mdx deleted file mode 100644 index 58aa40fe886..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-all.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-all -title: "getAll" -description: "Returns a list of all currently registered data plane instances" -sidebar_label: "getAll" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Dataplane Selector"],"description":"Returns a list of all currently registered data plane instances","operationId":"getAll","responses":{"204":{"description":"A (potentially empty) list of currently registered data plane instances"},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"get","path":"/v2/dataplanes","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get All","description":{"content":"Returns a list of all currently registered data plane instances","type":"text/plain"},"url":{"path":["v2","dataplanes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getAll - - - -Returns a list of all currently registered data plane instances - -
- -A (potentially empty) list of currently registered data plane instances - -
- -Request body was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-asset-1.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-asset-1.api.mdx deleted file mode 100644 index 1557a794c0b..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-asset-1.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-asset-1 -title: "getAsset_1" -description: "Gets an asset with the given ID" -sidebar_label: "getAsset_1" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset"],"description":"Gets an asset with the given ID","operationId":"getAsset_1","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"The asset","content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/Asset"},"createdAt":{"type":"integer","format":"int64","example":null},"dataAddress":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"privateProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"definition-id","edc:properties":{"edc:key":"value"},"edc:privateProperties":{"edc:privateKey":"privateValue"},"edc:dataAddress":{"edc:type":"HttpData"},"edc:createdAt":1688465655}}}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"An asset with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"get","path":"/v3/assets/{id}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get Asset 1","description":{"content":"Gets an asset with the given ID","type":"text/plain"},"url":{"path":["v3","assets",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getAsset_1 - - - -Gets an asset with the given ID - -
Path Parameters
- -The asset - -
Schema
    dataAddress object
    privateProperties object
  • property name* object
    • properties object
  • property name* object
- -Request was malformed, e.g. id was null - -
Schema array
- -An asset with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-asset-data-address.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-asset-data-address.api.mdx deleted file mode 100644 index 8b5f6f862f4..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-asset-data-address.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-asset-data-address -title: "getAssetDataAddress" -description: "Gets a data address of an asset with the given ID" -sidebar_label: "getAssetDataAddress" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset"],"description":"Gets a data address of an asset with the given ID","operationId":"getAssetDataAddress","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"The data address","content":{"application/json":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null}}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"An asset with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"deprecated":true,"method":"get","path":"/v2/assets/{id}/dataaddress","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get Asset Data Address","description":{"content":"Gets a data address of an asset with the given ID","type":"text/plain"},"url":{"path":["v2","assets",":id","dataaddress"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getAssetDataAddress - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Gets a data address of an asset with the given ID - -
Path Parameters
- -The data address - -
Schema
- -Request was malformed, e.g. id was null - -
Schema array
- -An asset with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-asset.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-asset.api.mdx deleted file mode 100644 index 98fbd8a93d9..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-asset.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-asset -title: "getAsset" -description: "Gets an asset with the given ID" -sidebar_label: "getAsset" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset"],"description":"Gets an asset with the given ID","operationId":"getAsset","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"The asset","content":{"application/json":{"schema":{"type":"object","properties":{"createdAt":{"type":"integer","format":"int64","example":null},"dataAddress":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"id":{"type":"string","example":null},"privateProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}},"example":null}}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"An asset with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"deprecated":true,"method":"get","path":"/v2/assets/{id}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get Asset","description":{"content":"Gets an asset with the given ID","type":"text/plain"},"url":{"path":["v2","assets",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getAsset - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Gets an asset with the given ID - -
Path Parameters
- -The asset - -
Schema
    dataAddress object
    privateProperties object
  • property name* object
    • properties object
  • property name* object
- -Request was malformed, e.g. id was null - -
Schema array
- -An asset with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-contract-definition.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-contract-definition.api.mdx deleted file mode 100644 index ada9f1e0c7f..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-contract-definition.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-contract-definition -title: "getContractDefinition" -description: "Gets an contract definition with the given ID" -sidebar_label: "getContractDefinition" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Contract Definition"],"description":"Gets an contract definition with the given ID","operationId":"getContractDefinition","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"The contract definition","content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/ContractDefinition"},"accessPolicyId":{"type":"string","example":null},"assetsSelector":{"type":"array","example":null,"items":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/Criterion"},"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"Criterion","operandLeft":"fieldName","operator":"=","operandRight":"some value"}}},"contractPolicyId":{"type":"string","example":null},"createdAt":{"type":"integer","format":"int64","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"definition-id","edc:accessPolicyId":"asset-policy-id","edc:contractPolicyId":"contract-policy-id","edc:assetsSelector":[],"edc:createdAt":1688465655}}}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"An contract agreement with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"get","path":"/v2/contractdefinitions/{id}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get Contract Definition","description":{"content":"Gets an contract definition with the given ID","type":"text/plain"},"url":{"path":["v2","contractdefinitions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getContractDefinition - - - -Gets an contract definition with the given ID - -
Path Parameters
- -The contract definition - -
Schema
    assetsSelector object[]
- -Request was malformed, e.g. id was null - -
Schema array
- -An contract agreement with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-edr.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-edr.api.mdx deleted file mode 100644 index 07e041fcd41..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-edr.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-edr -title: "getEdr" -description: "Gets an EDR with the given transfer process ID" -sidebar_label: "getEdr" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Control Plane EDR Api"],"description":"Gets an EDR with the given transfer process ID","operationId":"getEdr","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"The EDR cached","content":{"application/json":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null}}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"An EDR with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"get","path":"/edrs/{id}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get Edr","description":{"content":"Gets an EDR with the given transfer process ID","type":"text/plain"},"url":{"path":["edrs",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getEdr - - - -Gets an EDR with the given transfer process ID - -
Path Parameters
- -The EDR cached - -
Schema
- -Request was malformed, e.g. id was null - -
Schema array
- -An EDR with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-liveness.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-liveness.api.mdx deleted file mode 100644 index be19e2ee985..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-liveness.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-liveness -title: "getLiveness" -description: "Performs a liveness probe to determine whether the runtime is working properly." -sidebar_label: "getLiveness" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Application Observability"],"description":"Performs a liveness probe to determine whether the runtime is working properly.","operationId":"getLiveness","responses":{"200":{"description":"The runtime is working properly.","content":{"application/json":{"schema":{"type":"object","properties":{"componentResults":{"type":"array","example":null,"items":{"type":"object","properties":{"component":{"type":"string","example":null},"failure":{"type":"object","properties":{"failureDetail":{"type":"string","example":null},"messages":{"type":"array","example":null,"items":{"type":"string","example":null}}},"example":null},"isHealthy":{"type":"boolean","example":null}},"example":null}},"isSystemHealthy":{"type":"boolean","example":null}},"example":null}}}}},"method":"get","path":"/check/liveness","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get Liveness","description":{"content":"Performs a liveness probe to determine whether the runtime is working properly.","type":"text/plain"},"url":{"path":["check","liveness"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getLiveness - - - -Performs a liveness probe to determine whether the runtime is working properly. - -
- -The runtime is working properly. - -
Schema
    componentResults object[]
    failure object
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-negotiation-state.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-negotiation-state.api.mdx deleted file mode 100644 index 15eaaeddf6d..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-negotiation-state.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-negotiation-state -title: "getNegotiationState" -description: "Gets the state of a contract negotiation with the given ID" -sidebar_label: "getNegotiationState" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Contract Negotiation"],"description":"Gets the state of a contract negotiation with the given ID","operationId":"getNegotiationState","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"The contract negotiation's state","content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"string","example":null}},"example":null}}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"An contract negotiation with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"get","path":"/v2/contractnegotiations/{id}/state","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get Negotiation State","description":{"content":"Gets the state of a contract negotiation with the given ID","type":"text/plain"},"url":{"path":["v2","contractnegotiations",":id","state"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getNegotiationState - - - -Gets the state of a contract negotiation with the given ID - -
Path Parameters
- -The contract negotiation's state - -
Schema
- -Request was malformed, e.g. id was null - -
Schema array
- -An contract negotiation with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-negotiation.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-negotiation.api.mdx deleted file mode 100644 index a580f5b1c16..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-negotiation.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-negotiation -title: "getNegotiation" -description: "Gets a contract negotiation with the given ID" -sidebar_label: "getNegotiation" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Contract Negotiation"],"description":"Gets a contract negotiation with the given ID","operationId":"getNegotiation","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"The contract negotiation","content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/ContractNegotiation"},"callbackAddresses":{"type":"array","example":null,"items":{"type":"object","properties":{"authCodeId":{"type":"string","example":null},"authKey":{"type":"string","example":null},"events":{"uniqueItems":true,"type":"array","example":null,"items":{"type":"string","example":null}},"transactional":{"type":"boolean","example":null},"uri":{"type":"string","example":null}},"example":null}},"contractAgreementId":{"type":"string","example":null},"counterPartyAddress":{"type":"string","example":null},"counterPartyId":{"type":"string","example":null},"errorDetail":{"type":"string","example":null},"protocol":{"type":"string","example":null},"state":{"type":"string","example":null},"type":{"type":"string","example":null,"enum":["CONSUMER","PROVIDER"]}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"https://w3id.org/edc/v0.0.1/ns/ContractNegotiation","@id":"negotiation-id","type":"PROVIDER","protocol":"dataspace-protocol-http","counterPartyId":"counter-party-id","counterPartyAddress":"http://counter/party/address","state":"VERIFIED","contractAgreementId":"contract:agreement:id","errorDetail":"eventual-error-detail","createdAt":1688465655,"callbackAddresses":[{"transactional":false,"uri":"http://callback/url","events":["contract.negotiation","transfer.process"],"authKey":"auth-key","authCodeId":"auth-code-id"}]}}}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"An contract negotiation with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"get","path":"/v2/contractnegotiations/{id}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get Negotiation","description":{"content":"Gets a contract negotiation with the given ID","type":"text/plain"},"url":{"path":["v2","contractnegotiations",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getNegotiation - - - -Gets a contract negotiation with the given ID - -
Path Parameters
- -The contract negotiation - -
Schema
    callbackAddresses object[]
- -Request was malformed, e.g. id was null - -
Schema array
- -An contract negotiation with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-policy-definition.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-policy-definition.api.mdx deleted file mode 100644 index 38145b11721..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-policy-definition.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-policy-definition -title: "getPolicyDefinition" -description: "Gets a policy definition with the given ID" -sidebar_label: "getPolicyDefinition" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Policy Definition"],"description":"Gets a policy definition with the given ID","operationId":"getPolicyDefinition","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"The policy definition","content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/PolicyDefinition"},"policy":{"type":"object","properties":{"@type":{"type":"string","example":null,"enum":["SET","OFFER","CONTRACT"]},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null}},"example":null},"target":{"type":"string","example":null}},"example":null}},"permissions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":"circular()","target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"definition-id","policy":{"@context":"http://www.w3.org/ns/odrl.jsonld","@type":"Set","uid":"http://example.com/policy:1010","permission":[{"target":"http://example.com/asset:9898.movie","action":"display","constraint":[{"leftOperand":"spatial","operator":"eq","rightOperand":"https://www.wikidata.org/wiki/Q183","comment":"i.e Germany"}]}]},"createdAt":1688465655}}}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"An policy definition with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"get","path":"/v2/policydefinitions/{id}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get Policy Definition","description":{"content":"Gets a policy definition with the given ID","type":"text/plain"},"url":{"path":["v2","policydefinitions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getPolicyDefinition - - - -Gets a policy definition with the given ID - -
Path Parameters
- -The policy definition - -
Schema
    policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -Request was malformed, e.g. id was null - -
Schema array
- -An policy definition with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-readiness.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-readiness.api.mdx deleted file mode 100644 index 6b3c5a1f12b..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-readiness.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-readiness -title: "getReadiness" -description: "Performs a readiness probe to determine whether the runtime is able to accept requests." -sidebar_label: "getReadiness" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Application Observability"],"description":"Performs a readiness probe to determine whether the runtime is able to accept requests.","operationId":"getReadiness","responses":{"200":{"description":"The runtime is able to accept requests.","content":{"application/json":{"schema":{"type":"object","properties":{"componentResults":{"type":"array","example":null,"items":{"type":"object","properties":{"component":{"type":"string","example":null},"failure":{"type":"object","properties":{"failureDetail":{"type":"string","example":null},"messages":{"type":"array","example":null,"items":{"type":"string","example":null}}},"example":null},"isHealthy":{"type":"boolean","example":null}},"example":null}},"isSystemHealthy":{"type":"boolean","example":null}},"example":null}}}}},"method":"get","path":"/check/readiness","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get Readiness","description":{"content":"Performs a readiness probe to determine whether the runtime is able to accept requests.","type":"text/plain"},"url":{"path":["check","readiness"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getReadiness - - - -Performs a readiness probe to determine whether the runtime is able to accept requests. - -
- -The runtime is able to accept requests. - -
Schema
    componentResults object[]
    failure object
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-startup.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-startup.api.mdx deleted file mode 100644 index 44392e7224d..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-startup.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-startup -title: "getStartup" -description: "Performs a startup probe to determine whether the runtime has completed startup." -sidebar_label: "getStartup" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Application Observability"],"description":"Performs a startup probe to determine whether the runtime has completed startup.","operationId":"getStartup","responses":{"200":{"description":"The runtime has completed startup.","content":{"application/json":{"schema":{"type":"object","properties":{"componentResults":{"type":"array","example":null,"items":{"type":"object","properties":{"component":{"type":"string","example":null},"failure":{"type":"object","properties":{"failureDetail":{"type":"string","example":null},"messages":{"type":"array","example":null,"items":{"type":"string","example":null}}},"example":null},"isHealthy":{"type":"boolean","example":null}},"example":null}},"isSystemHealthy":{"type":"boolean","example":null}},"example":null}}}}},"method":"get","path":"/check/startup","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get Startup","description":{"content":"Performs a startup probe to determine whether the runtime has completed startup.","type":"text/plain"},"url":{"path":["check","startup"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getStartup - - - -Performs a startup probe to determine whether the runtime has completed startup. - -
- -The runtime has completed startup. - -
Schema
    componentResults object[]
    failure object
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-transfer-process-state.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-transfer-process-state.api.mdx deleted file mode 100644 index 04a17f7b6c0..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-transfer-process-state.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-transfer-process-state -title: "getTransferProcessState" -description: "Gets the state of a transfer process with the given ID" -sidebar_label: "getTransferProcessState" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Transfer Process"],"description":"Gets the state of a transfer process with the given ID","operationId":"getTransferProcessState","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"The transfer process's state","content":{"application/json":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/TransferState"},"state":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"https://w3id.org/edc/v0.0.1/ns/TransferState","state":"STARTED"}}}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"An transfer process with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"get","path":"/v2/transferprocesses/{id}/state","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get Transfer Process State","description":{"content":"Gets the state of a transfer process with the given ID","type":"text/plain"},"url":{"path":["v2","transferprocesses",":id","state"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getTransferProcessState - - - -Gets the state of a transfer process with the given ID - -
Path Parameters
- -The transfer process's state - -
Schema
- -Request was malformed, e.g. id was null - -
Schema array
- -An transfer process with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-transfer-process.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-transfer-process.api.mdx deleted file mode 100644 index d2cef2389c2..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-transfer-process.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-transfer-process -title: "getTransferProcess" -description: "Gets an transfer process with the given ID" -sidebar_label: "getTransferProcess" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Transfer Process"],"description":"Gets an transfer process with the given ID","operationId":"getTransferProcess","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"The transfer process","content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/TransferProcess"},"callbackAddresses":{"type":"array","example":null,"items":{"type":"object","properties":{"authCodeId":{"type":"string","example":null},"authKey":{"type":"string","example":null},"events":{"uniqueItems":true,"type":"array","example":null,"items":{"type":"string","example":null}},"transactional":{"type":"boolean","example":null},"uri":{"type":"string","example":null}},"example":null}},"contractAgreementId":{"type":"string","example":null},"counterPartyAddress":{"type":"string","example":null},"counterPartyId":{"type":"string","example":null},"errorDetail":{"type":"string","example":null},"protocol":{"type":"string","example":null},"state":{"type":"string","example":null},"type":{"type":"string","example":null,"enum":["CONSUMER","PROVIDER"]}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"https://w3id.org/edc/v0.0.1/ns/TransferProcess","@id":"process-id","correlationId":"correlation-id","type":"PROVIDER","state":"STARTED","stateTimestamp":1688465655,"assetId":"asset-id","connectorId":"connectorId","contractId":"contractId","dataDestination":{"type":"data-destination-type"},"properties":{"key":"value"},"privateProperties":{"private-key":"private-value"},"errorDetail":"eventual-error-detail","createdAt":1688465655,"callbackAddresses":[{"transactional":false,"uri":"http://callback/url","events":["contract.negotiation","transfer.process"],"authKey":"auth-key","authCodeId":"auth-code-id"}]}}}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"A transfer process with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"get","path":"/v2/transferprocesses/{id}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get Transfer Process","description":{"content":"Gets an transfer process with the given ID","type":"text/plain"},"url":{"path":["v2","transferprocesses",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getTransferProcess - - - -Gets an transfer process with the given ID - -
Path Parameters
- -The transfer process - -
Schema
    callbackAddresses object[]
- -Request was malformed, e.g. id was null - -
Schema array
- -A transfer process with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-transfer-state.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-transfer-state.api.mdx deleted file mode 100644 index 49f8f1af373..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-transfer-state.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-transfer-state -title: "getTransferState" -description: "Get the current state of a data transfer." -sidebar_label: "getTransferState" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Data Plane control API"],"description":"Get the current state of a data transfer.","operationId":"getTransferState","parameters":[{"name":"processId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Missing access token"}},"method":"get","path":"/transfer/{processId}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get Transfer State","description":{"content":"Get the current state of a data transfer.","type":"text/plain"},"url":{"path":["transfer",":processId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"processId"}]},"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getTransferState - - - -Get the current state of a data transfer. - -
Path Parameters
- -Missing access token - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get.api.mdx deleted file mode 100644 index f3321088474..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get -title: "get" -description: "Send `GET` data query to the Data Plane." -sidebar_label: "get" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Data Plane public API"],"description":"Send `GET` data query to the Data Plane.","operationId":"get","responses":{"400":{"description":"Missing access token"},"403":{"description":"Access token is expired or invalid"},"500":{"description":"Failed to transfer data"}},"method":"get","path":"/{any}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"get","description":{"content":"Send `GET` data query to the Data Plane.","type":"text/plain"},"url":{"path":[":any"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## get - - - -Send `GET` data query to the Data Plane. - -
- -Missing access token - -
- -Access token is expired or invalid - -
- -Failed to transfer data - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/initiate-contract-negotiation.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/initiate-contract-negotiation.api.mdx deleted file mode 100644 index c954a828f9a..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/initiate-contract-negotiation.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: initiate-contract-negotiation -title: "initiateContractNegotiation" -description: "Initiates a contract negotiation for a given offer and with the given counter part. Please note that successfully invoking this endpoint only means that the negotiation was initiated. Clients must poll the /{id}/state endpoint to track the state" -sidebar_label: "initiateContractNegotiation" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Contract Negotiation"],"description":"Initiates a contract negotiation for a given offer and with the given counter part. Please note that successfully invoking this endpoint only means that the negotiation was initiated. Clients must poll the /{id}/state endpoint to track the state","operationId":"initiateContractNegotiation","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/ContractRequest"},"callbackAddresses":{"type":"array","example":null,"items":{"type":"object","properties":{"authCodeId":{"type":"string","example":null},"authKey":{"type":"string","example":null},"events":{"uniqueItems":true,"type":"array","example":null,"items":{"type":"string","example":null}},"transactional":{"type":"boolean","example":null},"uri":{"type":"string","example":null}},"example":null}},"connectorAddress":{"type":"string","example":null},"connectorId":{"type":"string","description":"please use providerId instead","example":null,"deprecated":true},"consumerId":{"type":"string","description":"this field is not used anymore","example":null,"deprecated":true},"offer":{"type":"object","properties":{"assetId":{"type":"string","example":null},"offerId":{"type":"string","example":null},"policy":{"type":"object","properties":{"@type":{"type":"string","example":null,"enum":["SET","OFFER","CONTRACT"]},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null}},"example":null},"target":{"type":"string","example":null}},"example":null}},"permissions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":"circular()","target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null}},"example":null},"protocol":{"type":"string","example":null},"providerId":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"https://w3id.org/edc/v0.0.1/ns/ContractRequest","connectorAddress":"http://provider-address","protocol":"dataspace-protocol-http","providerId":"provider-id","offer":{"offerId":"offer-id","assetId":"asset-id","policy":{"@context":"http://www.w3.org/ns/odrl.jsonld","@type":"Set","@id":"offer-id","permission":[{"target":"asset-id","action":"display"}]}},"callbackAddresses":[{"transactional":false,"uri":"http://callback/url","events":["contract.negotiation","transfer.process"],"authKey":"auth-key","authCodeId":"auth-code-id"}]}}}}},"responses":{"200":{"description":"The negotiation was successfully initiated. Returns the contract negotiation ID and created timestamp","content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"createdAt":{"type":"integer","format":"int64","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"id-value","createdAt":1688465655}}}},"links":{"poll-state":{"operationId":"getNegotiationState","parameters":{"id":"$response.body#/id"}}}},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/v2/contractnegotiations","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"https://w3id.org/edc/v0.0.1/ns/ContractRequest","connectorAddress":"http://provider-address","protocol":"dataspace-protocol-http","providerId":"provider-id","offer":{"offerId":"offer-id","assetId":"asset-id","policy":{"@context":"http://www.w3.org/ns/odrl.jsonld","@type":"Set","@id":"offer-id","permission":[{"target":"asset-id","action":"display"}]}},"callbackAddresses":[{"transactional":false,"uri":"http://callback/url","events":["contract.negotiation","transfer.process"],"authKey":"auth-key","authCodeId":"auth-code-id"}]},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"initiate Contract Negotiation","description":{"content":"Initiates a contract negotiation for a given offer and with the given counter part. Please note that successfully invoking this endpoint only means that the negotiation was initiated. Clients must poll the /{id}/state endpoint to track the state","type":"text/plain"},"url":{"path":["v2","contractnegotiations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## initiateContractNegotiation - - - -Initiates a contract negotiation for a given offer and with the given counter part. Please note that successfully invoking this endpoint only means that the negotiation was initiated. Clients must poll the /{id}/state endpoint to track the state - -
Request Body
    callbackAddresses object[]
    offer object
    policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -The negotiation was successfully initiated. Returns the contract negotiation ID and created timestamp - -
Schema
- -Request body was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/initiate-edr-negotiation.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/initiate-edr-negotiation.api.mdx deleted file mode 100644 index afa64f1b0dc..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/initiate-edr-negotiation.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: initiate-edr-negotiation -title: "initiateEdrNegotiation" -description: "Initiates an EDR negotiation by handling a contract negotiation first and then a transfer process for a given offer and with the given counter part. Please note that successfully invoking this endpoint only means that the negotiation was initiated." -sidebar_label: "initiateEdrNegotiation" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Control Plane EDR Api"],"description":"Initiates an EDR negotiation by handling a contract negotiation first and then a transfer process for a given offer and with the given counter part. Please note that successfully invoking this endpoint only means that the negotiation was initiated.","operationId":"initiateEdrNegotiation","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"empty":{"type":"boolean","example":null},"valueType":{"type":"string","example":null,"enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}},"additionalProperties":{"type":"object","properties":{"callbackAddresses":{"type":"array","example":null,"items":{"type":"object","properties":{"authCodeId":{"type":"string","example":null},"authKey":{"type":"string","example":null},"events":{"uniqueItems":true,"type":"array","example":null,"items":{"type":"string","example":null}},"transactional":{"type":"boolean","example":null},"uri":{"type":"string","example":null}},"example":null}},"connectorAddress":{"type":"string","example":null},"connectorId":{"type":"string","example":null},"offer":{"type":"object","properties":{"assetId":{"type":"string","example":null},"offerId":{"type":"string","example":null},"policy":{"type":"object","properties":{"@type":{"type":"string","example":null,"enum":["SET","OFFER","CONTRACT"]},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null}},"example":null},"target":{"type":"string","example":null}},"example":null}},"permissions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":"circular()","target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null}},"example":null},"protocol":{"type":"string","example":null},"providerId":{"type":"string","example":null}},"example":null},"example":null}}}},"responses":{"200":{"description":"The negotiation was successfully initiated.","content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"createdAt":{"type":"integer","format":"int64","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"id-value","createdAt":1688465655}}}}},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/edrs","servers":[{"url":"/"}],"jsonRequestBodyExample":null,"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"initiate Edr Negotiation","description":{"content":"Initiates an EDR negotiation by handling a contract negotiation first and then a transfer process for a given offer and with the given counter part. Please note that successfully invoking this endpoint only means that the negotiation was initiated.","type":"text/plain"},"url":{"path":["edrs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## initiateEdrNegotiation - - - -Initiates an EDR negotiation by handling a contract negotiation first and then a transfer process for a given offer and with the given counter part. Please note that successfully invoking this endpoint only means that the negotiation was initiated. - -
Request Body
- -The negotiation was successfully initiated. - -
Schema
- -Request body was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/initiate-transfer-process.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/initiate-transfer-process.api.mdx deleted file mode 100644 index 5fb3857abe5..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/initiate-transfer-process.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: initiate-transfer-process -title: "initiateTransferProcess" -description: "Initiates a data transfer with the given parameters. Please note that successfully invoking this endpoint only means that the transfer was initiated. Clients must poll the /{id}/state endpoint to track the state" -sidebar_label: "initiateTransferProcess" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Transfer Process"],"description":"Initiates a data transfer with the given parameters. Please note that successfully invoking this endpoint only means that the transfer was initiated. Clients must poll the /{id}/state endpoint to track the state","operationId":"initiateTransferProcess","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/TransferRequest"},"assetId":{"type":"string","example":null},"callbackAddresses":{"type":"array","example":null,"items":{"type":"object","properties":{"authCodeId":{"type":"string","example":null},"authKey":{"type":"string","example":null},"events":{"uniqueItems":true,"type":"array","example":null,"items":{"type":"string","example":null}},"transactional":{"type":"boolean","example":null},"uri":{"type":"string","example":null}},"example":null}},"connectorAddress":{"type":"string","example":null},"connectorId":{"type":"string","example":null},"contractId":{"type":"string","example":null},"dataDestination":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"privateProperties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null},"properties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null},"protocol":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"https://w3id.org/edc/v0.0.1/ns/TransferRequest","protocol":"dataspace-protocol-http","connectorAddress":"http://provider-address","connectorId":"provider-id","contractId":"contract-id","assetId":"asset-id","dataDestination":{"type":"data-destination-type"},"properties":{"key":"value"},"privateProperties":{"private-key":"private-value"},"callbackAddresses":[{"transactional":false,"uri":"http://callback/url","events":["contract.negotiation","transfer.process"],"authKey":"auth-key","authCodeId":"auth-code-id"}]}}}}},"responses":{"200":{"description":"The transfer was successfully initiated. Returns the transfer process ID and created timestamp","content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"createdAt":{"type":"integer","format":"int64","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"id-value","createdAt":1688465655}}}},"links":{"poll-state":{"operationId":"getTransferProcessState","parameters":{"id":"$response.body#/id"}}}},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/v2/transferprocesses","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"https://w3id.org/edc/v0.0.1/ns/TransferRequest","protocol":"dataspace-protocol-http","connectorAddress":"http://provider-address","connectorId":"provider-id","contractId":"contract-id","assetId":"asset-id","dataDestination":{"type":"data-destination-type"},"properties":{"key":"value"},"privateProperties":{"private-key":"private-value"},"callbackAddresses":[{"transactional":false,"uri":"http://callback/url","events":["contract.negotiation","transfer.process"],"authKey":"auth-key","authCodeId":"auth-code-id"}]},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"initiate Transfer Process","description":{"content":"Initiates a data transfer with the given parameters. Please note that successfully invoking this endpoint only means that the transfer was initiated. Clients must poll the /{id}/state endpoint to track the state","type":"text/plain"},"url":{"path":["v2","transferprocesses"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## initiateTransferProcess - - - -Initiates a data transfer with the given parameters. Please note that successfully invoking this endpoint only means that the transfer was initiated. Clients must poll the /{id}/state endpoint to track the state - -
Request Body
    callbackAddresses object[]
    dataDestination object
    privateProperties object
  • property name* string
    • properties object
  • property name* string
- -The transfer was successfully initiated. Returns the transfer process ID and created timestamp - -
Schema
- -Request body was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/initiate-transfer.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/initiate-transfer.api.mdx deleted file mode 100644 index f684c008f2b..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/initiate-transfer.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: initiate-transfer -title: "initiateTransfer" -description: "Initiates a data transfer for the given request. The transfer will be performed asynchronously." -sidebar_label: "initiateTransfer" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Data Plane control API"],"description":"Initiates a data transfer for the given request. The transfer will be performed asynchronously.","operationId":"initiateTransfer","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"callbackAddress":{"type":"string","format":"url","example":null},"destinationDataAddress":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"id":{"type":"string","example":null},"processId":{"type":"string","example":null},"properties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null},"sourceDataAddress":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"traceContext":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null},"trackable":{"type":"boolean","example":null}},"example":null}}}},"responses":{"200":{"description":"Data transfer initiated"},"400":{"description":"Failed to validate request"}},"method":"post","path":"/transfer","servers":[{"url":"/"}],"jsonRequestBodyExample":null,"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"initiate Transfer","description":{"content":"Initiates a data transfer for the given request. The transfer will be performed asynchronously.","type":"text/plain"},"url":{"path":["transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## initiateTransfer - - - -Initiates a data transfer for the given request. The transfer will be performed asynchronously. - -
Request Body
    destinationDataAddress object
    properties object
  • property name* string
    • sourceDataAddress object
    traceContext object
  • property name* string
- -Data transfer initiated - -
- -Failed to validate request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/patch.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/patch.api.mdx deleted file mode 100644 index eaeed3a15c9..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/patch.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: patch -title: "patch" -description: "Send `PATCH` data query to the Data Plane." -sidebar_label: "patch" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Data Plane public API"],"description":"Send `PATCH` data query to the Data Plane.","operationId":"patch","responses":{"400":{"description":"Missing access token"},"403":{"description":"Access token is expired or invalid"},"500":{"description":"Failed to transfer data"}},"method":"patch","path":"/{any}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"patch","description":{"content":"Send `PATCH` data query to the Data Plane.","type":"text/plain"},"url":{"path":[":any"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"PATCH"}} -sidebar_class_name: "patch api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## patch - - - -Send `PATCH` data query to the Data Plane. - -
- -Missing access token - -
- -Access token is expired or invalid - -
- -Failed to transfer data - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/post.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/post.api.mdx deleted file mode 100644 index f5d969c439f..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/post.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: post -title: "post" -description: "Send `POST` data query to the Data Plane." -sidebar_label: "post" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Data Plane public API"],"description":"Send `POST` data query to the Data Plane.","operationId":"post","responses":{"400":{"description":"Missing access token"},"403":{"description":"Access token is expired or invalid"},"500":{"description":"Failed to transfer data"}},"method":"post","path":"/{any}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"post","description":{"content":"Send `POST` data query to the Data Plane.","type":"text/plain"},"url":{"path":[":any"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## post - - - -Send `POST` data query to the Data Plane. - -
- -Missing access token - -
- -Access token is expired or invalid - -
- -Failed to transfer data - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/put.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/put.api.mdx deleted file mode 100644 index ba74f2859fc..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/put.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: put -title: "put" -description: "Send `PUT` data query to the Data Plane." -sidebar_label: "put" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Data Plane public API"],"description":"Send `PUT` data query to the Data Plane.","operationId":"put","responses":{"400":{"description":"Missing access token"},"403":{"description":"Access token is expired or invalid"},"500":{"description":"Failed to transfer data"}},"method":"put","path":"/{any}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"put","description":{"content":"Send `PUT` data query to the Data Plane.","type":"text/plain"},"url":{"path":[":any"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"PUT"}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## put - - - -Send `PUT` data query to the Data Plane. - -
- -Missing access token - -
- -Access token is expired or invalid - -
- -Failed to transfer data - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-all-agreements.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-all-agreements.api.mdx deleted file mode 100644 index 410d6313adb..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-all-agreements.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: query-all-agreements -title: "queryAllAgreements" -description: "Gets all contract agreements according to a particular query" -sidebar_label: "queryAllAgreements" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Contract Agreement"],"description":"Gets all contract agreements according to a particular query","operationId":"queryAllAgreements","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/QuerySpec"},"filterExpression":{"type":"array","example":null,"items":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/Criterion"},"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"Criterion","operandLeft":"fieldName","operator":"=","operandRight":"some value"}}},"limit":{"type":"integer","format":"int32","example":null},"offset":{"type":"integer","format":"int32","example":null},"sortField":{"type":"string","example":null},"sortOrder":{"type":"string","example":null,"enum":["ASC","DESC"]}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"QuerySpec","offset":5,"limit":10,"sortOrder":"DESC","sortField":"fieldName","filterExpression":[]}}}}},"responses":{"200":{"description":"The contract agreements matching the query","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/ContractAgreement"},"assetId":{"type":"string","example":null},"consumerId":{"type":"string","example":null},"contractSigningDate":{"type":"integer","format":"int64","example":null},"policy":{"type":"object","properties":{"@type":{"type":"string","example":null,"enum":["SET","OFFER","CONTRACT"]},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null}},"example":null},"target":{"type":"string","example":null}},"example":null}},"permissions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":"circular()","target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null},"providerId":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"https://w3id.org/edc/v0.0.1/ns/ContractAgreement","@id":"negotiation-id","providerId":"provider-id","consumerId":"consumer-id","assetId":"asset-id","contractSigningDate":1688465655,"policy":{"@context":"http://www.w3.org/ns/odrl.jsonld","@type":"Set","@id":"offer-id","permission":[{"target":"asset-id","action":"display"}]}}}}}}},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/v2/contractagreements/request","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"query All Agreements","description":{"content":"Gets all contract agreements according to a particular query","type":"text/plain"},"url":{"path":["v2","contractagreements","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"*/*"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\""}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## queryAllAgreements - - - -Gets all contract agreements according to a particular query - -
Request Body
    filterExpression object[]
- -The contract agreements matching the query - -
Schema array
    policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -Request body was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-all-contract-definitions.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-all-contract-definitions.api.mdx deleted file mode 100644 index 1aed027b0ff..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-all-contract-definitions.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: query-all-contract-definitions -title: "queryAllContractDefinitions" -description: "Returns all contract definitions according to a query" -sidebar_label: "queryAllContractDefinitions" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Contract Definition"],"description":"Returns all contract definitions according to a query","operationId":"queryAllContractDefinitions","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/QuerySpec"},"filterExpression":{"type":"array","example":null,"items":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/Criterion"},"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"Criterion","operandLeft":"fieldName","operator":"=","operandRight":"some value"}}},"limit":{"type":"integer","format":"int32","example":null},"offset":{"type":"integer","format":"int32","example":null},"sortField":{"type":"string","example":null},"sortOrder":{"type":"string","example":null,"enum":["ASC","DESC"]}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"QuerySpec","offset":5,"limit":10,"sortOrder":"DESC","sortField":"fieldName","filterExpression":[]}}}}},"responses":{"200":{"description":"The contract definitions matching the query","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/ContractDefinition"},"accessPolicyId":{"type":"string","example":null},"assetsSelector":{"type":"array","example":null,"items":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/Criterion"},"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"Criterion","operandLeft":"fieldName","operator":"=","operandRight":"some value"}}},"contractPolicyId":{"type":"string","example":null},"createdAt":{"type":"integer","format":"int64","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"definition-id","edc:accessPolicyId":"asset-policy-id","edc:contractPolicyId":"contract-policy-id","edc:assetsSelector":[],"edc:createdAt":1688465655}}}}}},"400":{"description":"Request was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/v2/contractdefinitions/request","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"query All Contract Definitions","description":{"content":"Returns all contract definitions according to a query","type":"text/plain"},"url":{"path":["v2","contractdefinitions","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"*/*"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\""}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## queryAllContractDefinitions - - - -Returns all contract definitions according to a query - -
Request Body
    filterExpression object[]
- -The contract definitions matching the query - -
Schema array
    assetsSelector object[]
- -Request was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-edrs.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-edrs.api.mdx deleted file mode 100644 index 3766d192564..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-edrs.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: query-edrs -title: "queryEdrs" -description: "Returns all EndpointDataReference entry according to a query" -sidebar_label: "queryEdrs" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Control Plane EDR Api"],"description":"Returns all EndpointDataReference entry according to a query","operationId":"queryEdrs","parameters":[{"name":"assetId","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","example":null}},{"name":"agreementId","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","example":null}},{"name":"providerId","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"agreementId":{"type":"string","example":null},"assetId":{"type":"string","example":null},"createdAt":{"type":"integer","format":"int64","example":null},"errorDetail":{"type":"string","example":null},"expirationTimestamp":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null},"providerId":{"type":"string","example":null},"state":{"type":"integer","format":"int32","example":null},"stateCount":{"type":"integer","format":"int32","example":null},"stateTimestamp":{"type":"integer","format":"int64","example":null},"traceContext":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null},"transferProcessId":{"type":"string","example":null},"updatedAt":{"type":"integer","format":"int64","example":null}},"example":null}}}}},"400":{"description":"Request was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"get","path":"/edrs","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"query Edrs","description":{"content":"Returns all EndpointDataReference entry according to a query","type":"text/plain"},"url":{"path":["edrs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"assetId","value":""},{"disabled":false,"key":"agreementId","value":""},{"disabled":false,"key":"providerId","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## queryEdrs - - - -Returns all EndpointDataReference entry according to a query - -
Query Parameters
Schema array
    traceContext object
  • property name* string
- -Request was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-negotiations.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-negotiations.api.mdx deleted file mode 100644 index ff1ba8aba03..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-negotiations.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: query-negotiations -title: "queryNegotiations" -description: "Returns all contract negotiations according to a query" -sidebar_label: "queryNegotiations" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Contract Negotiation"],"description":"Returns all contract negotiations according to a query","operationId":"queryNegotiations","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/QuerySpec"},"filterExpression":{"type":"array","example":null,"items":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/Criterion"},"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"Criterion","operandLeft":"fieldName","operator":"=","operandRight":"some value"}}},"limit":{"type":"integer","format":"int32","example":null},"offset":{"type":"integer","format":"int32","example":null},"sortField":{"type":"string","example":null},"sortOrder":{"type":"string","example":null,"enum":["ASC","DESC"]}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"QuerySpec","offset":5,"limit":10,"sortOrder":"DESC","sortField":"fieldName","filterExpression":[]}}}}},"responses":{"200":{"description":"The contract negotiations that match the query","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/ContractNegotiation"},"callbackAddresses":{"type":"array","example":null,"items":{"type":"object","properties":{"authCodeId":{"type":"string","example":null},"authKey":{"type":"string","example":null},"events":{"uniqueItems":true,"type":"array","example":null,"items":{"type":"string","example":null}},"transactional":{"type":"boolean","example":null},"uri":{"type":"string","example":null}},"example":null}},"contractAgreementId":{"type":"string","example":null},"counterPartyAddress":{"type":"string","example":null},"counterPartyId":{"type":"string","example":null},"errorDetail":{"type":"string","example":null},"protocol":{"type":"string","example":null},"state":{"type":"string","example":null},"type":{"type":"string","example":null,"enum":["CONSUMER","PROVIDER"]}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"https://w3id.org/edc/v0.0.1/ns/ContractNegotiation","@id":"negotiation-id","type":"PROVIDER","protocol":"dataspace-protocol-http","counterPartyId":"counter-party-id","counterPartyAddress":"http://counter/party/address","state":"VERIFIED","contractAgreementId":"contract:agreement:id","errorDetail":"eventual-error-detail","createdAt":1688465655,"callbackAddresses":[{"transactional":false,"uri":"http://callback/url","events":["contract.negotiation","transfer.process"],"authKey":"auth-key","authCodeId":"auth-code-id"}]}}}}}},"400":{"description":"Request was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/v2/contractnegotiations/request","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"QuerySpec","offset":5,"limit":10,"sortOrder":"DESC","sortField":"fieldName","filterExpression":[]},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"query Negotiations","description":{"content":"Returns all contract negotiations according to a query","type":"text/plain"},"url":{"path":["v2","contractnegotiations","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## queryNegotiations - - - -Returns all contract negotiations according to a query - -
Request Body
    filterExpression object[]
- -The contract negotiations that match the query - -
Schema array
    callbackAddresses object[]
- -Request was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-policy-definitions.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-policy-definitions.api.mdx deleted file mode 100644 index d6f9b2ba231..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-policy-definitions.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: query-policy-definitions -title: "queryPolicyDefinitions" -description: "Returns all policy definitions according to a query" -sidebar_label: "queryPolicyDefinitions" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Policy Definition"],"description":"Returns all policy definitions according to a query","operationId":"queryPolicyDefinitions","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/QuerySpec"},"filterExpression":{"type":"array","example":null,"items":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/Criterion"},"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"Criterion","operandLeft":"fieldName","operator":"=","operandRight":"some value"}}},"limit":{"type":"integer","format":"int32","example":null},"offset":{"type":"integer","format":"int32","example":null},"sortField":{"type":"string","example":null},"sortOrder":{"type":"string","example":null,"enum":["ASC","DESC"]}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"QuerySpec","offset":5,"limit":10,"sortOrder":"DESC","sortField":"fieldName","filterExpression":[]}}}}},"responses":{"200":{"description":"The policy definitions matching the query","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/PolicyDefinition"},"policy":{"type":"object","properties":{"@type":{"type":"string","example":null,"enum":["SET","OFFER","CONTRACT"]},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null}},"example":null},"target":{"type":"string","example":null}},"example":null}},"permissions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":"circular()","target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"definition-id","policy":{"@context":"http://www.w3.org/ns/odrl.jsonld","@type":"Set","uid":"http://example.com/policy:1010","permission":[{"target":"http://example.com/asset:9898.movie","action":"display","constraint":[{"leftOperand":"spatial","operator":"eq","rightOperand":"https://www.wikidata.org/wiki/Q183","comment":"i.e Germany"}]}]},"createdAt":1688465655}}}}}},"400":{"description":"Request was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/v2/policydefinitions/request","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"QuerySpec","offset":5,"limit":10,"sortOrder":"DESC","sortField":"fieldName","filterExpression":[]},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"query Policy Definitions","description":{"content":"Returns all policy definitions according to a query","type":"text/plain"},"url":{"path":["v2","policydefinitions","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## queryPolicyDefinitions - - - -Returns all policy definitions according to a query - -
Request Body
    filterExpression object[]
- -The policy definitions matching the query - -
Schema array
    policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -Request was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-transfer-processes.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-transfer-processes.api.mdx deleted file mode 100644 index dca70e5e594..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-transfer-processes.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: query-transfer-processes -title: "queryTransferProcesses" -description: "Returns all transfer process according to a query" -sidebar_label: "queryTransferProcesses" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Transfer Process"],"description":"Returns all transfer process according to a query","operationId":"queryTransferProcesses","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/QuerySpec"},"filterExpression":{"type":"array","example":null,"items":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/Criterion"},"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"Criterion","operandLeft":"fieldName","operator":"=","operandRight":"some value"}}},"limit":{"type":"integer","format":"int32","example":null},"offset":{"type":"integer","format":"int32","example":null},"sortField":{"type":"string","example":null},"sortOrder":{"type":"string","example":null,"enum":["ASC","DESC"]}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"QuerySpec","offset":5,"limit":10,"sortOrder":"DESC","sortField":"fieldName","filterExpression":[]}}}}},"responses":{"200":{"description":"The transfer processes matching the query","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/TransferProcess"},"callbackAddresses":{"type":"array","example":null,"items":{"type":"object","properties":{"authCodeId":{"type":"string","example":null},"authKey":{"type":"string","example":null},"events":{"uniqueItems":true,"type":"array","example":null,"items":{"type":"string","example":null}},"transactional":{"type":"boolean","example":null},"uri":{"type":"string","example":null}},"example":null}},"contractAgreementId":{"type":"string","example":null},"counterPartyAddress":{"type":"string","example":null},"counterPartyId":{"type":"string","example":null},"errorDetail":{"type":"string","example":null},"protocol":{"type":"string","example":null},"state":{"type":"string","example":null},"type":{"type":"string","example":null,"enum":["CONSUMER","PROVIDER"]}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"https://w3id.org/edc/v0.0.1/ns/TransferProcess","@id":"process-id","correlationId":"correlation-id","type":"PROVIDER","state":"STARTED","stateTimestamp":1688465655,"assetId":"asset-id","connectorId":"connectorId","contractId":"contractId","dataDestination":{"type":"data-destination-type"},"properties":{"key":"value"},"privateProperties":{"private-key":"private-value"},"errorDetail":"eventual-error-detail","createdAt":1688465655,"callbackAddresses":[{"transactional":false,"uri":"http://callback/url","events":["contract.negotiation","transfer.process"],"authKey":"auth-key","authCodeId":"auth-code-id"}]}}}}}},"400":{"description":"Request was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/v2/transferprocesses/request","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"QuerySpec","offset":5,"limit":10,"sortOrder":"DESC","sortField":"fieldName","filterExpression":[]},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"query Transfer Processes","description":{"content":"Returns all transfer process according to a query","type":"text/plain"},"url":{"path":["v2","transferprocesses","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## queryTransferProcesses - - - -Returns all transfer process according to a query - -
Request Body
    filterExpression object[]
- -The transfer processes matching the query - -
Schema array
    callbackAddresses object[]
- -Request was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/remove-asset-1.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/remove-asset-1.api.mdx deleted file mode 100644 index a4d76c36760..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/remove-asset-1.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: remove-asset-1 -title: "removeAsset_1" -description: "Removes an asset with the given ID if possible. Deleting an asset is only possible if that asset is not yet referenced by a contract agreement, in which case an error is returned. DANGER ZONE: Note that deleting assets can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations." -sidebar_label: "removeAsset_1" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset"],"description":"Removes an asset with the given ID if possible. Deleting an asset is only possible if that asset is not yet referenced by a contract agreement, in which case an error is returned. DANGER ZONE: Note that deleting assets can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations.","operationId":"removeAsset_1","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Asset was deleted successfully"},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"An asset with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"409":{"description":"The asset cannot be deleted, because it is referenced by a contract agreement","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"delete","path":"/v3/assets/{id}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"remove Asset 1","description":{"content":"Removes an asset with the given ID if possible. Deleting an asset is only possible if that asset is not yet referenced by a contract agreement, in which case an error is returned. DANGER ZONE: Note that deleting assets can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations.","type":"text/plain"},"url":{"path":["v3","assets",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## removeAsset_1 - - - -Removes an asset with the given ID if possible. Deleting an asset is only possible if that asset is not yet referenced by a contract agreement, in which case an error is returned. DANGER ZONE: Note that deleting assets can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations. - -
Path Parameters
- -Asset was deleted successfully - -
- -Request was malformed, e.g. id was null - -
Schema array
- -An asset with the given ID does not exist - -
Schema array
- -The asset cannot be deleted, because it is referenced by a contract agreement - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/remove-asset.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/remove-asset.api.mdx deleted file mode 100644 index 1ae7e07115e..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/remove-asset.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: remove-asset -title: "removeAsset" -description: "Removes an asset with the given ID if possible. Deleting an asset is only possible if that asset is not yet referenced by a contract agreement, in which case an error is returned. DANGER ZONE: Note that deleting assets can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations." -sidebar_label: "removeAsset" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset"],"description":"Removes an asset with the given ID if possible. Deleting an asset is only possible if that asset is not yet referenced by a contract agreement, in which case an error is returned. DANGER ZONE: Note that deleting assets can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations.","operationId":"removeAsset","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Asset was deleted successfully"},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"An asset with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"409":{"description":"The asset cannot be deleted, because it is referenced by a contract agreement","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"deprecated":true,"method":"delete","path":"/v2/assets/{id}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"remove Asset","description":{"content":"Removes an asset with the given ID if possible. Deleting an asset is only possible if that asset is not yet referenced by a contract agreement, in which case an error is returned. DANGER ZONE: Note that deleting assets can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations.","type":"text/plain"},"url":{"path":["v2","assets",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## removeAsset - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Removes an asset with the given ID if possible. Deleting an asset is only possible if that asset is not yet referenced by a contract agreement, in which case an error is returned. DANGER ZONE: Note that deleting assets can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations. - -
Path Parameters
- -Asset was deleted successfully - -
- -Request was malformed, e.g. id was null - -
Schema array
- -An asset with the given ID does not exist - -
Schema array
- -The asset cannot be deleted, because it is referenced by a contract agreement - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-asset.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-asset.api.mdx deleted file mode 100644 index baa335693c5..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-asset.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: request-asset -title: "requestAsset" -description: "requestAsset" -sidebar_label: "requestAsset" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Data Plane Proxy API"],"operationId":"requestAsset","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"assetId":{"type":"string","example":null},"endpointUrl":{"type":"string","example":null},"pathSegments":{"type":"string","example":null},"providerId":{"type":"string","example":null},"queryParams":{"type":"string","example":null},"transferProcessId":{"type":"string","example":null}},"example":null}}}},"responses":{"default":{"description":"Requests asset data","content":{"application/json":{"schema":{"type":"object","properties":{"assetId":{"type":"string","example":null},"endpointUrl":{"type":"string","example":null},"pathSegments":{"type":"string","example":null},"providerId":{"type":"string","example":null},"queryParams":{"type":"string","example":null},"transferProcessId":{"type":"string","example":null}},"example":null}}}}},"description":"requestAsset","method":"post","path":"/aas/request","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"request Asset","description":{"type":"text/plain"},"url":{"path":["aas","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"*/*"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\""}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## requestAsset - - - -requestAsset - -
Request Body
- -Requests asset data - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-assets-1.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-assets-1.api.mdx deleted file mode 100644 index bcd9cedf2ac..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-assets-1.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: request-assets-1 -title: "requestAssets_1" -description: " all assets according to a particular query" -sidebar_label: "requestAssets_1" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset"],"description":" all assets according to a particular query","operationId":"requestAssets_1","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/QuerySpec"},"filterExpression":{"type":"array","example":null,"items":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/Criterion"},"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"Criterion","operandLeft":"fieldName","operator":"=","operandRight":"some value"}}},"limit":{"type":"integer","format":"int32","example":null},"offset":{"type":"integer","format":"int32","example":null},"sortField":{"type":"string","example":null},"sortOrder":{"type":"string","example":null,"enum":["ASC","DESC"]}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"QuerySpec","offset":5,"limit":10,"sortOrder":"DESC","sortField":"fieldName","filterExpression":[]}}}}},"responses":{"200":{"description":"The assets matching the query","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/Asset"},"createdAt":{"type":"integer","format":"int64","example":null},"dataAddress":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"privateProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"definition-id","edc:properties":{"edc:key":"value"},"edc:privateProperties":{"edc:privateKey":"privateValue"},"edc:dataAddress":{"edc:type":"HttpData"},"edc:createdAt":1688465655}}}}}},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/v3/assets/request","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"QuerySpec","offset":5,"limit":10,"sortOrder":"DESC","sortField":"fieldName","filterExpression":[]},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"request Assets 1","description":{"content":" all assets according to a particular query","type":"text/plain"},"url":{"path":["v3","assets","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## requestAssets_1 - - - - all assets according to a particular query - -
Request Body
    filterExpression object[]
- -The assets matching the query - -
Schema array
    dataAddress object
    privateProperties object
  • property name* object
    • properties object
  • property name* object
- -Request body was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-assets.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-assets.api.mdx deleted file mode 100644 index 52cfd8f6ca3..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-assets.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: request-assets -title: "requestAssets" -description: " all assets according to a particular query" -sidebar_label: "requestAssets" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset"],"description":" all assets according to a particular query","operationId":"requestAssets","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/QuerySpec"},"filterExpression":{"type":"array","example":null,"items":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/Criterion"},"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"Criterion","operandLeft":"fieldName","operator":"=","operandRight":"some value"}}},"limit":{"type":"integer","format":"int32","example":null},"offset":{"type":"integer","format":"int32","example":null},"sortField":{"type":"string","example":null},"sortOrder":{"type":"string","example":null,"enum":["ASC","DESC"]}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"QuerySpec","offset":5,"limit":10,"sortOrder":"DESC","sortField":"fieldName","filterExpression":[]}}}}},"responses":{"200":{"description":"The assets matching the query","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"createdAt":{"type":"integer","format":"int64","example":null},"dataAddress":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"id":{"type":"string","example":null},"privateProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}},"example":null}}}}},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"deprecated":true,"method":"post","path":"/v2/assets/request","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"QuerySpec","offset":5,"limit":10,"sortOrder":"DESC","sortField":"fieldName","filterExpression":[]},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"request Assets","description":{"content":" all assets according to a particular query","type":"text/plain"},"url":{"path":["v2","assets","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## requestAssets - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - - all assets according to a particular query - -
Request Body
    filterExpression object[]
- -The assets matching the query - -
Schema array
    dataAddress object
    privateProperties object
  • property name* object
    • properties object
  • property name* object
- -Request body was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-catalog.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-catalog.api.mdx deleted file mode 100644 index 3b6bc2afc40..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-catalog.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: request-catalog -title: "requestCatalog" -description: "requestCatalog" -sidebar_label: "requestCatalog" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Catalog"],"operationId":"requestCatalog","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/CatalogRequest"},"protocol":{"type":"string","example":null},"querySpec":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/QuerySpec"},"filterExpression":{"type":"array","example":null,"items":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/Criterion"},"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"Criterion","operandLeft":"fieldName","operator":"=","operandRight":"some value"}}},"limit":{"type":"integer","format":"int32","example":null},"offset":{"type":"integer","format":"int32","example":null},"sortField":{"type":"string","example":null},"sortOrder":{"type":"string","example":null,"enum":["ASC","DESC"]}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"QuerySpec","offset":5,"limit":10,"sortOrder":"DESC","sortField":"fieldName","filterExpression":[]}}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"CatalogRequest","providerUrl":"http://provider-address","protocol":"dataspace-protocol-http","querySpec":{"offset":0,"limit":50,"sortOrder":"DESC","sortField":"fieldName","filterExpression":[]}}}}}},"responses":{"default":{"description":"Gets contract offers (=catalog) of a single connector","content":{"application/json":{"schema":{"type":"object","description":"DCAT catalog","example":{"@id":"7df65569-8c59-4013-b1c0-fa14f6641bf2","@type":"dcat:Catalog","dcat:dataset":{"@id":"bcca61be-e82e-4da6-bfec-9716a56cef35","@type":"dcat:Dataset","odrl:hasPolicy":{"@id":"OGU0ZTMzMGMtODQ2ZS00ZWMxLThmOGQtNWQxNWM0NmI2NmY4:YmNjYTYxYmUtZTgyZS00ZGE2LWJmZWMtOTcxNmE1NmNlZjM1:NDY2ZTZhMmEtNjQ1Yy00ZGQ0LWFlZDktMjdjNGJkZTU4MDNj","@type":"odrl:Set","odrl:permission":{"odrl:target":"bcca61be-e82e-4da6-bfec-9716a56cef35","odrl:action":{"odrl:type":"http://www.w3.org/ns/odrl/2/use"},"odrl:constraint":{"odrl:and":[{"odrl:leftOperand":"https://w3id.org/edc/v0.0.1/ns/inForceDate","odrl:operator":{"@id":"odrl:gteq"},"odrl:rightOperand":"2023-07-07T07:19:58.585601395Z"},{"odrl:leftOperand":"https://w3id.org/edc/v0.0.1/ns/inForceDate","odrl:operator":{"@id":"odrl:lteq"},"odrl:rightOperand":"2023-07-12T07:19:58.585601395Z"}]}},"odrl:prohibition":[],"odrl:obligation":[],"odrl:target":"bcca61be-e82e-4da6-bfec-9716a56cef35"},"dcat:distribution":[{"@type":"dcat:Distribution","dct:format":{"@id":"HttpData"},"dcat:accessService":"5e839777-d93e-4785-8972-1005f51cf367"}],"edc:description":"description","edc:id":"bcca61be-e82e-4da6-bfec-9716a56cef35"},"dcat:service":{"@id":"5e839777-d93e-4785-8972-1005f51cf367","@type":"dcat:DataService","dct:terms":"connector","dct:endpointUrl":"http://localhost:16806/protocol"},"edc:participantId":"urn:connector:provider","@context":{"dct":"https://purl.org/dc/terms/","edc":"https://w3id.org/edc/v0.0.1/ns/","dcat":"https://www.w3.org/ns/dcat/","odrl":"http://www.w3.org/ns/odrl/2/","dspace":"https://w3id.org/dspace/v0.8/"}}}}}}},"description":"requestCatalog","method":"post","path":"/v2/catalog/request","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"CatalogRequest","providerUrl":"http://provider-address","protocol":"dataspace-protocol-http","querySpec":{"offset":0,"limit":50,"sortOrder":"DESC","sortField":"fieldName","filterExpression":[]}},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"request Catalog","description":{"type":"text/plain"},"url":{"path":["v2","catalog","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## requestCatalog - - - -requestCatalog - -
Request Body
    querySpec object
    filterExpression object[]
- -Gets contract offers (=catalog) of a single connector - -
Schema
  • object
    - -DCAT catalog - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/resolve.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/resolve.api.mdx deleted file mode 100644 index 3f9b88d2db3..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/resolve.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: resolve -title: "resolve" -description: "Resolves all groups for a particular BPN" -sidebar_label: "resolve" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Business Partner Group"],"description":"Resolves all groups for a particular BPN","operationId":"resolve","parameters":[{"name":"bpn","in":"path","description":"The business partner number","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"An object containing an array with the assigned groups"},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"No entry for the given BPN was found"}},"method":"get","path":"/business-partner-groups/{bpn}","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"resolve","description":{"content":"Resolves all groups for a particular BPN","type":"text/plain"},"url":{"path":["business-partner-groups",":bpn"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The business partner number","type":"text/plain"},"type":"any","value":"","key":"bpn"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## resolve - - - -Resolves all groups for a particular BPN - -
Path Parameters
- -An object containing an array with the assigned groups - -
- -Request body was malformed - -
Schema array
- -No entry for the given BPN was found - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/sidebar.js b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/sidebar.js deleted file mode 100644 index 21e2fbb7dc8..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api"},{"type":"category","label":"Data Plane control API","link":{"type":"generated-index","title":"Data Plane control API","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/data-plane-control-api"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/initiate-transfer","label":"initiateTransfer","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-transfer-state","label":"getTransferState","className":"api-method get"}]},{"type":"category","label":"Data Plane public API","link":{"type":"generated-index","title":"Data Plane public API","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/data-plane-public-api"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get","label":"get","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/put","label":"put","className":"api-method put"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/post","label":"post","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete","label":"delete","className":"api-method delete"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/patch","label":"patch","className":"api-method patch"}]},{"type":"category","label":"Data Plane Proxy API","link":{"type":"generated-index","title":"Data Plane Proxy API","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/data-plane-proxy-api"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-asset","label":"requestAsset","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-asset","label":"requestAsset","className":"api-method get"}]},{"type":"category","label":"Business Partner Group","link":{"type":"generated-index","title":"Business Partner Group","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/business-partner-group"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-entry","label":"updateEntry","className":"api-method put"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-entry","label":"createEntry","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/resolve","label":"resolve","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete-entry","label":"deleteEntry","className":"api-method delete"}]},{"type":"category","label":"HTTP Provisioner Webhook","link":{"type":"generated-index","title":"HTTP Provisioner Webhook","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/http-provisioner-webhook"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/call-deprovision-webhook","label":"callDeprovisionWebhook","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/call-provision-webhook","label":"callProvisionWebhook","className":"api-method post"}]},{"type":"category","label":"Application Observability","link":{"type":"generated-index","title":"Application Observability","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/application-observability"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/check-health","label":"checkHealth","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-liveness","label":"getLiveness","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-readiness","label":"getReadiness","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-startup","label":"getStartup","className":"api-method get"}]},{"type":"category","label":"Control Plane EDR Api","link":{"type":"generated-index","title":"Control Plane EDR Api","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/control-plane-edr-api"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-edrs","label":"queryEdrs","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/initiate-edr-negotiation","label":"initiateEdrNegotiation","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-edr","label":"getEdr","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete-edr","label":"deleteEdr","className":"api-method delete"}]},{"type":"category","label":"Dataplane Selector","link":{"type":"generated-index","title":"Dataplane Selector","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/dataplane-selector"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/find","label":"find","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-all","label":"getAll","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/add-entry","label":"addEntry","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/find-1","label":"find_1","className":"api-method post"}]},{"type":"category","label":"Consumer Pull Token Validation","link":{"type":"generated-index","title":"Consumer Pull Token Validation","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/consumer-pull-token-validation"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/validate","label":"validate","className":"api-method get"}]},{"type":"category","label":"Transfer Process Control Api","link":{"type":"generated-index","title":"Transfer Process Control Api","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/transfer-process-control-api"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/complete","label":"complete","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/fail","label":"fail","className":"api-method post"}]},{"type":"category","label":"Asset","link":{"type":"generated-index","title":"Asset","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/asset"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-asset","label":"updateAsset","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-asset","label":"createAsset","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-assets","label":"requestAssets","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-data-address","label":"updateDataAddress","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-asset","label":"getAsset","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/remove-asset","label":"removeAsset","className":"menu__list-item--deprecated api-method delete"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-asset-data-address","label":"getAssetDataAddress","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-asset-1","label":"updateAsset_1","className":"api-method put"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-asset-1","label":"createAsset_1","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-assets-1","label":"requestAssets_1","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-asset-1","label":"getAsset_1","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/remove-asset-1","label":"removeAsset_1","className":"api-method delete"}]},{"type":"category","label":"Catalog","link":{"type":"generated-index","title":"Catalog","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/catalog"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/request-catalog","label":"requestCatalog","className":"api-method post"}]},{"type":"category","label":"Contract Agreement","link":{"type":"generated-index","title":"Contract Agreement","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/contract-agreement"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-all-agreements","label":"queryAllAgreements","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-agreement-by-id","label":"getAgreementById","className":"api-method get"}]},{"type":"category","label":"Contract Definition","link":{"type":"generated-index","title":"Contract Definition","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/contract-definition"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-contract-definition","label":"updateContractDefinition","className":"api-method put"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-contract-definition","label":"createContractDefinition","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-all-contract-definitions","label":"queryAllContractDefinitions","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-contract-definition","label":"getContractDefinition","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete-contract-definition","label":"deleteContractDefinition","className":"api-method delete"}]},{"type":"category","label":"Contract Negotiation","link":{"type":"generated-index","title":"Contract Negotiation","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/contract-negotiation"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/initiate-contract-negotiation","label":"initiateContractNegotiation","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-negotiations","label":"queryNegotiations","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-negotiation","label":"getNegotiation","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-agreement-for-negotiation","label":"getAgreementForNegotiation","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/cancel-negotiation","label":"cancelNegotiation","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/decline-negotiation","label":"declineNegotiation","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-negotiation-state","label":"getNegotiationState","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/terminate-negotiation","label":"terminateNegotiation","className":"api-method post"}]},{"type":"category","label":"Policy Definition","link":{"type":"generated-index","title":"Policy Definition","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/policy-definition"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/create-policy-definition","label":"createPolicyDefinition","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-policy-definitions","label":"queryPolicyDefinitions","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-policy-definition","label":"getPolicyDefinition","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-policy-definition","label":"updatePolicyDefinition","className":"api-method put"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/delete-policy-definition","label":"deletePolicyDefinition","className":"api-method delete"}]},{"type":"category","label":"Transfer Process","link":{"type":"generated-index","title":"Transfer Process","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/transfer-process"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/initiate-transfer-process","label":"initiateTransferProcess","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/query-transfer-processes","label":"queryTransferProcesses","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-transfer-process","label":"getTransferProcess","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/deprovision-transfer-process","label":"deprovisionTransferProcess","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/get-transfer-process-state","label":"getTransferProcessState","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/terminate-transfer-process","label":"terminateTransferProcess","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/terminate-negotiation.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/terminate-negotiation.api.mdx deleted file mode 100644 index 46ec1b225a3..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/terminate-negotiation.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: terminate-negotiation -title: "terminateNegotiation" -description: "Terminates the contract negotiation." -sidebar_label: "terminateNegotiation" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Contract Negotiation"],"description":"Terminates the contract negotiation.","operationId":"terminateNegotiation","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/TerminateNegotiation"},"reason":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"https://w3id.org/edc/v0.0.1/ns/TerminateNegotiation","@id":"negotiation-id","reason":"a reason to terminate"}}}}},"responses":{"200":{"description":"ContractNegotiation is terminating","links":{"poll-state":{"operationId":"getNegotiationState"}}},"400":{"description":"Request was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"A contract negotiation with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/v2/contractnegotiations/{id}/terminate","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"https://w3id.org/edc/v0.0.1/ns/TerminateNegotiation","@id":"negotiation-id","reason":"a reason to terminate"},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"terminate Negotiation","description":{"content":"Terminates the contract negotiation.","type":"text/plain"},"url":{"path":["v2","contractnegotiations",":id","terminate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## terminateNegotiation - - - -Terminates the contract negotiation. - -
Path Parameters
Request Body
- -ContractNegotiation is terminating - -
- -Request was malformed - -
Schema array
- -A contract negotiation with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/terminate-transfer-process.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/terminate-transfer-process.api.mdx deleted file mode 100644 index 4d65cf3480b..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/terminate-transfer-process.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: terminate-transfer-process -title: "terminateTransferProcess" -description: "Requests the termination of a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state." -sidebar_label: "terminateTransferProcess" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Transfer Process"],"description":"Requests the termination of a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state.","operationId":"terminateTransferProcess","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/TransferState"},"state":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"https://w3id.org/edc/v0.0.1/ns/TerminateTransfer","reason":"a reason to terminate"}}}}},"responses":{"200":{"description":"Request to cancel the transfer process was successfully received","links":{"poll-state":{"operationId":"getTransferProcessState"}}},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"A contract negotiation with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"409":{"description":"Could not terminate transfer process, because it is already completed or terminated.","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"post","path":"/v2/transferprocesses/{id}/terminate","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"https://w3id.org/edc/v0.0.1/ns/TerminateTransfer","reason":"a reason to terminate"},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"terminate Transfer Process","description":{"content":"Requests the termination of a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state.","type":"text/plain"},"url":{"path":["v2","transferprocesses",":id","terminate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## terminateTransferProcess - - - -Requests the termination of a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state. - -
Path Parameters
Request Body
- -Request to cancel the transfer process was successfully received - -
- -Request was malformed, e.g. id was null - -
Schema array
- -A contract negotiation with the given ID does not exist - -
Schema array
- -Could not terminate transfer process, because it is already completed or terminated. - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api.info.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api.info.mdx deleted file mode 100644 index 973f74e000e..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: tractus-x-edc-rest-api -title: "Tractus-X EDC REST API" -description: "Tractus-X EDC API Documentation" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 0.5.1-SNAPSHOT - -# Tractus-X EDC REST API - - - -Tractus-X EDC API Documentation - - - \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-asset-1.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-asset-1.api.mdx deleted file mode 100644 index 100dbc6d916..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-asset-1.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: update-asset-1 -title: "updateAsset_1" -description: "Updates an asset with the given ID if it exists. If the asset is not found, no further action is taken. DANGER ZONE: Note that updating assets can have unexpected results, especially for contract offers that have been sent out or are ongoing in contract negotiations." -sidebar_label: "updateAsset_1" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset"],"description":"Updates an asset with the given ID if it exists. If the asset is not found, no further action is taken. DANGER ZONE: Note that updating assets can have unexpected results, especially for contract offers that have been sent out or are ongoing in contract negotiations.","operationId":"updateAsset_1","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/Asset"},"dataAddress":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"privateProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"definition-id","properties":{"key":"value"},"privateProperties":{"privateKey":"privateValue"},"dataAddress":{"type":"HttpData"}}}}}},"responses":{"200":{"description":"Asset was updated successfully"},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"Asset could not be updated, because it does not exist."}},"method":"put","path":"/v3/assets","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"definition-id","properties":{"key":"value"},"privateProperties":{"privateKey":"privateValue"},"dataAddress":{"type":"HttpData"}},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"update Asset 1","description":{"content":"Updates an asset with the given ID if it exists. If the asset is not found, no further action is taken. DANGER ZONE: Note that updating assets can have unexpected results, especially for contract offers that have been sent out or are ongoing in contract negotiations.","type":"text/plain"},"url":{"path":["v3","assets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## updateAsset_1 - - - -Updates an asset with the given ID if it exists. If the asset is not found, no further action is taken. DANGER ZONE: Note that updating assets can have unexpected results, especially for contract offers that have been sent out or are ongoing in contract negotiations. - -
Request Body
    dataAddress object
    privateProperties object
  • property name* object
    • properties object
  • property name* object
- -Asset was updated successfully - -
- -Request was malformed, e.g. id was null - -
Schema array
- -Asset could not be updated, because it does not exist. - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-asset.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-asset.api.mdx deleted file mode 100644 index 0ad98ee6dd9..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-asset.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: update-asset -title: "updateAsset" -description: "Updates an asset with the given ID if it exists. If the asset is not found, no further action is taken. DANGER ZONE: Note that updating assets can have unexpected results, especially for contract offers that have been sent out or are ongoing in contract negotiations." -sidebar_label: "updateAsset" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset"],"description":"Updates an asset with the given ID if it exists. If the asset is not found, no further action is taken. DANGER ZONE: Note that updating assets can have unexpected results, especially for contract offers that have been sent out or are ongoing in contract negotiations.","operationId":"updateAsset","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"createdAt":{"type":"integer","format":"int64","example":null},"dataAddress":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"id":{"type":"string","example":null},"privateProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}},"example":null}}}},"responses":{"200":{"description":"Asset was updated successfully"},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"Asset could not be updated, because it does not exist."}},"deprecated":true,"method":"put","path":"/v2/assets","servers":[{"url":"/"}],"jsonRequestBodyExample":null,"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"update Asset","description":{"content":"Updates an asset with the given ID if it exists. If the asset is not found, no further action is taken. DANGER ZONE: Note that updating assets can have unexpected results, especially for contract offers that have been sent out or are ongoing in contract negotiations.","type":"text/plain"},"url":{"path":["v2","assets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## updateAsset - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Updates an asset with the given ID if it exists. If the asset is not found, no further action is taken. DANGER ZONE: Note that updating assets can have unexpected results, especially for contract offers that have been sent out or are ongoing in contract negotiations. - -
Request Body
    dataAddress object
    privateProperties object
  • property name* object
    • properties object
  • property name* object
- -Asset was updated successfully - -
- -Request was malformed, e.g. id was null - -
Schema array
- -Asset could not be updated, because it does not exist. - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-contract-definition.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-contract-definition.api.mdx deleted file mode 100644 index 0671f324ae0..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-contract-definition.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: update-contract-definition -title: "updateContractDefinition" -description: "Updated a contract definition with the given ID. The supplied JSON structure must be a valid JSON-LD object" -sidebar_label: "updateContractDefinition" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Contract Definition"],"description":"Updated a contract definition with the given ID. The supplied JSON structure must be a valid JSON-LD object","operationId":"updateContractDefinition","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/ContractDefinition"},"accessPolicyId":{"type":"string","example":null},"assetsSelector":{"type":"array","example":null,"items":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/Criterion"},"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"Criterion","operandLeft":"fieldName","operator":"=","operandRight":"some value"}}},"contractPolicyId":{"type":"string","example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"definition-id","accessPolicyId":"asset-policy-id","contractPolicyId":"contract-policy-id","assetsSelector":[]}}}}},"responses":{"204":{"description":"Contract definition was updated successfully"},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"A contract definition with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"method":"put","path":"/v2/contractdefinitions","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"update Contract Definition","description":{"content":"Updated a contract definition with the given ID. The supplied JSON structure must be a valid JSON-LD object","type":"text/plain"},"url":{"path":["v2","contractdefinitions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"*/*"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\""}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## updateContractDefinition - - - -Updated a contract definition with the given ID. The supplied JSON structure must be a valid JSON-LD object - -
Request Body
    assetsSelector object[]
- -Contract definition was updated successfully - -
- -Request was malformed, e.g. id was null - -
Schema array
- -A contract definition with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-data-address.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-data-address.api.mdx deleted file mode 100644 index 5a9e11f663e..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-data-address.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: update-data-address -title: "updateDataAddress" -description: "Updates a DataAddress for an asset with the given ID." -sidebar_label: "updateDataAddress" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset"],"description":"Updates a DataAddress for an asset with the given ID.","operationId":"updateDataAddress","parameters":[{"name":"assetId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"createdAt":{"type":"integer","format":"int64","example":null},"dataAddress":{"type":"object","properties":{"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/DataAddress"},"type":{"type":"string","example":null}},"example":null},"id":{"type":"string","example":null},"privateProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}},"example":null}}}},"responses":{"200":{"description":"Asset was updated successfully"},"400":{"description":"Request was malformed, e.g. id was null","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"An asset with the given ID does not exist","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}}},"deprecated":true,"method":"put","path":"/v2/assets/{assetId}/dataaddress","servers":[{"url":"/"}],"jsonRequestBodyExample":null,"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"update Data Address","description":{"content":"Updates a DataAddress for an asset with the given ID.","type":"text/plain"},"url":{"path":["v2","assets",":assetId","dataaddress"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"assetId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## updateDataAddress - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Updates a DataAddress for an asset with the given ID. - -
Path Parameters
Request Body
    dataAddress object
    privateProperties object
  • property name* object
    • properties object
  • property name* object
- -Asset was updated successfully - -
- -Request was malformed, e.g. id was null - -
Schema array
- -An asset with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-entry.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-entry.api.mdx deleted file mode 100644 index e5f64864bbd..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-entry.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: update-entry -title: "updateEntry" -description: "Updates the entry for a particular BPN" -sidebar_label: "updateEntry" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Business Partner Group"],"description":"Updates the entry for a particular BPN","operationId":"updateEntry","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"groups":{"uniqueItems":true,"type":"array","example":null,"items":{"type":"string","example":null}}},"example":{"@context":{"tx":"https://w3id.org/tractusx/v0.0.1/ns/"},"@id":"tx:BPN000001234","tx:groups":["group1","group2","group3"]}}}}},"responses":{"204":{"description":"The object was successfully updated"},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"No entry for the given BPN was found"}},"method":"put","path":"/business-partner-groups","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@context":{"tx":"https://w3id.org/tractusx/v0.0.1/ns/"},"@id":"tx:BPN000001234","tx:groups":["group1","group2","group3"]},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"update Entry","description":{"content":"Updates the entry for a particular BPN","type":"text/plain"},"url":{"path":["business-partner-groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## updateEntry - - - -Updates the entry for a particular BPN - -
Request Body
- -The object was successfully updated - -
- -Request body was malformed - -
Schema array
- -No entry for the given BPN was found - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-policy-definition.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-policy-definition.api.mdx deleted file mode 100644 index 1c0712dd504..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/update-policy-definition.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: update-policy-definition -title: "updatePolicyDefinition" -description: "Updates an existing Policy, If the Policy is not found, an error is reported" -sidebar_label: "updatePolicyDefinition" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Policy Definition"],"description":"Updates an existing Policy, If the Policy is not found, an error is reported","operationId":"updatePolicyDefinition","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@id":{"type":"string","example":null},"@type":{"type":"string","example":"https://w3id.org/edc/v0.0.1/ns/PolicyDefinition"},"policy":{"type":"object","properties":{"@type":{"type":"string","example":null,"enum":["SET","OFFER","CONTRACT"]},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null}},"example":null},"target":{"type":"string","example":null}},"example":null}},"permissions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"duties":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"parentPermission":"circular()","target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","properties":{"action":{"type":"object","properties":{"constraint":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"required":["edctype"],"type":"object","properties":{"edctype":{"type":"string","example":null}},"example":null,"discriminator":{"propertyName":"edctype"}}},"target":{"type":"string","example":null}},"example":null}},"target":{"type":"string","example":null}},"example":null}},"example":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"definition-id","policy":{"@context":"http://www.w3.org/ns/odrl.jsonld","@type":"Set","uid":"http://example.com/policy:1010","permission":[{"target":"http://example.com/asset:9898.movie","action":"display","constraint":[{"leftOperand":"spatial","operator":"eq","rightOperand":"https://www.wikidata.org/wiki/Q183","comment":"i.e Germany"}]}]}}}}}},"responses":{"200":{"description":"policy definition was updated successfully. Returns the Policy Definition Id and updated timestamp"},"400":{"description":"Request body was malformed","content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"404":{"description":"policy definition could not be updated, because it does not exists","content":{"application/json":{"schema":{"type":"object","properties":{"invalidValue":{"type":"object","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}},"example":null}}}}},"method":"put","path":"/v2/policydefinitions/{id}","servers":[{"url":"/"}],"jsonRequestBodyExample":{"@context":{"edc":"https://w3id.org/edc/v0.0.1/ns/"},"@id":"definition-id","policy":{"@context":"http://www.w3.org/ns/odrl.jsonld","@type":"Set","uid":"http://example.com/policy:1010","permission":[{"target":"http://example.com/asset:9898.movie","action":"display","constraint":[{"leftOperand":"spatial","operator":"eq","rightOperand":"https://www.wikidata.org/wiki/Q183","comment":"i.e Germany"}]}]}},"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"update Policy Definition","description":{"content":"Updates an existing Policy, If the Policy is not found, an error is reported","type":"text/plain"},"url":{"path":["v2","policydefinitions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## updatePolicyDefinition - - - -Updates an existing Policy, If the Policy is not found, an error is reported - -
Path Parameters
Request Body
    policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -policy definition was updated successfully. Returns the Policy Definition Id and updated timestamp - -
- -Request body was malformed - -
Schema array
- -policy definition could not be updated, because it does not exists - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/validate.api.mdx b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/validate.api.mdx deleted file mode 100644 index 1c2806698aa..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/validate.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: validate -title: "validate" -description: "Checks that the provided token has been signed by the present entity and asserts its validity. If token is valid, then the data address contained in its claims is decrypted and returned back to the caller." -sidebar_label: "validate" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Consumer Pull Token Validation"],"description":"Checks that the provided token has been signed by the present entity and asserts its validity. If token is valid, then the data address contained in its claims is decrypted and returned back to the caller.","operationId":"validate","parameters":[{"name":"Authorization","in":"header","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Token is valid"},"400":{"description":"Request was malformed"},"403":{"description":"Token is invalid"}},"method":"get","path":"/token","servers":[{"url":"/"}],"info":{"title":"Tractus-X EDC REST API","description":"Tractus-X EDC API Documentation","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.5.1-SNAPSHOT"},"postman":{"name":"validate","description":{"content":"Checks that the provided token has been signed by the present entity and asserts its validity. If token is valid, then the data address contained in its claims is decrypted and returned back to the caller.","type":"text/plain"},"url":{"path":["token"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## validate - - - -Checks that the provided token has been signed by the present entity and asserts its validity. If token is valid, then the data address contained in its claims is decrypted and returned back to the caller. - -
Header Parameters
- -Token is valid - -
- -Request was malformed - -
- -Token is invalid - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/page00_development_view.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/page00_development_view.md deleted file mode 100644 index 6ed200659c6..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/page00_development_view.md +++ /dev/null @@ -1,28 +0,0 @@ -# Development View - -![Connector kit banner](@site/static/img/ConnectorKitIcon.png) - -## Connector KIT - -## Project Overview - -Eclipse Tractus-X is an initiative of companies under the umbrella of the Eclipse Foundation. -It is a pilot for the larger initiative of CatenaX. -A broader overview of the project can be found on the initiative's [Github page][tractusx-edc-link] -or the homepage of the [Eclipse Foundation](https://projects.eclipse.org/projects/automotive.tractusx). - -## The EDC - -The Eclipse Dataspace Connector is one of the core components facilitating Tractus-X. - -:::note Tractus-X EDC or Core EDC? - -This documentation is for Tractus-X EDC. -It includes the Core EDC with all of its functionality. -However, this core is supplemented by extensions that allow for the use of additional backends and connection types. -Furthermore, the provided Helm charts, build configuration and tests allow for a smoother deployment. -::: - -You can find the repository for the Tractus-X EDC [here][tractusx-edc-link]. - -[tractusx-edc-link]: https://github.com/eclipse-tractusx/tractusx-edc diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/page01_eclipse_foundation.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/page01_eclipse_foundation.md deleted file mode 100644 index bf71bd5b9bd..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/page01_eclipse_foundation.md +++ /dev/null @@ -1,35 +0,0 @@ -# The Eclipse Foundation - -## Eclipse Development Process - -This Eclipse Foundation open project is governed by the Eclipse Foundation -Development Process and operates under the terms of the Eclipse IP Policy. - -* -* - -## Eclipse Contributor Agreement - -In order to be able to contribute to Eclipse Foundation projects you must -electronically sign the Eclipse Contributor Agreement (ECA). - -* - -The ECA provides the Eclipse Foundation with a permanent record that you agree -that each of your contributions will comply with the commitments documented in -the Developer Certificate of Origin (DCO). Having an ECA on file associated with -the email address matching the "Author" field of your contribution's Git commits -fulfills the DCO's requirement that you sign-off on your contributions. - -For more information, please see the Eclipse Committer Handbook: - - -## License - -Code in Tractus-X EDC is published under the [Apache License](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE). - -## Contact - -Contact the project developers via the project's "dev" list. - -* diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/page02_repository_structure.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/page02_repository_structure.md deleted file mode 100644 index 11fb7c7c2e1..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/page02_repository_structure.md +++ /dev/null @@ -1,26 +0,0 @@ -# Repository Structure - -The repository for Tractus-X EDC can be found [here](https://github.com/eclipse-tractusx/tractusx-edc). -It contains the following components: - -## EDC Extensions - -The core EDC is extensible by design. -Tractus-X EDC provides such extensions. -These extensions and their documentation are available -[here](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-extensions/README.md). - -## Gradle Files for EDC Builds - -Builds of Tractus-X EDC are performed via Gradle. -To allow for different configurations, different builds are provided. -For example separate secrets backends are supported, but require separate builds of EDC. -Therefor, different builds are available for both -[data plane](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-dataplane/README.md) -and [control plane](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-controlplane/README.md), - -## Helm Charts for EDC Deployment - -To facilitate deployment of these different builds and their prerequisites, -Helm charts are provided. The charts and their documentation can be found -[here](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/charts/README.md). diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/page03_project_structure.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/page03_project_structure.md deleted file mode 100644 index 9f20c5a3d9c..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/development-view/page03_project_structure.md +++ /dev/null @@ -1,21 +0,0 @@ -# Project Structure - -## Issue Tracking - -Issues are maintained in [GitHub Issues](https://github.com/eclipse-tractusx/tractusx-edc/issues). - -## Reporting Vulnerabilities - -Vulnerabilities in the Eclipse Tractus-X code base are best reported directly to the -[Eclipse Foundation](https://www.eclipse.org/security/). - -## Git Flow - -The Tractus-X EDC repository uses a Git Flow, with `main` as the development branch and `releases` as the release branch. -Other branches should follow the naming conventions of `feature/x` or `hotfix/x`, though this is not strictly enforced. - -## Tooling - -We use Java 11 with Gradle for dependencies and builds. -We use [Spotless](https://github.com/diffplug/spotless) for code formatting. -Releases are in the form of Docker containers and Helm charts. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page00_operation_view.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page00_operation_view.md deleted file mode 100644 index dac79729074..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page00_operation_view.md +++ /dev/null @@ -1,28 +0,0 @@ -# Software Operation View - -![Connector kit banner](@site/static/img/ConnectorKitIcon.png) - -## Connector KIT - -## Introduction - -The following documentation will guide you through the Tractus-X EDC deployment. -You will be setting up multiple controllers and enabling communication between them. - -:::note Tractus-X EDC or Core EDC? - -The following guide assumes the use of the Tractus-X EDC. -It includes the Core EDC with all of its functionality. -However, this core is supplemented by extensions that allow for the use of additional backends and connection types. -Furthermore, the provided Helm charts, build configuration and tests allow for a smoother deployment. -::: - -## Connector Components - -In a usual EDC environment, each participant would operate at least one connector. -Each of these connectors consists of a control plane and a data plane. -The control plane functions as administration layer and is responsible for resource management, contract negotiation and administering data transfer. -The data plane does the heavy lifting of transferring and receiving data streams. - -Each of these planes comes in several variants, allowing for example secrets to be stored in Azure Vault or a Hashicorp Vault. -The setup on the following pages assumes the use of Hashicorp Vault for secrets and PostgreSQL for data storage. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page02_technical_prerequisites.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page02_technical_prerequisites.md deleted file mode 100644 index 682da831b00..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page02_technical_prerequisites.md +++ /dev/null @@ -1,43 +0,0 @@ -# Technical Prerequisites - -## Obtaining Releases - -The most recent release of Tractus-X EDC can be obtained under `https://github.com/eclipse-tractusx/tractusx-edc/releases`. -To create your own build, you can clone the repository at `https://github.com/eclipse-tractusx/tractusx-edc` and consult the provided README.md. -This can be useful if you want to use non-standard extensions or configuration. - -## Container Environment - -Tractus-X releases come in the form of Docker containers and corresponding Helm charts. -As such, recent versions of the following are required. - -- Docker -- Kubernetes -- Helm - -Seeing as these are standard tools, Tractus-X EDC will run on any cloud environment that can accept Helm charts. - -## Backend Dependencies - -The EDC requires backend services for persistence of data and secrets. The following backends are currently supported. - -Data Storage: - -- PostgreSQL database -- In memory database - -Secret Storage: - -- Hashicorp Vault -- Azure Vault - -The default setup assumes data storage via PostgreSQL database. -In memory storage is only recommended for running tests. -Hashicorp Vault is the default secret provider, because it is platform-agnostic. - -Helm charts are provided to set up these services locally. -**These are not suited for production environments.** - -## All-in-one deployment - -An all-in-one deployment is no longer in scope and will not be provided. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page03_local_setup_controlplane.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page03_local_setup_controlplane.md deleted file mode 100644 index 5e37c0880ea..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page03_local_setup_controlplane.md +++ /dev/null @@ -1,141 +0,0 @@ -# Setting up a local EDC Control Plane - -## Basics - -The EDC is split into control and data plane. -The data plane handles the actual data transfer between parties. -The control plane manages the following: - -- Resource Management (e.g. Assets, Policies & Contract Definitions CRUD) -- Contract Offering & Contract Negotiation -- Data Transfer Coordination / Management - -The EDC control plane can run as a single container on your local machine. -The following is a short overview of the necessary steps to start up the default configuration. - -## Building - -Tractus-X EDC is build with Gradle. The following command creates the default control plane as a docker container: - -```shell -./gardlew :edc-controlplane:edc-controlplane-postgresql-hashicorp-vault:dockerize -``` - -## Example Configuration - -The following commands can be used to create the necessary configuration files for the EDC container. -They assume sane - but unsafe - defaults. An explanation of the respective parameters can be found [here](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/README.md). - -:::danger -The following configuration is for testing purposes only. Do not use it in production. -::: - -### Example configuration.properties - -```shell -# Create configuration.properties -export CONFIGURATION_PROPERTIES_FILE=$(mktemp /tmp/configuration.properties.XXXXXX) -cat << 'EOF' > ${CONFIGURATION_PROPERTIES_FILE} - -web.http.default.port=8080 -web.http.default.path=/api -web.http.management.port=8181 -web.http.management.path=/data -web.http.control.port=9999 -web.http.control.path=/api/controlplane/control -web.http.protocol.port=8282 -web.http.protocol.path=/api/v1/ids - -edc.receiver.http.dynamic.endpoint=http://backend-service - -edc.ids.title=Eclipse Dataspace Connector -edc.ids.description=Eclipse Dataspace Connector -edc.ids.id=urn:connector:edc -edc.ids.security.profile=base -edc.ids.endpoint=http://localhost:8282/api/v1/ids -edc.ids.maintainer=http://localhost -edc.ids.curator=http://localhost -edc.ids.catalog.id=urn:catalog:default -ids.webhook.address=http://localhost:8282/api/v1/ids - -edc.hostname=localhost - -edc.api.auth.key=password - -# OAuth / DAPS related configuration -edc.oauth.token.url=https://daps.example.net -edc.oauth.certificate.alias=key-to-daps-certificate-in-keyvault -edc.oauth.private.key.alias=key-to-private-key-in-keyvault -edc.oauth.client.id=daps-oauth-client-id - -# HashiCorp vault related configuration -edc.vault.hashicorp.url=http://vault -edc.vault.hashicorp.token=55555555-6666-7777-8888-999999999999 -edc.vault.hashicorp.timeout.seconds=30 - -# Control- / Data- Plane configuration -edc.transfer.proxy.endpoint=http://dataplane-public-endpoint/public -edc.transfer.proxy.token.signer.privatekey.alias=token-signer-private-key - -# Postgresql related configuration -edc.datasource.asset.name=asset -edc.datasource.asset.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_asset -edc.datasource.asset.user=user -edc.datasource.asset.password=pass -edc.datasource.contractdefinition.name=contractdefinition -edc.datasource.contractdefinition.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractdefinition -edc.datasource.contractdefinition.user=user -edc.datasource.contractdefinition.password=pass -edc.datasource.contractnegotiation.name=contractnegotiation -edc.datasource.contractnegotiation.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractnegotiation -edc.datasource.contractnegotiation.user=user -edc.datasource.contractnegotiation.password=pass -edc.datasource.policy.name=policy -edc.datasource.policy.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_policy -edc.datasource.policy.user=user -edc.datasource.policy.password=pass -edc.datasource.transferprocess.name=transferprocess -edc.datasource.transferprocess.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_transferprocess -edc.datasource.transferprocess.user=user -edc.datasource.transferprocess.password=pass -EOF -``` - -### Example logging.properties - -```shell -# Create logging.properties -export LOGGING_PROPERTIES_FILE=$(mktemp /tmp/logging.properties.XXXXXX) -cat << 'EOF' > ${LOGGING_PROPERTIES_FILE} -.level=INFO -org.eclipse.edc.level=ALL -handlers=java.util.logging.ConsoleHandler -java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter -java.util.logging.ConsoleHandler.level=ALL -java.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n -EOF -``` - -### Example opentelemetry.properties - -```shell -# Create opentelemetry.properties -export OPENTELEMETRY_PROPERTIES_FILE=$(mktemp /tmp/opentelemetry.properties.XXXXXX) -cat << 'EOF' > ${OPENTELEMETRY_PROPERTIES_FILE} -otel.javaagent.enabled=false -otel.javaagent.debug=false -EOF -``` - -## Running the Control Plane - -Once the configuration is created, the container can be run directly via docker. - -```shell -docker run \ - -p 8080:8080 -p 8181:8181 -p 8182:8182 -p 8282:8282 -p 9090:9090 -p 9999:9999 \ - -v ${CONFIGURATION_PROPERTIES_FILE:-/dev/null}:/app/configuration.properties \ - -v ${LOGGING_PROPERTIES_FILE:-/dev/null}:/app/logging.properties \ - -v ${OPENTELEMETRY_PROPERTIES_FILE:-/dev/null}:/app/opentelemetry.properties \ - -i edc-controlplane-postgresql-hashicorp-vault:latest -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page04_local_setup_dataplane.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page04_local_setup_dataplane.md deleted file mode 100644 index d84a6c9f126..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page04_local_setup_dataplane.md +++ /dev/null @@ -1,98 +0,0 @@ -# Setting up a local EDC Data Plane - -## Basics - -The EDC is split into control and data plane. -The data plane handles the actual data transfer between parties. -The control plane manages the following: - -- Resource Management (e.g. Assets, Policies & Contract Definitions CRUD) -- Contract Offering & Contract Negotiation -- Data Transfer Coordination / Management - -The EDC data plane can run as a single container on your local machine. -The following is a short overview of the necessary steps to start up the default configuration. - -## Building - -Tractus-X EDC is build with Gradle. The following command creates the default data plane as a docker container: - -```shell -./gardlew :edc-dataplane:edc-dataplane-hashicorp-vault:dockerize -``` - -## Example Configuration - -The following commands can be used to create the necessary configuration files for the EDC container. -They assume sane - but unsafe - defaults. An explanation of the respective parameters can be found [here](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-dataplane/edc-dataplane-hashicorp-vault/README.md). - -:::danger - -The following configuration is for testing purposes only. Do not use it in production. -::: - -### Example configuration.properties - -```shell -# Create configuration.properties -export CONFIGURATION_PROPERTIES_FILE=$(mktemp /tmp/configuration.properties.XXXXXX) -cat << 'EOF' > ${CONFIGURATION_PROPERTIES_FILE} - -web.http.default.port=8080 -web.http.default.path=/api -web.http.public.port=8185 -web.http.public.path=/public -web.http.control.port=9999 -web.http.control.path=/api/dataplane/control - -# Validation endpoint of controlplane -edc.dataplane.token.validation.endpoint=http://controlplane:9999/api/controlplane/control/token - -# EDC hostname -edc.hostname=localhost - -# HashiCorp vault related configuration -edc.vault.hashicorp.url=http://vault -edc.vault.hashicorp.token=55555555-6666-7777-8888-999999999999 -edc.vault.hashicorp.timeout.seconds=30 -EOF -``` - -### Example logging.properties - -```shell -# Create logging.properties -export LOGGING_PROPERTIES_FILE=$(mktemp /tmp/logging.properties.XXXXXX) -cat << 'EOF' > ${LOGGING_PROPERTIES_FILE} -.level=INFO -org.eclipse.edc.level=ALL -handlers=java.util.logging.ConsoleHandler -java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter -java.util.logging.ConsoleHandler.level=ALL -java.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n -EOF -``` - -### Example opentelemetry.properties - -```shell -# Create opentelemetry.properties -export OPENTELEMETRY_PROPERTIES_FILE=$(mktemp /tmp/opentelemetry.properties.XXXXXX) -cat << 'EOF' > ${OPENTELEMETRY_PROPERTIES_FILE} -otel.javaagent.enabled=true -otel.javaagent.debug=false -EOF -``` - -## Running - -Once the configuration is created, the container can be run directly via docker. - -```shell -docker run \ - -p 8080:8080 -p 8185:8185 -p 9999:9999 -p 9090:9090 \ - -v ${CONFIGURATION_PROPERTIES_FILE:-/dev/null}:/app/configuration.properties \ - -v ${LOGGING_PROPERTIES_FILE:-/dev/null}:/app/logging.properties \ - -v ${OPENTELEMETRY_PROPERTIES_FILE:-/dev/null}:/app/opentelemetry.properties \ - -i edc-dataplane-hashicorp-vault:latest -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page08_api.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page08_api.md deleted file mode 100644 index 42d5f346581..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page08_api.md +++ /dev/null @@ -1,64 +0,0 @@ -# EDC API Examples - -## API Spec - -The API spec of the EDC is constantly evolving. -The full API documentation for each release can be viewed on [management-api](../development-view/openAPI/tractusx-edc-api/tractus-x-edc-rest-api.info.mdx). -The following are some example API calls for common use cases. -They assume the default parameters from the previous local setup. - -## Create an Asset - -All objects in EDC are created by posting their JSON-serialized representation to the respective API input. -Since most EDC objects are rather openly defined, most of the properties provided depend on the need of the individual user. -Assets are no exception here. - -URL - -```http request -POST http://localhost:8080/api/v1/assets/ -``` - -Body - -```json -{ - "asset": { - "id": "asset1", - "properties": { - "exampleProperty": "exampleValue" - } - }, - "dataAddress": { - "properties": { - "baseUrl": "https://path.to/the_asset", - "type": "HttpData" - } - } -} -``` - -## Request an Asset Catalog - -To inspect the assets available to an EDC connector, we request its catalog. - -URL - -```http request -POST http://localhost:8080/api/v1/catalog/request -``` - -Body - -```json -{ - "providerUrl": "www.example.provider", - "querySpec": { - "filter": "AvailableWithPolicyXYZ", - "limit": 0, - "offset": 0, - "sortField": "id", - "sortOrder": "ASC" - } -} -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page09_upgrading.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page09_upgrading.md deleted file mode 100644 index 414d0ab4678..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page09_upgrading.md +++ /dev/null @@ -1,20 +0,0 @@ -# Upgrading Tractus-X EDC - -Among the goals of Tractus-X EDC is making EDC upgrades as painless as possible. -The changes in each release are documented [here](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/docs/migration). -Usually there are only three steps to each upgrade. - -## Database Migration - -Database migration is simple to accomplish with a PostgreSQL backend. -The [PostgreSQL Migration Extension](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/edc-extensions/postgresql-migration) is the preferred approach. -Alternatively, the `.sql` files therein can be used to manually update the database schema. - -## Updating EDC - -The easy part of the upgrade process is to simply switch the outdated EDC containers with their newer counterparts. - -## Updating Settings - -Check the newest [Migration Documents](https://github.com/eclipse-tractusx/tractusx-edc/tree/develop/docs/migration) -for any changes to the settings structure and apply them to your settings. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page10_extensions.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page10_extensions.md deleted file mode 100644 index ce0a72ead17..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/kit/operation-view/page10_extensions.md +++ /dev/null @@ -1,44 +0,0 @@ -# EDC Extensions - -The following extensions provide additional functionality to the core EDC. -They are currently only available in Tractus-X EDC. - -## Business Partner Validation - -This extension allows for validation of business partners within the access policy. - -## Control Plane EDR APIs - -The goal of this extension is to simplify the process of retrieving data out of EDC. -It returns `EndpointDataReference` object, hiding all the communication details for contract offers, -contract negotiation, transfer process and retrieving the underlying data through the data-planes. - -## CX OAuth2 - -This extension enables OAuth2 authentication between EDC connectors, -instead of the more complex authentication flow used by core EDC. - -## Data Encryption - -The EDC encrypts sensitive information inside a token it sends to other applications (potentially cross-company). -This extension implements the encryption of this data and should be used with secure keys and algorithms at all times. - -## Data Plane Selector - -This control plane extension makes it possible to configure one or more data plane instances. -During a transfer the control plane will look for an instance with matching capabilities to transfer data. - -## Hashicorp Vault - -This extension allows for usage of Hashicorp Vault for secret storage. -It is the default used in Tractus-X EDC. - -## PostrgreSQL Migration - -While the core EDC is able to interact with PostgreSQL databases, -it does not automate migrations between schema versions. -This extension adds that functionality. - -## Transfer Process SFTP - -This extension allows for the use of SFTP backends for the data plane (but is not included in the provided control- and data plane). diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.0.x_0.1.x.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.0.x_0.1.x.md deleted file mode 100644 index ee150291a87..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.0.x_0.1.x.md +++ /dev/null @@ -1,304 +0,0 @@ -# Migration Version 0.0.x to 0.1.x - -This document contains a list of breaking changes that are introduced in version 0.1.x. - -## 0. Summary - -1. PostgreSQL Database - 1. Criteria in Policy & Contract Definitions Table - 2. Delete Contract Agreements -2. Data Management API - 1. Policy Path - 2. Policy Payload - 3. Criteria in Payload of Contract Definitions and Policies - 4. Data Address -3. Connector Configuration - 1. Token Validation Endpoint Setting - 2. DataPlane Selector - -## 1. PostgreSQL Database - -The Tractus-X EDC [PostgreSQL Migration Extension](../../edc-extensions/postgresql-migration/README.md) is able to run -normal migrations. But the extension will never cause a data loss automatically, therefore part of this migration must -be done by the user itself. - -### 1.1 Criteria in Policy & Contract Definitions Table - -Criteria in Policies and Contract Definitions are serialized as JSON and put into the database. The Criteria schema -changed and already existing database entries will cause _NullPointerExceptions_. - -#### Example Exception - -```plain -[2022-08-02 09:32:37] [SEVERE ] Could not handle multipart request: null -org.eclipse.dataspaceconnector.spi.EdcException - at org.eclipse.dataspaceconnector.transaction.local.LocalTransactionContext.execute(LocalTransactionContext.java:70) - at org.eclipse.dataspaceconnector.sql.assetindex.SqlAssetIndex.queryAssets(SqlAssetIndex.java:141) - at org.eclipse.dataspaceconnector.sql.assetindex.SqlAssetIndex.queryAssets(SqlAssetIndex.java:134) - at org.eclipse.dataspaceconnector.contract.offer.ContractOfferServiceImpl.lambda$queryContractOffers$2(ContractOfferServiceImpl.java:61) - at java.base/java.util.stream.ReferencePipeline$7$1.accept(ReferencePipeline.java:271) - at java.base/java.util.stream.ReferencePipeline$2$1.accept(ReferencePipeline.java:177) - at java.base/java.util.LinkedList$LLSpliterator.forEachRemaining(LinkedList.java:1239) - at java.base/java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:484) - at java.base/java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:474) - at java.base/java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:913) - at java.base/java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) - at java.base/java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:578) - at org.eclipse.dataspaceconnector.ids.core.service.CatalogServiceImpl.getDataCatalog(CatalogServiceImpl.java:55) - at org.eclipse.dataspaceconnector.ids.core.service.ConnectorServiceImpl.getConnector(ConnectorServiceImpl.java:51) - at org.eclipse.dataspaceconnector.ids.api.multipart.handler.description.ConnectorDescriptionRequestHandler.handle(ConnectorDescriptionRequestHandler.java:74) - at org.eclipse.dataspaceconnector.ids.api.multipart.handler.DescriptionHandler.handleRequestInternal(DescriptionHandler.java:117) - at org.eclipse.dataspaceconnector.ids.api.multipart.handler.DescriptionHandler.handleRequest(DescriptionHandler.java:82) - at org.eclipse.dataspaceconnector.ids.api.multipart.controller.MultipartController.request(MultipartController.java:146) - at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method) - at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) - at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) - at java.base/java.lang.reflect.Method.invoke(Method.java:566) - at org.glassfish.jersey.server.model.internal.ResourceMethodInvocationHandlerFactory.lambda$static$0(ResourceMethodInvocationHandlerFactory.java:52) - at org.glassfish.jersey.server.model.internal.AbstractJavaResourceMethodDispatcher$1.run(AbstractJavaResourceMethodDispatcher.java:124) - at org.glassfish.jersey.server.model.internal.AbstractJavaResourceMethodDispatcher.invoke(AbstractJavaResourceMethodDispatcher.java:167) - at org.glassfish.jersey.server.model.internal.JavaResourceMethodDispatcherProvider$ResponseOutInvoker.doDispatch(JavaResourceMethodDispatcherProvider.java:176) - at org.glassfish.jersey.server.model.internal.AbstractJavaResourceMethodDispatcher.dispatch(AbstractJavaResourceMethodDispatcher.java:79) - at org.glassfish.jersey.server.model.ResourceMethodInvoker.invoke(ResourceMethodInvoker.java:475) - at org.glassfish.jersey.server.model.ResourceMethodInvoker.apply(ResourceMethodInvoker.java:397) - at org.glassfish.jersey.server.model.ResourceMethodInvoker.apply(ResourceMethodInvoker.java:81) - at org.glassfish.jersey.server.ServerRuntime$1.run(ServerRuntime.java:255) - at org.glassfish.jersey.internal.Errors$1.call(Errors.java:248) - at org.glassfish.jersey.internal.Errors$1.call(Errors.java:244) - at org.glassfish.jersey.internal.Errors.process(Errors.java:292) - at org.glassfish.jersey.internal.Errors.process(Errors.java:274) - at org.glassfish.jersey.internal.Errors.process(Errors.java:244) - at org.glassfish.jersey.process.internal.RequestScope.runInScope(RequestScope.java:265) - at org.glassfish.jersey.server.ServerRuntime.process(ServerRuntime.java:234) - at org.glassfish.jersey.server.ApplicationHandler.handle(ApplicationHandler.java:684) - at org.glassfish.jersey.servlet.WebComponent.serviceImpl(WebComponent.java:394) - at org.glassfish.jersey.servlet.WebComponent.service(WebComponent.java:346) - at org.glassfish.jersey.servlet.ServletContainer.service(ServletContainer.java:358) - at org.glassfish.jersey.servlet.ServletContainer.service(ServletContainer.java:311) - at org.glassfish.jersey.servlet.ServletContainer.service(ServletContainer.java:205) - at org.eclipse.jetty.servlet.ServletHolder.handle(ServletHolder.java:764) - at org.eclipse.jetty.servlet.ServletHandler.doHandle(ServletHandler.java:508) - at org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:221) - at org.eclipse.jetty.server.handler.ContextHandler.doHandle(ContextHandler.java:1375) - at org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:176) - at org.eclipse.jetty.servlet.ServletHandler.doScope(ServletHandler.java:463) - at org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:174) - at org.eclipse.jetty.server.handler.ContextHandler.doScope(ContextHandler.java:1297) - at org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:129) - at org.eclipse.jetty.server.handler.ContextHandlerCollection.handle(ContextHandlerCollection.java:192) - at org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:122) - at org.eclipse.jetty.server.Server.handle(Server.java:562) - at org.eclipse.jetty.server.HttpChannel.lambda$handle$0(HttpChannel.java:505) - at org.eclipse.jetty.server.HttpChannel.dispatch(HttpChannel.java:762) - at org.eclipse.jetty.server.HttpChannel.handle(HttpChannel.java:497) - at org.eclipse.jetty.server.HttpConnection.onFillable(HttpConnection.java:282) - at org.eclipse.jetty.io.AbstractConnection$ReadCallback.succeeded(AbstractConnection.java:319) - at org.eclipse.jetty.io.FillInterest.fillable(FillInterest.java:100) - at org.eclipse.jetty.io.SelectableChannelEndPoint$1.run(SelectableChannelEndPoint.java:53) - at org.eclipse.jetty.util.thread.strategy.AdaptiveExecutionStrategy.runTask(AdaptiveExecutionStrategy.java:412) - at org.eclipse.jetty.util.thread.strategy.AdaptiveExecutionStrategy.consumeTask(AdaptiveExecutionStrategy.java:381) - at org.eclipse.jetty.util.thread.strategy.AdaptiveExecutionStrategy.tryProduce(AdaptiveExecutionStrategy.java:268) - at org.eclipse.jetty.util.thread.strategy.AdaptiveExecutionStrategy.produce(AdaptiveExecutionStrategy.java:190) - at org.eclipse.jetty.util.thread.QueuedThreadPool.runJob(QueuedThreadPool.java:894) - at org.eclipse.jetty.util.thread.QueuedThreadPool$Runner.run(QueuedThreadPool.java:1038) - at java.base/java.lang.Thread.run(Thread.java:829) -Caused by: java.lang.NullPointerException - at org.eclipse.dataspaceconnector.sql.translation.SqlConditionExpression.isValidExpression(SqlConditionExpression.java:53) - at java.base/java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:195) - at java.base/java.util.ArrayList$ArrayListSpliterator.forEachRemaining(ArrayList.java:1655) - at java.base/java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:484) - at java.base/java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:474) - at java.base/java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:913) - at java.base/java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) - at java.base/java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:578) - at org.eclipse.dataspaceconnector.sql.assetindex.schema.BaseSqlDialectStatements.createQuery(BaseSqlDialectStatements.java:108) - at org.eclipse.dataspaceconnector.sql.assetindex.SqlAssetIndex.lambda$queryAssets$2(SqlAssetIndex.java:144) - at org.eclipse.dataspaceconnector.transaction.local.LocalTransactionContext.execute(LocalTransactionContext.java:63) - ... 69 more -``` - -#### Solution 1: Update all Criteria manually - -Root of this issue is that the operator, left- and right-operand Criteria field names changed. - -| Old | New | -|:----------|:-------------| -| left | operandLeft | -| right | operandRight | -| op | operator | - -It is possible to resolve this issue by updating the content of the column, that contain JSON serialized constraints, -from - -```json -{"criteria":[{"left":"asset:prop:id","op":"=","right":"asset-1"}]} -``` - -to - -```json -{"criteria":[{"operandLeft":"asset:prop:id","operator":"=","operandRight":"asset-1"}]} -``` - -#### Solution 2: Delete all rows containing Constraints - -Instead of updating each row in the database it's also possible to delete all Contract Definitions and Policies. -Additionally it's necessary to delete all Negotiations, as they might reference existing Contract Definitions and/or -Policies. - -Theoretically it's also necessary to delete Contract Agreements. As their deletion is already described in another -section, we can skip them here. - -##### Required Queries - -```sql -DELETE -FROM edc_contract_negotiation; -``` - -```sql -DELETE -FROM edc_contract_definitions; -``` - -```sql -DELETE -FROM edc_policydefinitins; -``` - -### 1.2 Delete Contract Agreements - -In the new version contract agreement rows contain a serialized policy at the time, the contract was concluded. -With the EDC update all existing Contract Agreements must be deleted. - -#### Required Query - -```sql -DELETE -FROM edc_contract_agreement; -``` - -## 2. Data Management API - -It might be necessary to update applications and scripts that use the Data Management API. This section covers the most -important changes in endpoints and payloads. - -### 2.1 Policy Path - -The Data Management API Path for Policies changes from -`/policies` to `/policydefinitions`. - -#### Get All Policies - -```bash -curl -X GET "${DATA_MGMT_ENDPOINT}/data/policydefinitions" --header "X-Api-Key: " --header "Content-Type: application/json" -``` - -### 2.2 Policy Payload - -The Policy Payload now wraps the policy details in an additional policy object. - -#### New Payload - -```json -{ - "uid": "1", - "policy": { - "prohibitions": [], - "obligations": [], - "permissions": [] - } -} -``` - -#### Old Payload - -```json -{ - "uid": "1", - "prohibitions": [], - "obligations": [], - "permissions": [] -} -``` - -### 2.3 Criteria in Payload of Contract Definitions and Policies - -The payload of a Policy or a Contract Definition may contain one or more Criteria. The format of these serialized Criteria changed. -Please note that there is no input validation, that detects errors when the old Criteria format is used! - -#### Old Criterion Format - -```json -{ "left": "asset:prop:id", "op": "=", "right": "1" } -``` - -#### New Criterion Format - -```json -{ "operandLeft": "asset:prop:id", "operator": "=", "operandRight": "1" } -``` - -#### Example Call - -```bash -curl -X POST "${DATA_MGMT_ENDPOINT}/data/contractdefinitions" --header "X-Api-Key: " --header "Content-Type: application/json" --data "{ \"id\": \"1\", \"criteria\": [ { \"operandLeft\": \"asset:prop:id\", \"operator\": \"=\", \"operandRight\": \"1\" } ], \"accessPolicyId\": \"1\", \"contractPolicyId\": \"1\" }" -``` - -### 2.4 Data Address - -When using a Data Address of type `HttpData` please notice that the property `endpoint` changed to `baseUrl`. This -property is mostly used when creating assets. - -#### Old Asset format - -```json -{ - "asset": { - ... - }, - "dataAddress": { - "properties": { - "endpoint": "http://provider-backend-service:8080/data/asset-1", - "type": "HttpData" - } - } -} -``` - -#### New Asset format - -```json -{ - "asset": { - ... - }, - "dataAddress": { - "properties": { - "baseUrl": "http://provider-backend-service:8080/data/asset-1", - "type": "HttpData" - } - } -} -``` - -#### Example Call - -```bash -curl -X POST "$PLATO_DATAMGMT_URL/data/assets" --header "X-Api-Key: password" --header "Content-Type: application/json" --data "{ \"asset\": { \"properties\": { \"asset:prop:id\": \"1\", \"asset:prop:description\": \"Tractus-X EDC Demo Asset\" } }, \"dataAddress\": { \"properties\": { \"type\": \"HttpData\", \"baseUrl\": \"https://jsonplaceholder.typicode.com/todos/1\" } } }" -s -o /dev/null -w 'Response Code: %{http_code}\n' -``` - -## 3. Connector Configuration - -### 3.1 Token Validation Endpoint Setting - -In the past the token validation endpoint was configured in `edc.controlplane.validation-endpoint`. This setting key -must be renamed to `edc.dataplane.token.validation.endpoint`. - -### 3.2 DataPlane Selector - -With this version a new feature was introduced which allows to have separate DataPlane instances for different -transfer-flows (HttpProxy, S3, etc.). The Tractus-X EDC also has a new extension which allows for a -simpler registration of additional dataplanes. Further documentation can -be found in the extension folder: -[dataplane-selector-configuration](../../edc-extensions/dataplane-selector-configuration/README.md) diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.1.0_0.1.1.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.1.0_0.1.1.md deleted file mode 100644 index 528dc8c3724..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.1.0_0.1.1.md +++ /dev/null @@ -1,82 +0,0 @@ -# Migration Version 0.1.0 to 0.1.1 - -This document contains a list of breaking changes that are introduced in version 0.1.1. - ---- - -**Please Note**: -Due to a change in the DAPS authentication mechanism this version cannot exchange messages with older EDC versions! - ---- - -## 0. Summary - -1. Data Management API - 1. Policy Payload -2. Connector Configuration - 1. CX OAuth Extension - -## 1. Data Management API - -It might be necessary to update applications and scripts that use the Data Management API. This section covers the most -important changes in endpoints and payloads. - -### 1.1 Policy Payload - -The id field of the PolicyDefinition was renamed from `uid` to `id`. - -#### Old Call - -```json -{ - "uid": "1", - "policy": { - "prohibitions": [], - "obligations": [], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "USE" - }, - "constraints": [] - } - ] - } -} -``` - -#### New call - -```json -{ - "id": "1", - "policy": { - "prohibitions": [], - "obligations": [], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "USE" - }, - "constraints": [] - } - ] - } -} -``` - -## 2. Connector Configuration - -### 2.1. CX OAuth Extension - -All connectors are now shipped with a new OAuth extension. This extension has an additional mandatory setting called `edc.ids.endpoint.audience`, that must be set to the IDS path. - -[Documentation](../../edc-extensions/cx-oauth2/README.md) - -#### Example - -```properties -edc.ids.endpoint.audience=http://plato-edc-controlplane:8282/api/v1/ids/data -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.1.2_0.1.3.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.1.2_0.1.3.md deleted file mode 100644 index 787b04bfe5f..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.1.2_0.1.3.md +++ /dev/null @@ -1,23 +0,0 @@ -# Migration Version 0.1.2 to 0.1.3 - -This document contains a list of breaking changes that are introduced in version 0.1.3. - -## OAuth2 Extension - -As the images now use the official OAuth2 Extension, the audience settings need to the updated. - -Add the following settings: - -- EDC_OAUTH_PROVIDER_AUDIENCE -- EDC_OAUTH_ENDPOINT_AUDIENCE - -Remove the following setting: - -- EDC_IDS_ENDPOINT_AUDIENCE - -Example: - -```yaml -EDC_OAUTH_PROVIDER_AUDIENCE: idsc:IDS_CONNECTORS_ALL -EDC_OAUTH_ENDPOINT_AUDIENCE: http://plato-edc-controlplane:8282/api/v1/ids/data -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.1.x_0.3.x.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.1.x_0.3.x.md deleted file mode 100644 index f35d3aa5e26..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.1.x_0.3.x.md +++ /dev/null @@ -1,35 +0,0 @@ -# Migration from 0.1.x to 0.3.x - -## Deprecation - -- the `edc-controlplane` and `edc-dataplane` charts are deprecated, please use `tractusx-connector` which combines the former ones - -## Management API changes - -Details at the [official documentation on swaggerhub](https://app.swaggerhub.com/apis/eclipse-edc-bot/management-api/0.0.1-SNAPSHOT) - -- Management API for creating resources (assets, policydefinitions, contractdefinitions, ...) will return a body containing the id of the created resource -- Added a `POST /request` for every management endpoint (assets, policydefinitions, ...) to query all the resources. The existent `GET /` have been deprecated -- added `id` field in `DataRequestDTO` (`/transferprocess` management api), if not set it will use a randomly generated one. -- Removed field `assetId` from `ContractOffer`. It was always null though, so there should be nothing to do about it. -- on `POST /contractdefinitions` a `duration` field can be added to control the duration of the contract. -- added the `GET /assets/{id}/address` endpoint to being able to retrieve the stored `DataAddress` - -## Settings changes - -- refactored the HTTP server contexts (more details on the [related decision record](https://eclipse-edc.github.io/docs/#/submodule/Connector/docs/developer/decision-records/2022-11-09-api-refactoring/renaming)). They need to be refactored as: - - `web.http.data` becomes `web.http.management` - - `web.http.ids` becomes `web.http.protocol` - - `web.http.validation`, `web.http.controlplane` and `web.http.dataplane` become `web.http.control` -- Healthcheck api now it's exposed under the `management` context. -- Removed default value for setting `edc.transfer.proxy.token.verifier.publickey.alias` so it must be valued accordingly -- made the state machine settings configurable so it will be possible to tune them accordingly. More details in the [related documentation entry](https://eclipse-edc.github.io/docs/#/submodule/Connector/docs/developer/performance-tuning). -- renamed `edc.receiver.http.endpoint` to `edc.receiver.http.dynamic.endpoint` -- renamed `edc.oauth.public.key.alias` setting to `edc.oauth.certificate.alias` - -## Other changes - -- Supported `/public` data plane endpoint without trailing slash, that can be eventually removed from the configuration -- packages name changed from `org.eclipse.dataspaceconnector` to `org.eclipse.edc` -- To specify multiple BPN into Policies the operator `OR` can be used. More details in the [business-partner-validation extension documentation](../../edc-extensions/business-partner-validation) -- HTTP Dynamic Endpoint Data Reference: The URL for Endpoint Data Reference can be also provided via the call for starting the transfer process. More details [Http Dynamic EDR receiver](https://github.com/eclipse-edc/Connector/tree/main/extensions/control-plane/transfer/transfer-pull-http-dynamic-receiver) diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.3.0_0.3.1.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.3.0_0.3.1.md deleted file mode 100644 index fab476bd089..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.3.0_0.3.1.md +++ /dev/null @@ -1,15 +0,0 @@ -# Migration from 0.3.0 to 0.3.1 - -## Observability API changes - -All endpoints (`/health`, `/startup`, `/liveness`, `/readiness`) of the Observability API now support unauthenticated access, if configured. That will put the -Observability API under a new context named `"observability"`, which consequently requires proper web context -configuration for it. Note that the name of the context cannot be changed. - -## Settings changes - -- `tractusx.api.observability.allow-insecure`: boolean value that enables (`true`) the unauthenticated access. -- `web.http.observability.port`: integer value that specifies the port of the `observability` context. **Mandatory if - unauthenticated access is enabled!** -- `web.http.observability.path`: string value that specifies the path of the `observability` context. **Mandatory if - unauthenticated access is enabled!** diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.3.1_0.3.2.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.3.1_0.3.2.md deleted file mode 100644 index 4099e8c4b67..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.3.1_0.3.2.md +++ /dev/null @@ -1,9 +0,0 @@ -# Migration from 0.3.0 to 0.3.1 - -## Configuration of Azure KeyVault - -When using Helm Charts that use the Azure KeyVault (`edc-runtime-memory`, `edc-controlplane-postgres`) -it is now possible to select _either_ authentication via Client Secret (`azure.vault.secret`) or via -certificate (`azure.vault.certificate`). - -If neither of the two is configured, the runtime will fail to start issuing an error. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.3.3_0.3.4.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.3.3_0.3.4.md deleted file mode 100644 index a93de960061..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.3.3_0.3.4.md +++ /dev/null @@ -1,21 +0,0 @@ -# Migration from 0.3.3 to 0.3.4 - -## Refactoring of Helm Charts - -In issue [#136](https://github.com/eclipse-tractusx/tractusx-edc/issues/136) work has begun to split the Helm charts up -into several technology-focused charts: - -- In-memory: for testing and development -- PostgreSQL+Hashicorp: this is the **recommended** distribution of Tractus-X EDC -- (Azure KeyVault: uses Azure KeyVault instead of Hashicorp Vault.) - Work in Progress - -Unfortunately, due to time constraints, we had to release 0.3.4 **without** the Azure KeyVault chart, it will be -included in one of the subsequent releases in the future. - -**Please note that the Azure KeyVault variant is not included in the 0.3.4 Release! If you rely on AZKV please do NOT -upgrade to 0.3.4 yet!** - -## Change in Docker image publishing - -Starting with the 0.3.3 release we switched over to publish our Docker images -to [Docker Hub](https://hub.docker.com/search?q=tractusx) instead of GHCR. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.3.4_0.4.0.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.3.4_0.4.0.md deleted file mode 100644 index 5090fc1371e..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.3.4_0.4.0.md +++ /dev/null @@ -1,98 +0,0 @@ -# Migration from 0.3.4 to 0.4.0 - -## Switching to DSP - -The Eclipse Dataspace Connector protocol recently moved its protocol implementation from IDS to DSP as of -version `0.0.1-milestone-9`. -From the Tractus-X EDC perspective this causes breaking changes in the following areas: - -- the Management API: because DSP uses JSON-LD, all Management API endpoints had to be adapted as well to reflect that. - The old Management API is now deprecated and is **not** tested for compliance. Please upgrade using the `/v2/` path - for every endpoint, e.g. `/management/v2/assets`. Please also refer to - the [EDC OpenAPI spec](https://app.swaggerhub.com/apis/eclipse-edc-bot/management-api/0.0.1-SNAPSHOT#/). - An updated postman collection with the `v2` flow is available [here](../development/postman/collection.json) - -- modules: all `*ids*` modules are deprecated and cannot be used anymore. Please migrate over - to `org.eclipse.edc:dsp:0.0.1-milestone-9`. - -- path: the default protocol path is now `/api/v1/dsp` instead of `/api/v1/ids` - -- `edc.participant.id`: new mandatory configuration for the participant id in the dataspace (BPN number). - It's configured via mandatory property in the charts with object ```yaml participant: id: "id"```. - -**Please note that this is not a complete documentation of the DSP Protocol, please refer to -the [official documentation](https://docs.internationaldataspaces.org/dataspace-protocol/overview/readme)** - -## Removal of the Business Tests - -The business tests were removed from the code base, because all the ever tested is already by other tests, specifically -the JUnit-based tests, deployment tests, or other tests that are already done upstream in EDC. - -The Business tests were brittle, consumed a lot of resources and were quite cumbersome to run and debug locally. - -## New implementation for the Control Plane Adapter - -Since the old Control-Plane-Adapter is incompatible with DSP, a new iteration was created. -**Due to time constraints with this release documentation for this feature will to be published subsequently** - -## New Policies for expressing validity of the agreement - -The dates in `ContractOffer` and `ContractAgreement` has been removed in favour of a policy based contract validity check, see [here](https://github.com/eclipse-edc/Connector/issues/2758) - -## Other changes - -- When using the EDR [HttpDynamicReceiverExtension](https://github.com/eclipse-edc/Connector/tree/main/extensions/control-plane/transfer/transfer-pull-http-dynamic-receiver) in the transfer process initiation - the properties for configuring the receiver on single transfer process has been changed to: - - ```json - "privateProperties": { - "receiverHttpEndpoint": "{{BACKEND_SERVICE}}" - } - ``` - - instead of: - - ```json - "properties": { - "receiver.http.endpoint": "{{BACKEND_SERVICE}}" - } - ``` - -## New Catalog - -The DSP catalog is expressed as [DCat Catalog](https://www.w3.org/TR/vocab-dcat-3/), when querying the catalog a response like this will return: - -```json -{ - "@id": "5a3207ae-bd0d-4a3b-bc8a-05adfbe75d95", - "@type": "dcat:Catalog", - "dcat:dataset": { - "@id": "e6279569-17a9-4ba3-9401-a8ae4100e4eb", - "@type": "dcat:Dataset", - "odrl:hasPolicy": { - "@id": "2:1:535def6e-8321-4c0e-a595-aabdd9c18eed", - "@type": "odrl:Set", - "odrl:permission": [], - "odrl:prohibition": [], - "odrl:obligation": [], - "odrl:target": "1" - }, - "dcat:distribution": [ - ... - ], - "edc:description": "Product EDC Demo Asset", - "edc:id": "1" - }, - "dcat:service": { - ... - }, - "edc:participantId": "participantId", - "@context": { - } -} -``` - -When starting a new contract negotiation for an asset: - -- the `@id` of `odrl:hasPolicy` object should be passed in the `offerId` field -- the `edc:participantId` should be passed in the `providerId` and `connectorId` fields. `connectorId` it's still needed for backward compatibility and it will probably be removed in the next versions. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.4.x_0.5.x.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.4.x_0.5.x.md deleted file mode 100644 index cb92328d25f..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/migration/Version_0.4.x_0.5.x.md +++ /dev/null @@ -1,130 +0,0 @@ -# Migration from 0.4.x to 0.5.x - -## Replacing DAPS with SSI - -DAPS was deprecated as identity provider, and was replaced with an Self-Sovereign-Identity solution based on a -centralized Managed Identity Wallet (MIW) using VerifiableCredentials. Initially, there will be one SummaryCredential, -which conflates all relevant information. This is intended as interim solution and will later be replaced with a more -appropriate structure. - -### Relevant terminology - -Please make sure to be at least somewhat familiar with the following terms before you read on: - -- VerifiableCredential -- VerifiablePresentation -- JWT - JSON Web Token -- DSP - the DataSpace Protocol - -### Preconditions - -All of these preconditions must be met before Tractus-X EDC `v0.5.x` is usable in a production use case. Please read -them carefully and make sure you understand the implications. - -- every connector instance must have a - signed [SummaryCredential](https://github.com/eclipse-tractusx/ssi-docu/tree/main/docs/credentials/summary) sitting in - the MIW. This is typically done by the Portal during participant onboarding. -- the connector must have an account with Keycloak and be able to obtain access tokens. -- the connector must be able to reach both MIW and Keycloak via HTTP - -### Authentication flow - quick intro - -The basic workflow for a connector runtime to authenticate an incoming request is described in this section. Please note -that this procedure is limited to connector-to-connector communication via the Dataspace Protocol (DSP), it does not -relate to other APIs such as the Management API. - -When a request is made by the Consumer, it obtains an access token from Keycloak, which it uses to authenticate to MIW. -It then requests its SummaryCredential from MIW, which is returned in the form of a signed JWT that contains a -VerifiablePresentation (VP). That JWT is attached to the outgoing request as authorization header. -The Provider then decodes the JWT, validates its claims, and then uploads the VP to MIW for verification. Upon -successful verification, the Provider proceeds to process the request. - -Please also check -out [this flow diagram](https://github.com/eclipse-tractusx/ssi-docu/blob/main/docs/architecture/cx-3-2/flow.svg) and -the associated [documentation](https://github.com/eclipse-tractusx/ssi-docu/tree/main/docs/architecture/cx-3-2). - -### Connecting to MIW - -For connector onboarding, please contact the Portal Team. After that, you should receive: - -- the issuer BPN: this is the BPN of the MIW -- your client id: this is the Keycloak Client ID -- your client secret: this the Keycloak Client Secret. Please store this in a secure vault and remember the `alias`. - *Do not leak or publish this!* - -In order to establish a connection to MIW, and you are using EDC on code level, please be sure to -follow [this documentation](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/edc-extensions/ssi/ssi-miw-credential-client). -If you are using the official Helm charts, please check -out [this documentation](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/charts/tractusx-connector/README.md). - -If you are using the MIW and Keycloak instances deployed to `INT`, the following values apply: - -- MIW Url: -- Keycloak Token URL: -- Authority BPN: `BPNL00000003CRHK` - -> Please be aware that the above values are *only* valid for the Catena-X INT environment and *will* change on other -> environments! For instructions on how to set up a local MIW + Keycloak, please take a look -> at [this documentation](https://github.com/catenax-ng/tx-managed-identity-wallets/blob/features/java-did-web/README.md). - -### Further documentation on SSI - -Please find more information in -the [SSI Documentation Repository](https://github.com/eclipse-tractusx/ssi-docu/tree/main/docs/architecture/cx-3-2). - -### Noteworthy things and Caveats - -- the MIWs REST API is secured with a token that can be obtained from a Keycloak instance. This Keycloak instance must - be configured appropriately ahead of time. -- connectors have to be able to obtain a token from Keycloak, so it must have an account with that Keycloak instance -- we do **not** ship either MIW or Keycloak nor do we provide support for either of them. Please contact the respective - Tractus-X projects for instructions how to set them up. -- our official Helm charts now use SSI instead of DAPS. However, the charts do **not** include a dependency onto MIW of - Keycloak, nor do they contain configuration for them. They do, however, contain a configuration section (titled `ssi`) - that configures EDC. -- our Helm charts can be installed, and the connector application will boot up, but unless MIW and Keycloak are - configured properly and both can be reached over network by the connector, every DSP request to another connector will - fail. However, the ManagementAPI can still be used to create Assets, Policies and ContractDefinitions. -- At the time of releasing Tractus-X EDC `0.5.0`, a couple of critical issues regarding MIW are - still [in progress](https://jira.catena-x.net/projects/CGD/issues/CGD-291), and the code base is still on a feature - branch. For those reasons we recommend to use *non-production data only*! -- the centralized MIW is an interim solution, and is bound to be replaced with a decentralized/distributed architecture - in upcoming Catena-X releases. - -## The Observability API changes - -The following settings are removed because the `observability-api-customization` extension will be no longer used. -The `Observability API` extension will be used instead - -- `observability.port` -- `observability.path` -- `observability.insecure` - -The status (`/health`, `/startup`, `/liveness`, `/readiness`) of the EDC can be checked by using the default endpoint. - -## The Consumer Pull flow changes - -Starting from `0.5.0-rc5` which incorporates `EDC` 0.1.3, the consumer pull has been simplified in upstream, and it -can cause some breaking changes on users usage. The change is reflected in -this [diagram](https://github.com/eclipse-edc/Connector/blob/main/docs/developer/architecture/data-transfer/diagrams/transfer-data-plane-consumer-pull.png). - -The main difference is that in the previous iteration of the pull flow there were two EDRs involved. One created by the -provider while serving -a transfer request, and one created by the consumer (wrapping the provider one). The consumer one then was dispatched to -the EDR receivers for requesting -the data via consumer dataplane. - -In the current iteration the receivers now receive directly the provider EDR without the double "wrapping" and can be -used directly to fetch data -from the provider dataplane, without passing thought to the consumer dataplane. - -The shape of the EDR has not been changed so, if in the backend systems the EDR#endpoint was used as url for fetching -data, it should not cause any -breaking changes. - -If the backend system manually forward the EDR to the consumer dataplane or tries to decode it via consumer validate -token APIs, -this will not work with signature check errors, as the EDR is the one signed by the provider. - -> Note the custom property `cid` in the EDR, it's not available anymore. The property it's still available inside the -> JWT `authCode` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/README.md deleted file mode 100644 index f14e5863aa9..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Samples - -In this folder are listed some documents that will help you setting up a connector execute some use cases. - -- [Local setup](./example-dataspace/README.md) -- [Transfer data](./Transfer%20Data.md) -- [Data Plane HTTP OAuth2](./data-plane-http-oauth2.md) diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/Transfer Data.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/Transfer Data.md deleted file mode 100644 index 3460e38e15b..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/Transfer Data.md +++ /dev/null @@ -1,371 +0,0 @@ -# Transfer Data - -This document will showcase a data transfer between two connectors. - -For this transfer connector **Bob** will act as data provider, and connector **Alice** will act as data -consumer. But the roles could be inverse as well. - -> Please note: Before running the examples the corresponding environment variables must be set. -> How such an environment can be setup locally is documented in [chapter 1](#1-optional---local-setup). - -## Table of Content - -- [Transfer Data](#transfer-data) - - [Table of Content](#table-of-content) - - [1. Optional - Local Setup](#1-optional---local-setup) - - [See Node Ports using Minikube](#see-node-ports-using-minikube) - - [See Node Ports using Kubernetes](#see-node-ports-using-kubernetes) - - [Set Environment Variables, used by this example](#set-environment-variables-used-by-this-example) - - [2. Setup Data Offer](#2-setup-data-offer) - - [3. Request Contract Offer Catalog](#3-request-contract-offer-catalog) - - [4. Negotiate Contract](#4-negotiate-contract) - - [5. Transfer Data](#5-transfer-data) - - [6. Verify Data Transfer](#6-verify-data-transfer) - - [Delete All Data](#delete-all-data) - -## 1. Optional - Local Setup - -To create a local setup with two connectors have a look at -the [Local TXDC Setup Documentation](../samples/example-dataspace/README.md). -It creates two connectors (Plato & Sokrates) with exposed Node Ports. - -### See Node Ports using Minikube - -Run the following command. - -```shell -minkube service list -``` - -Minikube will then print out something like this: - -```plain -|-------------|-----------------------|-----------------|---------------------------| -| NAMESPACE | NAME | TARGET PORT | URL | -|-------------|-----------------------|-----------------|---------------------------| -| cx | backend | frontend/8080 | http://192.168.49.2:31918 | -| | | backend/8081 | http://192.168.49.2:30193 | < Transfer Backend API -| cx | ids-daps | No node port | -| cx | plato-controlplane | default/8080 | http://192.168.49.2:31016 | -| | | control/8083 | http://192.168.49.2:32510 | -| | | data/8081 | http://192.168.49.2:30423 | < Plato Data Management API -| | | validation/8082 | http://192.168.49.2:30997 | -| | | ids/8084 | http://192.168.49.2:32709 | < Plato IDS API -| | | metrics/8085 | http://192.168.49.2:31124 | -| cx | plato-dataplane | No node port | -| cx | sokrates-controlplane | default/8080 | http://192.168.49.2:32297 | -| | | control/8083 | http://192.168.49.2:32671 | -| | | data/8081 | http://192.168.49.2:31772 | < Sokrates Data Management API -| | | validation/8082 | http://192.168.49.2:30540 | -| | | ids/8084 | http://192.168.49.2:32543 | < Sokrates IDS API -| | | metrics/8085 | http://192.168.49.2:30247 | -| cx | sokrates-dataplane | No node port | -| cx | vault | No node port | -| cx | vault-internal | No node port | -| cx | vault-ui | No node port | -| default | kubernetes | No node port | -| kube-system | kube-dns | No node port | -|-------------|-----------------------|-----------------|---------------------------| -``` - -The most important APIs, used by this example, are highlighted. How they are used is described in subchapter ['Set -Environment Variables](#set-environment-variables-used-by-this-example), used by this example below. - -### See Node Ports using Kubernetes - -Using Kubernetes only the Node Ports of each Service must be checked separately. - -Run - -```shell -kubectl describe service -n cx plato-controlplane -``` - -or - -```shell -kubectl describe service -n cx sokrates-controlplane -``` - -Kubernetes will then print out something like this. - -```plain -Name: plato-controlplane -Namespace: cx -Labels: app.kubernetes.io/component=edc-controlplane - app.kubernetes.io/instance=plato-controlplane - app.kubernetes.io/managed-by=Helm - app.kubernetes.io/name=tractusx-connector-controlplane - app.kubernetes.io/part-of=edc - app.kubernetes.io/version=0.2.0 - helm.sh/chart=tractusx-connector-0.2.0 -Annotations: meta.helm.sh/release-name: plato - meta.helm.sh/release-namespace: cx -Selector: app.kubernetes.io/instance=plato-controlplane,app.kubernetes.io/name=tractusx-connector-controlplane -Type: NodePort -IP Family Policy: SingleStack -IP Families: IPv4 -IP: 10.110.180.57 -IPs: 10.110.180.57 -Port: default 8080/TCP -TargetPort: default/TCP -NodePort: default 31016/TCP -Endpoints: 172.17.0.6:8080 -Port: control 8083/TCP -TargetPort: control/TCP -NodePort: control 32510/TCP -Endpoints: 172.17.0.6:8083 -Port: data 8081/TCP -TargetPort: data/TCP -NodePort: data 30423/TCP < Plato Data Manamgent API -Endpoints: 172.17.0.6:8081 -Port: validation 8082/TCP -TargetPort: validation/TCP -NodePort: validation 30997/TCP -Endpoints: 172.17.0.6:8082 -Port: ids 8084/TCP -TargetPort: ids/TCP -NodePort: ids 32709/TCP < Plato IDS API -Endpoints: 172.17.0.6:8084 -Port: metrics 8085/TCP -TargetPort: metrics/TCP -NodePort: metrics 31124/TCP -Endpoints: 172.17.0.6:8085 -Session Affinity: None -External Traffic Policy: Cluster -Events: -``` - -The most important APIs, used by this example, are highlighted. How they are used is described in subchapter ['Set -Environment Variables](#set-environment-variables-used-by-this-example), used by this example below. -In comparison to the Minikube example this call shows only the ports. To call the ports the Kubernetes Node IP / URL is -required. Where to get the IP may vary depending on how Kubernetes is deployed. - -### Set Environment Variables, used by this example - -Environment Variables, containing a URL, used by this example are - -- BOB_DATAMGMT_URL -- ALICE_DATAMGMT_URL -- BOB_IDS_URL -- ALICE_BACKEND_URL - -Let's assume we will use Sokrates as Bob, and Plato as Alice. - -**BOB_DATAMGMT_URL** must be the Node URL. In this local setup it would be `http://192.168.49.2:31772` - -**ALICE_DATAMGMT_URL** must be the Node URL. In this local setup it would be `http://192.168.49.2:30423` - -**BOB_IDS_URL** must be internal Kubernetes URL. In this local setup `http://sokrates-controlplane:8084` - -**ALICE_BACKEND_URL** must the Node URL. In this local setup it would be `http://192.168.49.2:30193` - -## 2. Setup Data Offer - -Set up a data offer in **Bob**, so that **Alice** has something to consume. - -In case you are unfamiliar with the EDC terms `Asset`, `Policy` or `ContractDefinition` please have a look at the -official open source documentation ([link](https://github.com/eclipse-edc/Connector/blob/main/docs/developer/architecture/domain-model.md)). - -![Sequence 1](diagrams/transfer_sequence_1.png) - -The following commands will create an Asset, a Policy and a Contract Definition. -For simplicity `https://jsonplaceholder.typicode.com/todos/1` is used as data source of the asset, but could be any -other API, that is reachable from the Provider Data Plane. - -```bash -curl -X POST "${BOB_DATAMGMT_URL}/data/assets" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - --data '{ - "asset": { - "properties": { - "asset:prop:id": "1", - "asset:prop:description": "Tractus-X EDC Demo Asset" - } - }, - "dataAddress": { - "properties": { - "type": "HttpData", - "baseUrl": "https://jsonplaceholder.typicode.com/todos/1" - } - } - }' \ - -s -o /dev/null -w 'Response Code: %{http_code}\n' -``` - -```bash -curl -X POST "${BOB_DATAMGMT_URL}/data/policydefinitions" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - --data '{ - "id": "1", - "policy": { - "prohibitions": [], - "obligations": [], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { "type": "USE" }, - "constraints": [] - } - ] - } - }' \ - -s -o /dev/null -w 'Response Code: %{http_code}\n' -``` - -```bash -curl -X POST "${BOB_DATAMGMT_URL}/data/contractdefinitions" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - --data '{ - "id": "1", - "criteria": [ - { - "operandLeft": "asset:prop:id", - "operator": "=", - "operandRight": "1" - } - ], - "accessPolicyId": "1", - "contractPolicyId": "1" - }' \ - -s -o /dev/null -w 'Response Code: %{http_code}\n' -``` - -## 3. Request Contract Offer Catalog - -In this step Alice gets told to request contract offers from another connector (in this case Bob). Alice will -then request the catalog over IDS messaging. - -For IDS messaging connectors will identify each other using the configured IDS DAPS. Therefore, it is important that -connectors, that intent to send messages to each other, have the same DAPS instance configured. - -![Sequence 1](diagrams/transfer_sequence_2.png) - -Run: - -```bash -curl -G -X GET "${ALICE_DATAMGMT_URL}/data/catalog" \ - --data-urlencode "providerUrl=${BOB_IDS_URL}/api/v1/ids/data" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - -s | jq -``` - -## 4. Negotiate Contract - -Initiate a contract negotiation for the asset (from step 1). Part of the negotiation payload is the contract -offer (received in step 2). - -In the diagram the IDS contract negotiation is marked as simplified, because the EDC is exchanging multiple messages -during contract negotiation. But the inter-controlplane communication is not in the scope of this document. - -After the negotiation is initiated ensure that is has concluded. This is done by requesting the negotiation from the API -and checking whether the `contractAgreementId` is set. This might take a few seconds. - -![Sequence 1](diagrams/transfer_sequence_3.png) - -Run: - -```bash -export NEGOTIATION_ID=$( \ - curl -X POST "${ALICE_DATAMGMT_URL}/data/contractnegotiations" \ - --header "X-Api-Key: password" \ - --header "Content-Type: application/json" \ - --data "{ - \"connectorId\": \"foo\", - \"connectorAddress\": \"${BOB_IDS_URL}/api/v1/ids/data\", - \"offer\": { - \"offerId\": \"1:foo\", - \"assetId\": \"1\", - \"policy\": { - \"uid\": \"1\", - \"prohibitions\": [], - \"obligations\": [], - \"permissions\": [ - { - \"edctype\": \"dataspaceconnector:permission\", - \"action\": { \"type\": \"USE\" }, - \"target\": \"1\", - \"constraints\": [] - } - ] - } - } - }" \ - -s | jq -r '.id') -``` - -```bash -curl -X GET "${ALICE_DATAMGMT_URL}/data/contractnegotiations/${NEGOTIATION_ID}" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - -s | jq -``` - -## 5. Transfer Data - -Initiate a data transfer using the contract agreement from the negotiation (from step 3). Then wait until the state of -the transfer process is `COMPLETED`. - -![Sequence 1](diagrams/transfer_sequence_4.png) - -Run: - -```bash -export CONTRACT_AGREEMENT_ID=$( \ - curl -X GET "$ALICE_DATAMGMT_URL/data/contractnegotiations/$NEGOTIATION_ID" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - -s | jq -r '.contractAgreementId') -``` - -```bash -export TRANSFER_PROCESS_ID=$(tr -dc '[:alnum:]' < /dev/urandom | head -c20) -export TRANSFER_ID=$( \ - curl -X POST "${ALICE_DATAMGMT_URL}/data/transferprocess" \ - --header "X-Api-Key: password" \ - --header "Content-Type: application/json" \ - --data "{ - \"id\": \"${TRANSFER_PROCESS_ID}\", - \"connectorId\": \"foo\", - \"connectorAddress\": \"${BOB_IDS_URL}/api/v1/ids/data\", - \"contractId\": \"${CONTRACT_AGREEMENT_ID}\", - \"assetId\": \"1\", - \"managedResources\": \"false\", - \"dataDestination\": { \"type\": \"HttpProxy\" } - }" \ - -s | jq -r '.id') -``` - -```bash -curl -X GET "${ALICE_DATAMGMT_URL}/data/transferprocess/${TRANSFER_ID}" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - -s | jq -``` - -## 6. Verify Data Transfer - -After the transfer is complete the Backend Application has downloaded the data. The Backend Application stores the data -locally. In this demo the transfer can be verified by executing a simple `cat` call in the Pod. - -![Sequence 1](diagrams/transfer_sequence_5.png) - -```bash -curl -X GET "${ALICE_BACKEND_URL}/${TRANSFER_PROCESS_ID}" \ - --header 'Accept: application/octet-stream' \ - -s | jq -``` - -## Delete All Data - -```bash -minikube kubectl -- delete pvc -n edc-all-in-one --all -``` - -```bash -minikube kubectl -- delete pv -n edc-all-in-one --all -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/data-plane-http-oauth2.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/data-plane-http-oauth2.md deleted file mode 100644 index 63b99319fbc..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/data-plane-http-oauth2.md +++ /dev/null @@ -1,7 +0,0 @@ -# Data Plane HTTP OAuth2 - -The Data Plane HTTP OAuth2 extension permits the data-plane to fetch the data requested from a consumer from an HTTP server -with an OAuth2 authentication layer. - -For further documentation, please refer to the extension README: - diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_1.png b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_1.png deleted file mode 100644 index 22500abc3cf..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_1.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_1.puml b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_1.puml deleted file mode 100644 index b49733a0197..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_1.puml +++ /dev/null @@ -1,34 +0,0 @@ -@startuml - -!define aliceColor 66CCFF -!define bobColor CCFF99 -!define dapsColor FFFF99 -!define noteColor 9999FF - -actor User as "User" - -box Alice - participant AliceControlPlane as "Control Plane" #aliceColor - participant AliceBackendService as "Backend Application" #aliceColor - participant AliceDataPlane as "Data Plane" #aliceColor -end box - -box Bob - participant BobControlPlane as "Control Plane" #bobColor - participant BobDataPlane as "Data Plane" #bobColor -end box - -participant JsonPlaceHolder as "JsonPlaceHolder" - - -User -> BobControlPlane ++ : Create Asset -return 204 - -User -> BobControlPlane ++ : Create Policy -return 204 - -User -> BobControlPlane ++ : Create Contract Definition -return 204 - - -@enduml diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_2.png b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_2.png deleted file mode 100644 index 95b6eeced3a..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_2.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_2.puml b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_2.puml deleted file mode 100644 index 2d078607d02..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_2.puml +++ /dev/null @@ -1,28 +0,0 @@ -@startuml - -!define aliceColor 66CCFF -!define bobColor CCFF99 -!define dapsColor FFFF99 -!define noteColor 9999FF - -actor User as "User" - -box Alice - participant AliceControlPlane as "Control Plane" #aliceColor - participant AliceBackendService as "Backend Application" #aliceColor - participant AliceDataPlane as "Data Plane" #aliceColor -end box - -box Bob - participant BobControlPlane as "Control Plane" #bobColor - participant BobDataPlane as "Data Plane" #bobColor -end box - -participant JsonPlaceHolder as "JsonPlaceHolder" - -User -> AliceControlPlane ++ : Request Contract Offers from Bob - AliceControlPlane -> BobControlPlane ++ : IDS Description Request Message - return Description -return Contract Offers - -@enduml diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_3.png b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_3.png deleted file mode 100644 index 14a30c9a915..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_3.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_3.puml b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_3.puml deleted file mode 100644 index 7bec9eadb87..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_3.puml +++ /dev/null @@ -1,33 +0,0 @@ -@startuml - -!define aliceColor 66CCFF -!define bobColor CCFF99 -!define dapsColor FFFF99 -!define noteColor 9999FF - -actor User as "User" - -box Alice - participant AliceControlPlane as "Control Plane" #aliceColor - participant AliceBackendService as "Backend Application" #aliceColor - participant AliceDataPlane as "Data Plane" #aliceColor -end box - -box Bob - participant BobControlPlane as "Control Plane" #bobColor - participant BobDataPlane as "Data Plane" #bobColor -end box - -participant JsonPlaceHolder as "JsonPlaceHolder" - - -User -> AliceControlPlane ++ : Negotiate Contract for Offer X -AliceControlPlane --> User: Negotiation ID - AliceControlPlane -> BobControlPlane ++ : IDS Contract Negotiation (simplified) - return Contract Agreement -deactivate AliceControlPlane - -User -> AliceControlPlane ++ : Request Negotiation by ID -return Contract Negotiation - -@enduml diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_4.png b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_4.png deleted file mode 100644 index e3630e70aff..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_4.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_4.puml b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_4.puml deleted file mode 100644 index 6d4e936ed78..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_4.puml +++ /dev/null @@ -1,44 +0,0 @@ -@startuml - -!define aliceColor 66CCFF -!define bobColor CCFF99 -!define dapsColor FFFF99 -!define noteColor 9999FF - -actor User as "User" - -box Alice - participant AliceControlPlane as "Control Plane" #aliceColor - participant AliceBackendService as "Backend Application" #aliceColor - participant AliceDataPlane as "Data Plane" #aliceColor -end box - -box Bob - participant BobControlPlane as "Control Plane" #bobColor - participant BobDataPlane as "Data Plane" #bobColor -end box - -participant JsonPlaceHolder as "JsonPlaceHolder" - -User -> AliceControlPlane ++ : Request Negotiation by ID -return Contract Negotiation\n(containing Contract Agreement ID) - -User -> AliceControlPlane ++ : Initiate Transfer with Agreement ID -AliceControlPlane --> User : Transfer Process ID - AliceControlPlane -> BobControlPlane ++ : IDS Data Transfer (simplified) -return -AliceControlPlane -> AliceBackendService ++ : Data Plane Endpoint + Token - AliceBackendService -> AliceDataPlane ++ : Request Data with Token - AliceDataPlane -> BobDataPlane ++ : Request Data - BobDataPlane -> JsonPlaceHolder ++ : Request Data - return data - return data - return data - AliceBackendService -> AliceBackendService : Write Data to File -return ok -deactivate AliceControlPlane - -User -> AliceControlPlane ++ : Request Transfer Process by ID -return Transfer Process - -@enduml diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_5.png b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_5.png deleted file mode 100644 index 1a18b5be2d9..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_5.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_5.puml b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_5.puml deleted file mode 100644 index 598b747b6fa..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_5.puml +++ /dev/null @@ -1,27 +0,0 @@ -@startuml - -!define aliceColor 66CCFF -!define bobColor CCFF99 -!define dapsColor FFFF99 -!define noteColor 9999FF - -actor User as "User" - -box Alice - participant AliceControlPlane as "Control Plane" #aliceColor - participant AliceBackendService as "Backend Application" #aliceColor - participant AliceDataPlane as "Data Plane" #aliceColor -end box - -box Bob - participant BobControlPlane as "Control Plane" #bobColor - participant BobDataPlane as "Data Plane" #bobColor -end box - -participant JsonPlaceHolder as "JsonPlaceHolder" - -User -> AliceBackendService ++ : Get File Content -return data - - -@enduml diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/edr-api-overview/edr-api-overview.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/edr-api-overview/edr-api-overview.md deleted file mode 100644 index 578cc6ecd2c..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/edr-api-overview/edr-api-overview.md +++ /dev/null @@ -1,135 +0,0 @@ -# Endpoint Data Reference API Overview - -## Introduction - -The **Endpoint Data Reference** serves the purpose of streamlining the consumer connector operators' interactions. Through its API, acts as a facade for two fundamental processes involved in Asset consumption: **contract negotiation** and **transfer process** initialization and additionally, it enables the management of **EDR**s (Endpoint Data References). - -## Configuration - -The new API is seamlessly deployed under the well-known management API context, requiring no additional configuration. However, this is not the case for the EDR Cache storage. The EDR Cache provides two implementations: `InMemory` and `SQL`. The `edc-runtime-memory` bundle utilizes the `InMemory` implementation for the EDR Cache without any extra setup. On the other hand, the SQL Cache, found in the `edc-controlplane-postgresql-*` bundles, utilizes the SQL implementation and requires database access for schema migration and data management. - -| property | description | required | default value | -|-----------------------------------------------------------|------------------------------------------------------|----------|---------------| -| edc.datasource.edr.name | Defines the name associated with the EDR data source | false | edr | -| edc.datasource.edr.url | Defines the database address to access the EDR data | true | | -| edc.datasource.edr.user | Defines EDR database username | true | | -| edc.datasource.edr.password | Defines EDR database password | true | | - -## Features - -### EDR Negotiation | Contract Negotiation and Transfer Process in a single request - -This endpoint will perform the contract negotiation, transfer process and EDR storage respectively. - -> Please note that the `data destination` will always be `HttpProxy`, requiring a request against the provider's `data-plane` to fetch the asset data. - -| Path | Method | Query Params | -|---------------------------------|--------|--------------------------| -| `/edrs` | POST | none | - -#### Payload - -```json -{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/", - "odrl": "http://www.w3.org/ns/odrl/2/" - }, - "@type": "NegotiationInitiateRequestDto", - "connectorAddress": "", - "protocol": "dataspace-protocol-http", - "connectorId": "", - "providerId": "", - "offer": { - "offerId": "", - "assetId": "", - "policy": { - "@type": "odrl:Set", - "odrl:permission": { - "odrl:target": "", - "odrl:action": { - "odrl:type": "USE" - } - }, - "odrl:target": "" - } - } -} -``` - -#### EDR Negotiation Response - -```json -{ - "@type": "edc:IdResponseDto", - "@id": "contract-negotiation-id", - "edc:createdAt": 1687405819736, - "@context": { - "dct": "https://purl.org/dc/terms/", - "tx": "https://w3id.org/tractusx/v0.0.1/ns/", - "edc": "https://w3id.org/edc/v0.0.1/ns/", - "dcat": "https://www.w3.org/ns/dcat/", - "odrl": "http://www.w3.org/ns/odrl/2/", - "dspace": "https://w3id.org/dspace/v0.8/" - } -} -``` - -### EDR Management | Fetch cached EDRs - -This endpoint will retrieve all EDR entries by their `assetId` or `agreementId` references, which are passed as `query parameters`. - -| Path | Method | Query Params | -|----------------------------------------------|--------|----------------------| -| `/edrs` | GET | assetId, agreementId | - -#### EDR Entry Response - -```json -[ - { - "@type": "tx:EndpointDataReferenceEntry", - "edc:agreementId": "contract-agreement-id", - "edc:transferProcessId": "transfer-process-id", - "edc:assetId": "asset-id", - "@context": { - "dct": "https://purl.org/dc/terms/", - "tx": "https://w3id.org/tractusx/v0.0.1/ns/", - "edc": "https://w3id.org/edc/v0.0.1/ns/", - "dcat": "https://www.w3.org/ns/dcat/", - "odrl": "http://www.w3.org/ns/odrl/2/", - "dspace": "https://w3id.org/dspace/v0.8/" - } - } -] -``` - -This endpoint, through the `transfer-process-id` passed as `path variable`, will retrieve the actual EDR. - -| Path | Method | Query Params | -|-----------------------------------------------|--------|--------------------------| -| `/edrs/{transfer-process-id}` | GET | none | - -#### EDR Response - -```json -{ - "@type": "edc:DataAddress", - "edc:cid": "cid", - "edc:type": "EDR", - "edc:authCode": "authcode", - "edc:endpoint": "http://provider-data-plane/public-url", - "edc:id": "transfer-process-id", - "edc:authKey": "Authorization", - "@context": { - "dct": "https://purl.org/dc/terms/", - "tx": "https://w3id.org/tractusx/v0.0.1/ns/", - "edc": "https://w3id.org/edc/v0.0.1/ns/", - "dcat": "https://www.w3.org/ns/dcat/", - "odrl": "http://www.w3.org/ns/odrl/2/", - "dspace": "https://w3id.org/dspace/v0.8/" - } -} -``` - -> Please note that now with the EDR you are able to request the `Asset` data from provider's `data-plane`. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/example-dataspace/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/example-dataspace/README.md deleted file mode 100644 index 0dcd8933d2a..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/example-dataspace/README.md +++ /dev/null @@ -1,128 +0,0 @@ -# How-To run two connectors and a DAPS - -## 1. Prepare environment - -This guide will bring up two connectors named "Sokrates" and "Plato", each alongside their dependencies (Hashicorp -Vault, PostgreSQL) and a DAPS instance that both share. - -We've tested this setup with [KinD](https://kind.sigs.k8s.io/), but other runtimes such -as [Minikube](https://minikube.sigs.k8s.io/docs/start/) may work as well, we just haven't tested them. - -This version of Tractus-X EDC _requires_ a running instance of the Managed Identity Wallet and Keycloak, a connector -will not be able to communicate to another connector without it. - -Installation instructions for those are beyond the scope of this document, please refer to the respective manuals and -guides for information on how to set them up. - -Furthermore, this guide assumes: - -- the Tractus-X EDC repository is checked out, the working directory for this guide is `docs/samples/example-dataspace` -- a Kubernetes runtime (e.g. KinD) is already installed and ready-to-use -- basic knowledge about `helm` and Kubernetes -- the following tools are available: `yq`, `openssl`, `base64` -- a POSIX-compliant shell, e.g. `bash` or `zsh` unless stated otherwise - -### 1.1 Create secrets for both runtimes - -We'll need a x509 certificate in order to communicate with DAPS, as well as a private key and a Data Encryption signing -key. - -```shell -# SOKRATES aes encryption key -echo "aes_enckey_test" | base64 > sokrates.aes.key - -# PLATO aes encryption key -echo "aes_enckey_test" | base64 > plato.aes.key -``` - -Any arbitrary string can be used for the AES key, but it has to be 16, 24, or 32 characters in length, assuming UTF-8 -encoding. - -### 1.2 Obtain configuration for MiW and Keycloak - -> The following information is _required_, your connectors will **not** work properly unless you -> modify the `ssi:` section of `sokrates-values.yaml` and `plato-values.yaml` accordingly! - -For communication with Keycloak we need the following information - -- the `tokenurl`: URL where access tokens can be obtained -- the `client.id`: Keycloak identifier of the connector - -Note that the OAuth2 client secret will be stored in the vault under the alias `client-secret`. - -In order to use MiW as credential backend we need the following information: - -- `url`: a URL where MiW is reachable -- `authorityId`: this is the `issuerIdentifier` for MiW REST requests, please refer to the respective documentation. - -Furthermore, we need the `endpoint.audience`, which is used to verify the `aud` claim of incoming requests. This does **not** have to be set explicitly, it defaults to each connector's callback address. - -## 2. Prepare Connectors - -Next, the certificates and private keys we created previously must be stored in each connector's vault by injecting -a `postStart` element to the chart's configuration file: - -```shell -# for sokrates -VALUES_FILE=sokrates-values.yaml -CLIENT_SECRET= -AES_KEY=$(cat sokrates.aes.key) -yq -i ".vault.server.postStart |= [\"sh\",\"-c\",\"{\nsleep 5\n -/bin/vault kv put secret/client-secret content=$CLIENT_SECRET\n -/bin/vault kv put secret/aes-keys content=$AES_KEY\n}\"]" "$VALUES_FILE" - -# for plato -VALUES_FILE=plato-values.yaml -CLIENT_SECRET= -AES_KEY=$(cat plato.aes.key) -yq -i ".vault.server.postStart |= [\"sh\",\"-c\",\"{\nsleep 5\n -/bin/vault kv put secret/client-secret content=$CLIENT_SECRET\n -/bin/vault kv put secret/aes-keys content=$AES_KEY\n}\"]" "$VALUES_FILE" -``` - -## 3 Install the connectors - -Use `helm` to install the Tractus-X EDC Helm charts. In this example we are using the _local_ charts, assuming you have -Tractus-X EDC checked out in your local filesystem at ``. - -```shell -# install sokrates -helm install tx-sokrates /charts/tractusx-connector \ - -f sokrates-values.yaml \ - --dependency-update - -# install plato -helm install tx-plato /charts/tractusx-connector \ - -f plato-values.yaml \ - --dependency-update -``` - -_Note: if you prefer to use the published version of the `tractusx-connector` chart, please add the Tractus-X Helm repo -first:_ - -```shell -helm repo add tractusx-edc https://eclipse-tractusx.github.io/charts/dev -helm install tx-[sokrates|plato] tractusx-edc/tractusx-connector \ - -f [sokrates|plato]-values.yaml \ - --dependency-update -``` - -## 3.1 [Optional] Verify the correct installation - -There is several ways of making sure everything worked out well: - -- simply look at the logs of the Helm releases, e.g. with a tool - like [stern](https://kubernetes.io/blog/2016/10/tail-kubernetes-with-stern/) and look out for a log line similar to: - - ```shell - stern tx-sokrates - ``` - - then look out for something similar to: - - ```shell - tx-sokrates-controlplane-b9456f97b-s5jts tractusx-connector INFO 2023-05-31T07:24:53.020975888 tx-sokrates-controlplane ready - ``` - -- wait for the Kubernetes rollout to be successful, e.g. `kubectl rollout status deployment tx-plato-controlplane` -- use `helm test` to execute tests: `helm test tx-plato` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/1-management-api-overview.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/1-management-api-overview.md deleted file mode 100644 index 5f241750d24..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/1-management-api-overview.md +++ /dev/null @@ -1,60 +0,0 @@ -# Management API Overview - -## Introduction - -With the introduction of the new [Dataspace Protocol](https://docs.internationaldataspaces.org/dataspace-protocol/overview/readme), now using JSON-LD, all Management API endpoints had to be adapted as well to reflect that. -JSON-LD (JSON for Linked Data) is an extension of JSON that introduces a set of principles and mechanisms to enable interoperability. - -This document will showcase how this change impacts the management API usage. - -## 1. Modified Endpoints - -The `MANAGEMENT_URL` specifies the URL of the management API and the prefixes `v2` and `v3` allows access to the most recent functionalities of the management API. - -| Resource | Endpoint | -|-----------------------|--------------------------------------------| -| Asset | `/v3/assets` | -| Policy Definition | `/v2/policydefinitions` | -| Contract Definition | `/v2/contractdefinitions` | -| Catalog | `/v2/catalog` | -| Contract Negotiation | `/v2/contractnegotiations` | -| Contract Agreement | `/v2/contractagreements` | -| Transfer Process | `/v2/transferprocesses` | - -## 2. Brief JSON-LD Introduction - -JSON-LD includes several important keywords that play a crucial role in defining the structure, semantics, and relationships within a JSON-LD document. Since some keys which are required in requests for the new management API aren't self-explanatory when you first see them, here are some of the most commonly used and important keywords in JSON-LD. -These keys are generally part of the JSON-LD spec and serve as identification on a larger scope. Please also refer to the [JSON-LD spec](https://www.w3.org/TR/json-ld11/). - -### Keywords - -| Key | Description | -|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| @context | Specifies the context for interpreting the meaning of terms and properties within a JSON-LD document. It associates terms with namespaces, vocabularies, or URLs. | -| @vocab | Sets a default namespace or vocabulary for expanding terms within a JSON-LD document. It allows for a more concise representation of properties by omitting the namespace prefix for commonly used terms. | -| @id | Represents the unique identifier (URI or IRI) for a node or resource within a JSON-LD document. It allows for linking and referencing resources. | -| @type | Indicates the type(s) of a node or resource. It is used to specify the class or classes that the resource belongs to, typically using terms from a vocabulary or ontology. | - -### Namespaces - -A namespace is defined by associating a prefix with a URI or IRI in the @context of a JSON-LD document. The prefix is typically a short string, while the URI or IRI represents a namespace or vocabulary where the terms or properties are defined. - -| Key | Description | -|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| dct | Defines the prefix "dct" and associates it with the URI "". The prefix "dct" can now be used in the JSON-LD document to represent terms from the Dublin Core Metadata Terms vocabulary. | -| edc | Defines the prefix "edc" and associates it with the URI "". The prefix "edc" can now be used to represent terms from the EDC (Eclipse Dataspace Connect) vocabulary. | -| dcat | Defines the prefix "dcat" and associates it with the URI "". The prefix "dcat" can now be used to represent terms from the DCAT (Data Catalog Vocabulary) vocabulary. | -| odrl | Defines the prefix "odrl" and associates it with the URI "". The prefix "odrl" can now be used to represent terms from the ODRL (Open Digital Rights Language) vocabulary. | -| dspace | Defines the prefix "dspace" and associates it with the URI "". The prefix "dspace" can now be used to represent terms from the DSpace vocabulary. | - -> Please note: The namespace `edc` currently is only a placeholder and does not lead to any JSON-LD context definition or vocabulary. -> This will change at a later date. - -## 3. Walkthrough - -1. [Create an Asset](2-assets.md) -2. [Create a Policy Definition](3-policy-definitions.md) -3. [Create Contract Definition](4-contract-definitions.md) -4. [Fetch provider's Catalog](5-catalog.md) -5. [Initiate Contract Negotiation](6-contract-negotiation.md) -6. [Initiate Transfer Process](7-transfer-process.md) diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/2-assets.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/2-assets.md deleted file mode 100644 index 68c4bd0c452..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/2-assets.md +++ /dev/null @@ -1,80 +0,0 @@ -# Creating an Asset - -## Old plain JSON Schema - -```json -{ - "asset": { - "id": "", - "properties": { - "name": "", - "description": "", - "version": "", - "contenttype": "" - } - }, - "dataAddress": { - "properties": { - "type": "" - } - } -} -``` - -## New JSON-LD Document - -> Please note: In our samples, properties **WILL NOT** be explicitly namespaced, and internal nodes **WILL NOT** be typed, relying on `@vocab` prefixing and root schema type inheritance respectively. - -```json -{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/" - }, - "@type": "Asset", - "@id": "", - "properties": { - "name": "", - "description": "", - "version": "", - "contenttype": "" - }, - "privateProperties": { - "private-property": "" - }, - "dataAddress": { - "type": "" - } -} -``` - -A new addition are the `privateProperties`. -Private properties will not be sent through the dataplane and are only accessible via the management API. -This enables the storage of additional information pertaining the asset, that is not relevant for the consumer, but is nonetheless useful for the provider. -Private properties are stores inside the `privateProperties` field. - -> Please note: -> `privateProperties` are entirely optional and the field is not required for creating or updating an asset. -> `dataAddress` should correspond to one of the supported types by the connector, e.g. HttpData and AmazonS3, and it should include all the necessary properties associated with the chosen type. - -## Request - -In this case we generate a very simple asset, that only contains the minimum in terms of information. -For this we need both an asset and a data address, which together form an asset entry. - -```bash -curl -X POST "${MANAGEMENT_URL}/v3/assets" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - --data '{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/" - }, - "@type": "Asset", - "@id": "asset-id" - "dataAddress": { - "type": "HttpData", - "baseUrl": "https://jsonplaceholder.typicode.com/todos" - } - }' \ - -s -o /dev/null -w 'Response Code: %{http_code}\n' -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/3-policy-definitions.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/3-policy-definitions.md deleted file mode 100644 index 7acf439ff6a..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/3-policy-definitions.md +++ /dev/null @@ -1,98 +0,0 @@ -# Creating a Policy Definition - -## Old plain JSON Schema - -```json -{ - "id": "", - "policy": { - "permissions": [ - { - "action": { - "type": "USE" - }, - "constraints": [ - { - "leftExpression": { - "value": "" - }, - "rightExpression": { - "value": "" - }, - "operator": "" - } - ] - } - ], - "prohibition": [], - "obligation": [] - } -} -``` - -## New JSON-LD Document - -Policy model is now pure [ODRL (Open Digital Rights Language)](https://www.w3.org/TR/odrl-model/) and going through it would help get a more complete picture. - -> Please note: In our samples, except from `odrl` vocabulary terms that must override `edc` default prefixing, properties **WILL NOT** be explicitly namespaced, and internal nodes **WILL NOT** be typed, relying on `@vocab` prefixing and root schema type inheritance respectively. - -```json -{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/", - "odrl": "http://www.w3.org/ns/odrl/2/" - }, - "@type":"PolicyDefinition", - "@id": "", - "policy": { - "odrl:permission": [ - { - "odrl:action": "USE", - "odrl:constraint": [ - { - "odrl:leftOperand": "", - "odrl:operator": "", - "odrl:rightOperand": "" - }] - } - ], - "odrl:prohibition": [], - "odrl:obligation": [] - } -} -``` - -## Request - -In this case we generate a very simple policy definition, that only contains the minimum in terms of information. -A Policy MUST have at least one permission, prohibition, or obligation property value of type Rule and in our case it will hold a permission defining our well-known `BusinessPartnerNumber` validation `Constraint`. - -```bash -curl -X POST "${MANAGEMENT_URL}/v2/policydefinitions" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - --data '{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/", - "odrl": "http://www.w3.org/ns/odrl/2/" - }, - "@type":"PolicyDefinition", - "@id": "policy-definition-id", - "policy": { - "odrl:permission": [ - { - "odrl:action": "USE", - "odrl:constraint": [ - { - "odrl:leftOperand": "BusinessPartnerNumber", - "odrl:operator": "eq", - "odrl:rightOperand": "BPN" - }] - } - ], - "odrl:prohibition": [], - "odrl:obligation": [] - } - }' \ - -s -o /dev/null -w 'Response Code: %{http_code}\n' -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/4-contract-definitions.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/4-contract-definitions.md deleted file mode 100644 index 2b308e39bbb..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/4-contract-definitions.md +++ /dev/null @@ -1,70 +0,0 @@ -# Creating a Contract Definition - -## Old plain JSON Schema - -```json -{ - "id": "", - "accessPolicyId": "", - "contractPolicyId": "", - "assetsSelector": [ - { - "operandLeft": "", - "operator": "", - "operandRight": "" - } - ] -} -``` - -## New JSON-LD Document - -> Please note: In our samples, properties **WILL NOT** be explicitly namespaced, and internal nodes **WILL NOT** be typed, relying on `@vocab` prefixing and root schema type inheritance respectively. - -```json -{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/" - }, - "@type": "ContractDefinition", - "@id": "", - "accessPolicyId": "", - "contractPolicyId": "", - "assetsSelector": [ - { - "operandLeft": "", - "operator": "", - "operandRight": "" - } - ] -} -``` - -## Request - -In this case we generate a very simple contract definition, that only contains the minimum in terms of information. -A Contract Definition MUST have `accessPolicy`, `contractPolicy` identifiers and `assetsSelector`property values. -The `operandLeft` property value MUST contain the asset property full qualified term `/`, in our case `https://w3id.org/edc/v0.0.1/ns/id`. - -```bash -curl -X POST "${MANAGEMENT_URL}/v2/contractdefinitions" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - --data '{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/" - }, - "@type": "ContractDefinition", - "@id": "contract-definition-id", - "accessPolicyId": "policy-id, - "contractPolicyId": "policy-id", - "assetsSelector": [ - { - "operandLeft": "https://w3id.org/edc/v0.0.1/ns/id", - "operator": "=", - "operandRight": "asset-id" - } - ] - }' \ - -s -o /dev/null -w 'Response Code: %{http_code}\n' -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/5-catalog.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/5-catalog.md deleted file mode 100644 index e865f93507b..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/5-catalog.md +++ /dev/null @@ -1,66 +0,0 @@ -# Fetching provider's Catalog - -## Old plain JSON Schema - -```json -{ - "protocol" : "ids-protocol-http", - "providerUrl": "", - "querySpec": { - "offset": 0, - "limit": 100, - "filter": "", - "range": { - "from": 0, - "to": 100 - }, - "sortField": "", - "criterion": "" - } -} -``` - -## New JSON-LD Document - -> Please note: In our samples, properties **WILL NOT** be explicitly namespaced, and internal nodes **WILL NOT** be typed, relying on `@vocab` prefixing and root schema type inheritance respectively. - -```json -{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/" - }, - "protocol" : "dataspace-protocol-http", - "providerUrl": "", - "querySpec": { - "offset": 0, - "limit": 100, - "filterExpression": { - "operandLeft": "", - "operator": "", - "operandRight": "" - } - } -} -``` - -## Request - -In this case we fetch a provider catalog. - -```bash -curl -X POST "${MANAGEMENT_URL}/v2/catalog/request" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - --data '{ - "@context": { - "vocab": "https://w3id.org/edc/v0.0.1/ns/" - }, - "protocol" : "dataspace-protocol-http", - "providerUrl": "http://provider-control-plane:8282/api/v1/dsp", - "querySpec": { - "offset": 0, - "limit": 100 - } - }' \ - -s -o /dev/null -w 'Response Code: %{http_code}\n' -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/6-contract-negotiation.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/6-contract-negotiation.md deleted file mode 100644 index c1b5db05065..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/6-contract-negotiation.md +++ /dev/null @@ -1,97 +0,0 @@ -# Initiation a Contract Negotiation - -## Old plain JSON Schema - -```json -{ - "connectorAddress": "provider-dsp-url", - "protocol": "dataspace-protocol-http", - "connectorId": "", - "providerId": "", - "offer": { - "offerId": "", - "assetId": "", - "policy": { - "permissions": [], - "prohibition": [], - "obligation": [] - } - } -} -``` - -## New JSON-LD Document - -> Please note: In our samples, properties **WILL NOT** be explicitly namespaced, and internal nodes **WILL NOT** be typed, relying on `@vocab` prefixing and root schema type inheritance respectively. - -```json -{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/", - "odrl": "http://www.w3.org/ns/odrl/2/" - }, - "@type": "NegotiationInitiateRequestDto", - "connectorAddress": "provider-dsp-url", - "protocol": "dataspace-protocol-http", - "connectorId": "", - "providerId": "", - "offer": { - "offerId": "", - "assetId": "", - "policy": { - "@type": "odrl:Set", - "odrl:permission": [], - "odrl:prohibition": [], - "odrl:obligation": [], - "odrl:target": "" - } - } -} -``` - -The `offerId` and `policy` must be the `odrl:Set` `@id` and content, respectively, of the one you chose to agree with from the `dcat:dataset` in the `dcat:catalog`. - -## Request - -In this case we initiate a contract negotiation with the provider. - -```bash -curl -X POST "${MANAGEMENT_URL}/v2/contractnegotiations" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - --data '{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/", - "odrl": "http://www.w3.org/ns/odrl/2/" - }, - "@type": "NegotiationInitiateRequestDto", - "connectorAddress": "provider-dsp-url", - "protocol": "dataspace-protocol-http", - "connectorId": "provider-id", - "providerId": "provider-id", - "offer": { - "offerId": "offer-id", - "assetId": "asset-id", - "policy": { - "@type": "odrl:Set", - "odrl:permission": { - "odrl:target": "asset-id", - "odrl:action": { - "odrl:type": "USE" - }, - "odrl:constraint": { - "odrl:or": { - "odrl:leftOperand": "BusinessPartnerNumber", - "odrl:operator": "EQ", - "odrl:rightOperand": "ANY-BPN" - } - } - }, - "odrl:prohibition": [], - "odrl:obligation": [], - "odrl:target": "asset-id" - } - } - }' \ - -s -o /dev/null -w 'Response Code: %{http_code}\n' -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/7-transfer-process.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/7-transfer-process.md deleted file mode 100644 index 19fe00ba08c..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/7-transfer-process.md +++ /dev/null @@ -1,79 +0,0 @@ -# Initiation a Transfer Process - -## Old plain JSON Schema - -```json -{ - "assetId": "", - "connectorAddress": "", - "contractId": "", - "dataDestination": { - "properties": { - "type": "" - } - }, - "managedResources": false, - "privateProperties": { - "receiverHttpEndpoint": "" - }, - "protocol": "ids-protocol-http", - "transferType": { - "contentType": "application/octet-stream", - "isFinite": true - } -} -``` - -## New JSON-LD Document - -> Please note: In our samples, properties **WILL NOT** be explicitly namespaced, and internal nodes **WILL NOT** be typed, relying on `@vocab` prefixing and root schema type inheritance respectively. - -```json -{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/", - "odrl": "http://www.w3.org/ns/odrl/2/" - }, - "assetId": "", - "connectorAddress": "", - "contractId": "", - "dataDestination": { - "type": "" - }, - "managedResources": false, - "privateProperties": { - "receiverHttpEndpoint": "" - }, - "protocol": "dataspace-protocol-http" -} -``` - -`dataDestination` should correspond to one of the supported types listed in the provider's catalog `dcat:distribution`, and it should include all the necessary properties associated with the chosen type. - -## Request - -In this case we initiate a transfer process with the provider. - -```bash -curl -X POST "${MANAGEMENT_URL}/v2/transferprocesses" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - --data '{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/", - "odrl": "http://www.w3.org/ns/odrl/2/" - }, - "assetId": "asset-id", - "connectorAddress": "provider-dsp-url", - "contractId": "contract-agreement-id", - "dataDestination": { - "type": "HttpProxy" - }, - "managedResources": false, - "privateProperties": { - "receiverHttpEndpoint": "http://receiver/endpoint" - }, - "protocol": "dataspace-protocol-http" - }' \ - -s -o /dev/null -w 'Response Code: %{http_code}\n' -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/README.md deleted file mode 100644 index 3f59218d5d2..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/README.md +++ /dev/null @@ -1,53 +0,0 @@ -# Control Plane - -The Eclipse Dataspace Connector consists of a **Control Plan** and a **Data Plane** Application. -While the **Data Plane** handles the actual Data Transfer, the **Control Plane** is responsible for: - -- Resource Management (e.g. Assets, Policies & Contract Definitions CRUD) -- Contract Offering & Contract Negotiation -- Data Transfer Coordination / Management - -The only API that is protected by some kind of security mechanism is the Data Management API. At the time of writing this is done by a simple API key. -The key value must be configured in `edc.api.auth.key`. All requests to the Data Management API must have `X-Api-Key` header with the key value. - -Example: - -```bash -curl -X GET --header "X-Api-Key: " -``` - -## Security - -### Confidential Settings - -Please be aware that there are several confidential settings, that should not be part of the actual EDC configuration file. - -Some of these confidential settings are - -- Vault credentials -- Data Management API key -- Database credentials - -As it is possible to configure EDC settings via environment variables, one way to do it would be via Kubernetes Secrets. For other deployment scenarios than Kubernetes equivalent measures should be taken. - -## Known Control Plane Issues - -Please have a look at the open issues in the open source repository. The list below might not be maintained well and -only contains the most important issues. -EDC GitHub Repository - ---- - -**Please note** that some of these issues might already be fixed on the EDC main branch, but are not part of the specific -EDC commit the Tractus-X-EDC uses. - ---- - -### Persistence - -- ContractDefinition-AssetSelector of InMemory Connector selects 50 Asset max.([issue](https://github.com/eclipse-edc/Connector/issues/1779)) - -### Other - -- Non-IDS-Transformable-ContractDefinition causes connector to be unable to send out self-descriptions/catalogs([issue](https://github.com/eclipse-edc/Connector/issues/1265)) - - **Workaround:** Delete non-transformable ContractDefinition or Policy. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-base/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-base/README.md deleted file mode 100644 index 269de27ca36..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-base/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# EDC Control-Plane Base Module - -## Building - -```shell -./gradlew edc-controlplane:edc-controlplane-base:build -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-memory-hashicorp-vault/notice.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-memory-hashicorp-vault/notice.md deleted file mode 100644 index 989bb709602..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-memory-hashicorp-vault/notice.md +++ /dev/null @@ -1,28 +0,0 @@ -# Notice for Docker image - -An EDC Control Plane using memory-based storage, and HashiCorp Vault as secret store. - -DockerHub: - -Eclipse Tractus-X product(s) installed within the image: - -## Tractus-X-EDC Control Plane - -- GitHub: -- Project home: -- Dockerfile: -- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE) - -## Used base image - -- [eclipse-temurin:17.0.6_10-jre-alpine](https://github.com/adoptium/containers) -- Official Eclipse Temurin DockerHub page: -- Eclipse Temurin Project: -- Additional information about the Eclipse Temurin - images: - -As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc -from the base distribution, along with any direct or indirect dependencies of the primary software being contained). - -As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies -with any relevant licenses for all software contained within. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-azure-vault/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-azure-vault/README.md deleted file mode 100644 index cd8f605ef13..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-azure-vault/README.md +++ /dev/null @@ -1,181 +0,0 @@ -# EDC Control-Plane backed by Postgresql - -## Building - -```shell -./gradlew :edc-controlplane:edc-controlplane-postgresql-azure-vault:dockerize -``` - -## Configuration - -Listed below are configuration keys needed to get the `edc-controlplane-postgresql-azure-vault` up and running. -Details regarding each configuration property can be found at the [documentary section of the EDC](https://github.com/eclipse-edc/Connector/tree/main/docs). - -| Key | Required | Example | Description | -|--------------------------------------------------|----------|------------------------------------------------------------------------------|----------------------------| -| edc.api.auth.key | | password | default value: random UUID | -| web.http.default.port | X | 8080 | | -| web.http.default.path | X | /api | | -| web.http.data.port | X | 8181 | | -| web.http.data.path | X | | | -| web.http.validation.port | X | 8182 | | -| web.http.validation.path | X | /validation | | -| web.http.control.port | X | 9999 | | -| web.http.control.path | X | /api/controlplane/control | | -| web.http.ids.port | X | 8282 | | -| web.http.ids.path | X | /api/v1/ids | | -| edc.receiver.http.endpoint | X | | | -| edc.ids.title | | Eclipse Dataspace Connector | | -| edc.ids.description | | Eclipse Dataspace Connector | | -| edc.ids.id | | urn:connector:edc | | -| edc.ids.security.profile | | base | | -| edc.ids.endpoint | | | | -| edc.ids.maintainer | | | | -| edc.ids.curator | | | | -| edc.ids.catalog.id | | urn:catalog:default | | -| ids.webhook.address | | | | -| edc.hostname | | localhost | | -| edc.oauth.token.url | X | | | -| edc.oauth.public.key.alias | X | key-to-daps-certificate-in-keyvault | | -| edc.oauth.private.key.alias | X | key-to-private-key-in-keyvault | | -| edc.oauth.client.id | X | daps-oauth-client-id | | -| edc.vault.clientid | X | 00000000-1111-2222-3333-444444444444 | | -| edc.vault.tenantid | X | 55555555-6666-7777-8888-999999999999 | | -| edc.vault.name | X | my-vault-name | | -| edc.vault.clientsecret | X | 34-chars-secret | | -| edc.datasource.asset.name | X | asset | | -| edc.datasource.asset.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_asset_db | | -| edc.datasource.asset.user | X | username | | -| edc.datasource.asset.password | X | password | | -| edc.datasource.contractdefinition.name | X | contractdefinition | | -| edc.datasource.contractdefinition.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractdefinition_db | | -| edc.datasource.contractdefinition.user | X | username | | -| edc.datasource.contractdefinition.password | X | password | | -| edc.datasource.contractnegotiation.name | X | contractnegotiation | | -| edc.datasource.contractnegotiation.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractnegotiation_db | | -| edc.datasource.contractnegotiation.user | X | username | | -| edc.datasource.contractnegotiation.password | X | password | | -| edc.datasource.policy.name | X | policy | | -| edc.datasource.policy.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_policy_db | | -| edc.datasource.policy.user | X | username | | -| edc.datasource.policy.password | X | password | | -| edc.datasource.transferprocess.name | X | transferprocess | | -| edc.datasource.transferprocess.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_transferprocess_db | | -| edc.datasource.transferprocess.user | X | username | | -| edc.datasource.transferprocess.password | X | password | | -| edc.transfer.proxy.endpoint | X | | | -| edc.transfer.proxy.token.signer.privatekey.alias | X | | | - -### Example configuration.properties - -JDK properties-style configuration of the EDC Control-Plane is expected to be mounted to `/app/configuration.properties` within the container. - -```shell -# Create configuration.properties -export CONFIGURATION_PROPERTIES_FILE=$(mktemp /tmp/configuration.properties.XXXXXX) -cat << 'EOF' > ${CONFIGURATION_PROPERTIES_FILE} - -web.http.default.port=8080 -web.http.default.path=/api -web.http.data.port=8181 -web.http.data.path=/data -web.http.validation.port=8182 -web.http.validation.path=/validation -web.http.control.port=9999 -web.http.control.path=/api/controlplane/control -web.http.ids.port=8282 -web.http.ids.path=/api/v1/ids - -edc.receiver.http.endpoint=http://backend-service - -edc.ids.title=Eclipse Dataspace Connector -edc.ids.description=Eclipse Dataspace Connector -edc.ids.id=urn:connector:edc -edc.ids.security.profile=base -edc.ids.endpoint=http://localhost:8282/api/v1/ids -edc.ids.maintainer=http://localhost -edc.ids.curator=http://localhost -edc.ids.catalog.id=urn:catalog:default -ids.webhook.address=http://localhost:8282/api/v1/ids - -edc.hostname=localhost - -edc.api.auth.key=password - -# OAuth / DAPS related configuration -edc.oauth.token.url=https://daps.example.net -edc.oauth.public.key.alias=key-to-daps-certificate-in-keyvault -edc.oauth.private.key.alias=key-to-private-key-in-keyvault -edc.oauth.client.id=daps-oauth-client-id - -# Azure vault related configuration -edc.vault.clientid=00000000-1111-2222-3333-444444444444 -edc.vault.tenantid=55555555-6666-7777-8888-999999999999 -edc.vault.name=my-vault-name -edc.vault.clientsecret=34-chars-secret - -# Control- / Data- Plane configuration -edc.transfer.proxy.endpoint=http://dataplane-public-endpoint/public -edc.transfer.proxy.token.signer.privatekey.alias=azure-vault-token-signer-private-key - -# Postgresql related configuration -edc.datasource.asset.name=asset -edc.datasource.asset.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_asset -edc.datasource.asset.user=user -edc.datasource.asset.password=pass -edc.datasource.contractdefinition.name=contractdefinition -edc.datasource.contractdefinition.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractdefinition -edc.datasource.contractdefinition.user=user -edc.datasource.contractdefinition.password=pass -edc.datasource.contractnegotiation.name=contractnegotiation -edc.datasource.contractnegotiation.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractnegotiation -edc.datasource.contractnegotiation.user=user -edc.datasource.contractnegotiation.password=pass -edc.datasource.policy.name=policy -edc.datasource.policy.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_policy -edc.datasource.policy.user=user -edc.datasource.policy.password=pass -edc.datasource.transferprocess.name=transferprocess -edc.datasource.transferprocess.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_transferprocess -edc.datasource.transferprocess.user=user -edc.datasource.transferprocess.password=pass - -EOF -``` - -### Example logging.properties - -```shell -# Create logging.properties -export LOGGING_PROPERTIES_FILE=$(mktemp /tmp/logging.properties.XXXXXX) -cat << 'EOF' > ${LOGGING_PROPERTIES_FILE} -.level=INFO -org.eclipse.edc.level=ALL -handlers=java.util.logging.ConsoleHandler -java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter -java.util.logging.ConsoleHandler.level=ALL -java.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n -EOF -``` - -### Example opentelemetry.properties - -```shell -# Create opentelemetry.properties -export OPENTELEMETRY_PROPERTIES_FILE=$(mktemp /tmp/opentelemetry.properties.XXXXXX) -cat << 'EOF' > ${OPENTELEMETRY_PROPERTIES_FILE} -otel.javaagent.enabled=true -otel.javaagent.debug=false -EOF -``` - -## Running - -```shell -docker run \ - -p 8080:8080 -p 8181:8181 -p 8182:8182 -p 8282:8282 -p 9090:9090 -p 9999:9999 \ - -v ${CONFIGURATION_PROPERTIES_FILE:-/dev/null}:/app/configuration.properties \ - -v ${LOGGING_PROPERTIES_FILE:-/dev/null}:/app/logging.properties \ - -v ${OPENTELEMETRY_PROPERTIES_FILE:-/dev/null}:/app/opentelemetry.properties \ - -i edc-controlplane-postgresql-azure-vault:latest -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-azure-vault/notice.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-azure-vault/notice.md deleted file mode 100644 index 7ada1443a75..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-azure-vault/notice.md +++ /dev/null @@ -1,28 +0,0 @@ -# Notice for Docker image - -An EDC Control Plane using PostgreSQL as persistence backend, and Azure KeyVault as secret store. - -DockerHub: - -Eclipse Tractus-X product(s) installed within the image: - -## Tractus-X EDC Control Plane - -- GitHub: -- Project home: -- Dockerfile: -- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE) - -## Used base image - -- [eclipse-temurin:17.0.6_10-jre-alpine](https://github.com/adoptium/containers) -- Official Eclipse Temurin DockerHub page: -- Eclipse Temurin Project: -- Additional information about the Eclipse Temurin - images: - -As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc -from the base distribution, along with any direct or indirect dependencies of the primary software being contained). - -As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies -with any relevant licenses for all software contained within. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault-legacy/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault-legacy/README.md deleted file mode 100644 index 1617b9ba862..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault-legacy/README.md +++ /dev/null @@ -1,178 +0,0 @@ -# EDC Control-Plane backed by Postgresql and HashiCorp vault - -## Building - -```shell -./gardlew :edc-controlplane:edc-controlplane-postgresql-hashicorp-vault:dockerize -``` - -## Configuration - -Listed below are configuration keys needed to get the `edc-controlplane-postgresql-hashicorp-vault` up and running. -Details regarding each configuration property can be found at the [documentary section of the EDC](https://github.com/eclipse-edc/Connector/tree/main/docs). - -| Key | Required | Example | Description | -|--------------------------------------------------|----------|------------------------------------------------------------------------------|----------------------------| -| edc.api.auth.key | | password | default value: random UUID | -| web.http.default.port | X | 8080 | | -| web.http.default.path | X | /api | | -| web.http.data.port | X | 8181 | | -| web.http.data.path | X | /data | | -| web.http.validation.port | X | 8182 | | -| web.http.validation.path | X | /validation | | -| web.http.control.port | X | 9999 | | -| web.http.control.path | X | /api/controlplane/control | | -| web.http.ids.port | X | 8282 | | -| web.http.ids.path | X | /api/v1/ids | | -| edc.receiver.http.endpoint | X | | | -| edc.ids.title | | Eclipse Dataspace Connector | | -| edc.ids.description | | Eclipse Dataspace Connector | | -| edc.ids.id | | urn:connector:edc | | -| edc.ids.security.profile | | base | | -| edc.ids.endpoint | | | | -| edc.ids.maintainer | | | | -| edc.ids.curator | | | | -| edc.ids.catalog.id | | urn:catalog:default | | -| ids.webhook.address | | | | -| edc.hostname | | localhost | | -| edc.oauth.token.url | X | | | -| edc.oauth.public.key.alias | X | key-to-daps-certificate-in-keyvault | | -| edc.oauth.private.key.alias | X | key-to-private-key-in-keyvault | | -| edc.oauth.client.id | X | daps-oauth-client-id | | -| edc.vault.hashicorp.url | X | | | -| edc.vault.hashicorp.token | X | 55555555-6666-7777-8888-999999999999 | | -| edc.vault.hashicorp.timeout.seconds | | 30 | | -| edc.datasource.asset.name | X | asset | | -| edc.datasource.asset.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_asset_db | | -| edc.datasource.asset.user | X | username | | -| edc.datasource.asset.password | X | password | | -| edc.datasource.contractdefinition.name | X | contractdefinition | | -| edc.datasource.contractdefinition.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractdefinition_db | | -| edc.datasource.contractdefinition.user | X | username | | -| edc.datasource.contractdefinition.password | X | password | | -| edc.datasource.contractnegotiation.name | X | contractnegotiation | | -| edc.datasource.contractnegotiation.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractnegotiation_db | | -| edc.datasource.contractnegotiation.user | X | username | | -| edc.datasource.contractnegotiation.password | X | password | | -| edc.datasource.policy.name | X | policy | | -| edc.datasource.policy.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_policy_db | | -| edc.datasource.policy.user | X | username | | -| edc.datasource.policy.password | X | password | | -| edc.datasource.transferprocess.name | X | transferprocess | | -| edc.datasource.transferprocess.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_transferprocess_db | | -| edc.datasource.transferprocess.user | X | username | | -| edc.datasource.transferprocess.password | X | password | | -| edc.transfer.proxy.endpoint | X | | | -| edc.transfer.proxy.token.signer.privatekey.alias | X | | | - -### Example configuration.properties - -JDK properties-style configuration of the EDC Control-Plane is expected to be mounted to `/app/configuration.properties` within the container. - -```shell -# Create configuration.properties -export CONFIGURATION_PROPERTIES_FILE=$(mktemp /tmp/configuration.properties.XXXXXX) -cat << 'EOF' > ${CONFIGURATION_PROPERTIES_FILE} - -web.http.default.port=8080 -web.http.default.path=/api -web.http.data.port=8181 -web.http.data.path=/data -web.http.validation.port=8182 -web.http.validation.path=/validation -web.http.control.port=9999 -web.http.control.path=/api/controlplane/control -web.http.ids.port=8282 -web.http.ids.path=/api/v1/ids - -edc.receiver.http.endpoint=http://backend-service - -edc.ids.title=Eclipse Dataspace Connector -edc.ids.description=Eclipse Dataspace Connector -edc.ids.id=urn:connector:edc -edc.ids.security.profile=base -edc.ids.endpoint=http://localhost:8282/api/v1/ids -edc.ids.maintainer=http://localhost -edc.ids.curator=http://localhost -edc.ids.catalog.id=urn:catalog:default -ids.webhook.address=http://localhost:8282/api/v1/ids - -edc.hostname=localhost - -edc.api.auth.key=password - -# OAuth / DAPS related configuration -edc.oauth.token.url=https://daps.example.net -edc.oauth.public.key.alias=key-to-daps-certificate-in-keyvault -edc.oauth.private.key.alias=key-to-private-key-in-keyvault -edc.oauth.client.id=daps-oauth-client-id - -# HashiCorp vault related configuration -edc.vault.hashicorp.url=http://vault -edc.vault.hashicorp.token=55555555-6666-7777-8888-999999999999 -edc.vault.hashicorp.timeout.seconds=30 - -# Control- / Data- Plane configuration -edc.transfer.proxy.endpoint=http://dataplane-public-endpoint/public -edc.transfer.proxy.token.signer.privatekey.alias=token-signer-private-key - -# Postgresql related configuration -edc.datasource.asset.name=asset -edc.datasource.asset.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_asset -edc.datasource.asset.user=user -edc.datasource.asset.password=pass -edc.datasource.contractdefinition.name=contractdefinition -edc.datasource.contractdefinition.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractdefinition -edc.datasource.contractdefinition.user=user -edc.datasource.contractdefinition.password=pass -edc.datasource.contractnegotiation.name=contractnegotiation -edc.datasource.contractnegotiation.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractnegotiation -edc.datasource.contractnegotiation.user=user -edc.datasource.contractnegotiation.password=pass -edc.datasource.policy.name=policy -edc.datasource.policy.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_policy -edc.datasource.policy.user=user -edc.datasource.policy.password=pass -edc.datasource.transferprocess.name=transferprocess -edc.datasource.transferprocess.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_transferprocess -edc.datasource.transferprocess.user=user -edc.datasource.transferprocess.password=pass -EOF -``` - -### Example logging.properties - -```shell -# Create logging.properties -export LOGGING_PROPERTIES_FILE=$(mktemp /tmp/logging.properties.XXXXXX) -cat << 'EOF' > ${LOGGING_PROPERTIES_FILE} -.level=INFO -org.eclipse.edc.level=ALL -handlers=java.util.logging.ConsoleHandler -java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter -java.util.logging.ConsoleHandler.level=ALL -java.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n -EOF -``` - -### Example opentelemetry.properties - -```shell -# Create opentelemetry.properties -export OPENTELEMETRY_PROPERTIES_FILE=$(mktemp /tmp/opentelemetry.properties.XXXXXX) -cat << 'EOF' > ${OPENTELEMETRY_PROPERTIES_FILE} -otel.javaagent.enabled=false -otel.javaagent.debug=false -EOF -``` - -## Running - -```shell -docker run \ - -p 8080:8080 -p 8181:8181 -p 8182:8182 -p 8282:8282 -p 9090:9090 -p 9999:9999 \ - -v ${CONFIGURATION_PROPERTIES_FILE:-/dev/null}:/app/configuration.properties \ - -v ${LOGGING_PROPERTIES_FILE:-/dev/null}:/app/logging.properties \ - -v ${OPENTELEMETRY_PROPERTIES_FILE:-/dev/null}:/app/opentelemetry.properties \ - -i edc-controlplane-postgresql-hashicorp-vault:latest -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault-legacy/notice.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault-legacy/notice.md deleted file mode 100644 index f8b66e8c2cc..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault-legacy/notice.md +++ /dev/null @@ -1,28 +0,0 @@ -# Notice for Docker image - -An EDC Control Plane using PostgreSQL as persistence backend, and HashiCorp Vault as secret store. - -DockerHub: - -Eclipse Tractus-X product(s) installed within the image: - -## Tractus-X EDC Control Plane - -- GitHub: -- Project home: -- Dockerfile: -- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE) - -## Used base image - -- [eclipse-temurin:17.0.6_10-jre-alpine](https://github.com/adoptium/containers) -- Official Eclipse Temurin DockerHub page: -- Eclipse Temurin Project: -- Additional information about the Eclipse Temurin - images: - -As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc -from the base distribution, along with any direct or indirect dependencies of the primary software being contained). - -As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies -with any relevant licenses for all software contained within. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/README.md deleted file mode 100644 index 1617b9ba862..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/README.md +++ /dev/null @@ -1,178 +0,0 @@ -# EDC Control-Plane backed by Postgresql and HashiCorp vault - -## Building - -```shell -./gardlew :edc-controlplane:edc-controlplane-postgresql-hashicorp-vault:dockerize -``` - -## Configuration - -Listed below are configuration keys needed to get the `edc-controlplane-postgresql-hashicorp-vault` up and running. -Details regarding each configuration property can be found at the [documentary section of the EDC](https://github.com/eclipse-edc/Connector/tree/main/docs). - -| Key | Required | Example | Description | -|--------------------------------------------------|----------|------------------------------------------------------------------------------|----------------------------| -| edc.api.auth.key | | password | default value: random UUID | -| web.http.default.port | X | 8080 | | -| web.http.default.path | X | /api | | -| web.http.data.port | X | 8181 | | -| web.http.data.path | X | /data | | -| web.http.validation.port | X | 8182 | | -| web.http.validation.path | X | /validation | | -| web.http.control.port | X | 9999 | | -| web.http.control.path | X | /api/controlplane/control | | -| web.http.ids.port | X | 8282 | | -| web.http.ids.path | X | /api/v1/ids | | -| edc.receiver.http.endpoint | X | | | -| edc.ids.title | | Eclipse Dataspace Connector | | -| edc.ids.description | | Eclipse Dataspace Connector | | -| edc.ids.id | | urn:connector:edc | | -| edc.ids.security.profile | | base | | -| edc.ids.endpoint | | | | -| edc.ids.maintainer | | | | -| edc.ids.curator | | | | -| edc.ids.catalog.id | | urn:catalog:default | | -| ids.webhook.address | | | | -| edc.hostname | | localhost | | -| edc.oauth.token.url | X | | | -| edc.oauth.public.key.alias | X | key-to-daps-certificate-in-keyvault | | -| edc.oauth.private.key.alias | X | key-to-private-key-in-keyvault | | -| edc.oauth.client.id | X | daps-oauth-client-id | | -| edc.vault.hashicorp.url | X | | | -| edc.vault.hashicorp.token | X | 55555555-6666-7777-8888-999999999999 | | -| edc.vault.hashicorp.timeout.seconds | | 30 | | -| edc.datasource.asset.name | X | asset | | -| edc.datasource.asset.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_asset_db | | -| edc.datasource.asset.user | X | username | | -| edc.datasource.asset.password | X | password | | -| edc.datasource.contractdefinition.name | X | contractdefinition | | -| edc.datasource.contractdefinition.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractdefinition_db | | -| edc.datasource.contractdefinition.user | X | username | | -| edc.datasource.contractdefinition.password | X | password | | -| edc.datasource.contractnegotiation.name | X | contractnegotiation | | -| edc.datasource.contractnegotiation.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractnegotiation_db | | -| edc.datasource.contractnegotiation.user | X | username | | -| edc.datasource.contractnegotiation.password | X | password | | -| edc.datasource.policy.name | X | policy | | -| edc.datasource.policy.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_policy_db | | -| edc.datasource.policy.user | X | username | | -| edc.datasource.policy.password | X | password | | -| edc.datasource.transferprocess.name | X | transferprocess | | -| edc.datasource.transferprocess.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_transferprocess_db | | -| edc.datasource.transferprocess.user | X | username | | -| edc.datasource.transferprocess.password | X | password | | -| edc.transfer.proxy.endpoint | X | | | -| edc.transfer.proxy.token.signer.privatekey.alias | X | | | - -### Example configuration.properties - -JDK properties-style configuration of the EDC Control-Plane is expected to be mounted to `/app/configuration.properties` within the container. - -```shell -# Create configuration.properties -export CONFIGURATION_PROPERTIES_FILE=$(mktemp /tmp/configuration.properties.XXXXXX) -cat << 'EOF' > ${CONFIGURATION_PROPERTIES_FILE} - -web.http.default.port=8080 -web.http.default.path=/api -web.http.data.port=8181 -web.http.data.path=/data -web.http.validation.port=8182 -web.http.validation.path=/validation -web.http.control.port=9999 -web.http.control.path=/api/controlplane/control -web.http.ids.port=8282 -web.http.ids.path=/api/v1/ids - -edc.receiver.http.endpoint=http://backend-service - -edc.ids.title=Eclipse Dataspace Connector -edc.ids.description=Eclipse Dataspace Connector -edc.ids.id=urn:connector:edc -edc.ids.security.profile=base -edc.ids.endpoint=http://localhost:8282/api/v1/ids -edc.ids.maintainer=http://localhost -edc.ids.curator=http://localhost -edc.ids.catalog.id=urn:catalog:default -ids.webhook.address=http://localhost:8282/api/v1/ids - -edc.hostname=localhost - -edc.api.auth.key=password - -# OAuth / DAPS related configuration -edc.oauth.token.url=https://daps.example.net -edc.oauth.public.key.alias=key-to-daps-certificate-in-keyvault -edc.oauth.private.key.alias=key-to-private-key-in-keyvault -edc.oauth.client.id=daps-oauth-client-id - -# HashiCorp vault related configuration -edc.vault.hashicorp.url=http://vault -edc.vault.hashicorp.token=55555555-6666-7777-8888-999999999999 -edc.vault.hashicorp.timeout.seconds=30 - -# Control- / Data- Plane configuration -edc.transfer.proxy.endpoint=http://dataplane-public-endpoint/public -edc.transfer.proxy.token.signer.privatekey.alias=token-signer-private-key - -# Postgresql related configuration -edc.datasource.asset.name=asset -edc.datasource.asset.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_asset -edc.datasource.asset.user=user -edc.datasource.asset.password=pass -edc.datasource.contractdefinition.name=contractdefinition -edc.datasource.contractdefinition.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractdefinition -edc.datasource.contractdefinition.user=user -edc.datasource.contractdefinition.password=pass -edc.datasource.contractnegotiation.name=contractnegotiation -edc.datasource.contractnegotiation.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractnegotiation -edc.datasource.contractnegotiation.user=user -edc.datasource.contractnegotiation.password=pass -edc.datasource.policy.name=policy -edc.datasource.policy.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_policy -edc.datasource.policy.user=user -edc.datasource.policy.password=pass -edc.datasource.transferprocess.name=transferprocess -edc.datasource.transferprocess.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_transferprocess -edc.datasource.transferprocess.user=user -edc.datasource.transferprocess.password=pass -EOF -``` - -### Example logging.properties - -```shell -# Create logging.properties -export LOGGING_PROPERTIES_FILE=$(mktemp /tmp/logging.properties.XXXXXX) -cat << 'EOF' > ${LOGGING_PROPERTIES_FILE} -.level=INFO -org.eclipse.edc.level=ALL -handlers=java.util.logging.ConsoleHandler -java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter -java.util.logging.ConsoleHandler.level=ALL -java.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n -EOF -``` - -### Example opentelemetry.properties - -```shell -# Create opentelemetry.properties -export OPENTELEMETRY_PROPERTIES_FILE=$(mktemp /tmp/opentelemetry.properties.XXXXXX) -cat << 'EOF' > ${OPENTELEMETRY_PROPERTIES_FILE} -otel.javaagent.enabled=false -otel.javaagent.debug=false -EOF -``` - -## Running - -```shell -docker run \ - -p 8080:8080 -p 8181:8181 -p 8182:8182 -p 8282:8282 -p 9090:9090 -p 9999:9999 \ - -v ${CONFIGURATION_PROPERTIES_FILE:-/dev/null}:/app/configuration.properties \ - -v ${LOGGING_PROPERTIES_FILE:-/dev/null}:/app/logging.properties \ - -v ${OPENTELEMETRY_PROPERTIES_FILE:-/dev/null}:/app/opentelemetry.properties \ - -i edc-controlplane-postgresql-hashicorp-vault:latest -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/notice.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/notice.md deleted file mode 100644 index f8b66e8c2cc..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/notice.md +++ /dev/null @@ -1,28 +0,0 @@ -# Notice for Docker image - -An EDC Control Plane using PostgreSQL as persistence backend, and HashiCorp Vault as secret store. - -DockerHub: - -Eclipse Tractus-X product(s) installed within the image: - -## Tractus-X EDC Control Plane - -- GitHub: -- Project home: -- Dockerfile: -- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE) - -## Used base image - -- [eclipse-temurin:17.0.6_10-jre-alpine](https://github.com/adoptium/containers) -- Official Eclipse Temurin DockerHub page: -- Eclipse Temurin Project: -- Additional information about the Eclipse Temurin - images: - -As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc -from the base distribution, along with any direct or indirect dependencies of the primary software being contained). - -As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies -with any relevant licenses for all software contained within. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-runtime-memory/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-runtime-memory/README.md deleted file mode 100644 index 150a8f680e0..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-runtime-memory/README.md +++ /dev/null @@ -1,131 +0,0 @@ -# EDC Control-Plane backed by In-Memory Stores - -## Security - -### In-memory Vault implementation - -The goal of this extension is to provide an ephemeral, memory-based vault implementation that can be used in testing or -demo scenarios. - -Please not that this vault does not encrypt the secrets, they are held in memory in plain text at runtime! In addition, -its ephemeral nature makes it unsuitable for replicated/multi-instance scenarios, i.e. Kubernetes. - -> It is not a secure secret store, please do NOT use it in production workloads! - -## Building - -```shell -./gradlew :edc-controlplane:edc-runtime-memory:dockerize -``` - -## Configuration (configuration.properties) - -Listed below are configuration keys needed to get the `edc-runtime-memory` up and running. -Details regarding each configuration property can be found at -the [documentary section of the EDC](https://github.com/eclipse-edc/Connector/tree/main/docs). - -| Key | Required | Example | Description | -|--------------------------------------------------|----------|-------------------------------------|----------------------------| -| edc.api.auth.key | | password | default value: random UUID | -| web.http.default.port | X | 8080 | | -| web.http.default.path | X | /api | | -| web.http.data.port | X | 8181 | | -| web.http.data.path | X | /data | | -| web.http.validation.port | X | 8182 | | -| web.http.validation.path | X | /validation | | -| web.http.control.port | X | 9999 | | -| web.http.control.path | X | /api/controlplane/control | | -| web.http.ids.port | X | 8282 | | -| web.http.ids.path | X | /api/v1/ids | | -| edc.receiver.http.endpoint | X | | | -| edc.ids.title | | Eclipse Dataspace Connector | | -| edc.ids.description | | Eclipse Dataspace Connector | | -| edc.ids.id | | urn:connector:edc | | -| edc.ids.security.profile | | base | | -| edc.ids.endpoint | | | | -| edc.ids.maintainer | | | | -| edc.ids.curator | | | | -| edc.ids.catalog.id | | urn:catalog:default | | -| ids.webhook.address | | | | -| edc.hostname | | localhost | | -| edc.oauth.token.url | X | | | -| edc.oauth.public.key.alias | X | key-to-daps-certificate-in-keyvault | | -| edc.oauth.private.key.alias | X | key-to-private-key-in-keyvault | | -| edc.oauth.client.id | X | daps-oauth-client-id | | -| edc.transfer.proxy.endpoint | X | | | -| edc.transfer.proxy.token.signer.privatekey.alias | X | | | - -### Example configuration.properties - -JDK properties-style configuration of the EDC Control-Plane is expected to be mounted to `/app/configuration.properties` -within the container. - -```shell -# Create configuration.properties -export CONFIGURATION_PROPERTIES_FILE=$(mktemp /tmp/configuration.properties.XXXXXX) -cat << 'EOF' > ${CONFIGURATION_PROPERTIES_FILE} - -web.http.default.port=8080 -web.http.default.path=/api -web.http.data.port=8181 -web.http.data.path=/data -web.http.validation.port=8182 -web.http.validation.path=/validation -web.http.control.port=9999 -web.http.control.path=/api/controlplane/control -web.http.ids.port=8282 -web.http.ids.path=/api/v1/ids - -edc.receiver.http.endpoint=http://backend-service - -edc.ids.title=Eclipse Dataspace Connector -edc.ids.description=Eclipse Dataspace Connector -edc.ids.id=urn:connector:edc -edc.ids.security.profile=base -edc.ids.endpoint=http://localhost:8282/api/v1/ids -edc.ids.maintainer=http://localhost -edc.ids.curator=http://localhost -edc.ids.catalog.id=urn:catalog:default -ids.webhook.address=http://localhost:8282/api/v1/ids - -edc.hostname=localhost - -edc.api.auth.key=password - -# OAuth / DAPS related configuration -edc.oauth.token.url=https://daps.example.net -edc.oauth.public.key.alias=key-to-daps-certificate-in-keyvault -edc.oauth.private.key.alias=key-to-private-key-in-keyvault -edc.oauth.client.id=daps-oauth-client-id - -# Control- / Data- Plane configuration -edc.transfer.proxy.endpoint=http://dataplane-public-endpoint/public -edc.transfer.proxy.token.signer.privatekey.alias=azure-vault-token-signer-private-key -EOF -``` - -### Example logging.properties - -```shell -# Create logging.properties -export LOGGING_PROPERTIES_FILE=$(mktemp /tmp/logging.properties.XXXXXX) -cat << 'EOF' > ${LOGGING_PROPERTIES_FILE} -.level=INFO -org.eclipse.edc.level=ALL -handlers=java.util.logging.ConsoleHandler -java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter -java.util.logging.ConsoleHandler.level=ALL -java.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n -EOF -``` - -## Running - -```shell -docker run \ - -e SECRETS="key1:secret1,key2:secret2" \ - -p 8080:8080 -p 8181:8181 -p 8182:8182 -p 8282:8282 -p 9090:9090 -p 9999:9999 \ - -v ${CONFIGURATION_PROPERTIES_FILE:-/dev/null}:/app/configuration.properties \ - -v ${LOGGING_PROPERTIES_FILE:-/dev/null}:/app/logging.properties \ - -i edc-runtime-memory:latest -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-runtime-memory/notice.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-runtime-memory/notice.md deleted file mode 100644 index fbe4a0acd75..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-controlplane/edc-runtime-memory/notice.md +++ /dev/null @@ -1,28 +0,0 @@ -# Notice for Docker image - -An EDC Control Plane using memory-based storage, and Azure KeyVault as secret store. - -DockerHub: - -Eclipse Tractus-X product(s) installed within the image: - -## Tractus-X EDC Control Plane - -- GitHub: -- Project home: -- Dockerfile: -- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE) - -## Used base image - -- [eclipse-temurin:17.0.6_10-jre-alpine](https://github.com/adoptium/containers) -- Official Eclipse Temurin DockerHub page: -- Eclipse Temurin Project: -- Additional information about the Eclipse Temurin - images: - -As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc -from the base distribution, along with any direct or indirect dependencies of the primary software being contained). - -As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies -with any relevant licenses for all software contained within. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/README.md deleted file mode 100644 index 9ca28b38d8f..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/README.md +++ /dev/null @@ -1,16 +0,0 @@ -# Data Plane - -The Eclipse Dataspace Connector consists of a **Control Plan** and a **Data Plane** Application. -While the **Control Plane** managing several data transfers, the **Data Plane** is responsible for doing the actual transfer. Like this data is never routed through the control plane itself und must always pass the data plane. - -## Security - -### Confidential Settings - -Please be aware that there are several confidential settings, that should not be part of the actual EDC configuration file (e.g. the Vault credentials). - -As it is possible to configure EDC settings via environment variables, one way to do it would be via Kubernetes Secrets. For other deployment scenarios than Kubernetes equivalent measures should be taken. - -## Known Data Plane Issues - -Please have a look at the open issues in the open source repository: [EDC Github Repository](https://github.com/eclipse-edc/Connector/issues) diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/edc-dataplane-azure-vault/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/edc-dataplane-azure-vault/README.md deleted file mode 100644 index c493b9a5209..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/edc-dataplane-azure-vault/README.md +++ /dev/null @@ -1,96 +0,0 @@ -# EDC Data-Plane with Azure Key Vault - -## Building - -```shell -./gardlew :edc-dataplane:edc-dataplane-azure-vault:dockerize -``` - -## Configuration - -Listed below are configuration keys needed to get the `edc-dataplane-azure-vault` up and running. -Details regarding each configuration property can be found at the [documentary section of the EDC](https://github.com/eclipse-edc/Connector/tree/main/docs). - -| Key | Required | Example | Description | -|-----------------------------------------|----------|---------------------------------------------|-------------| -| web.http.default.port | X | 8080 | | -| web.http.default.path | X | /api | | -| web.http.public.port | X | 8181 | | -| web.http.public.path | X | | | -| web.http.control.port | X | 9999 | | -| web.http.control.path | X | /api/controlplane/control | | -| edc.receiver.http.endpoint | X | | | -| edc.hostname | | localhost | | -| edc.oauth.client.id | X | daps-oauth-client-id | | -| edc.vault.clientid | X | 00000000-1111-2222-3333-444444444444 | | -| edc.vault.tenantid | X | 55555555-6666-7777-8888-999999999999 | | -| edc.vault.name | X | my-vault-name | | -| edc.vault.clientsecret | X | 34-chars-secret | | -| edc.dataplane.token.validation.endpoint | X | | | - -### Example configuration.properties - -JDK properties-style configuration of the EDC Control-Plane is expected to be mounted to `/app/configuration.properties` within the container. - -```shell -# Create configuration.properties -export CONFIGURATION_PROPERTIES_FILE=$(mktemp /tmp/configuration.properties.XXXXXX) -cat << 'EOF' > ${CONFIGURATION_PROPERTIES_FILE} - -web.http.default.port=8080 -web.http.default.path=/api -web.http.public.port=8185 -web.http.public.path=/public -web.http.control.port=9999 -web.http.control.path=/api/dataplane/control - -# Validation endpoint of controlplane -edc.dataplane.token.validation.endpoint=http://controlplane:8182/validation/token - -# EDC hostname -edc.hostname=localhost - -# Azure vault related configuration -edc.vault.clientid=00000000-1111-2222-3333-444444444444 -edc.vault.tenantid=55555555-6666-7777-8888-999999999999 -edc.vault.name=my-vault-name -edc.vault.clientsecret=34-chars-secret -EOF -``` - -### Example logging.properties - -```shell -# Create logging.properties -export LOGGING_PROPERTIES_FILE=$(mktemp /tmp/logging.properties.XXXXXX) -cat << 'EOF' > ${LOGGING_PROPERTIES_FILE} -.level=INFO -org.eclipse.edc.level=ALL -handlers=java.util.logging.ConsoleHandler -java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter -java.util.logging.ConsoleHandler.level=ALL -java.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n -EOF -``` - -### Example opentelemetry.properties - -```shell -# Create opentelemetry.properties -export OPENTELEMETRY_PROPERTIES_FILE=$(mktemp /tmp/opentelemetry.properties.XXXXXX) -cat << 'EOF' > ${OPENTELEMETRY_PROPERTIES_FILE} -otel.javaagent.enabled=true -otel.javaagent.debug=false -EOF -``` - -## Running - -```shell -docker run \ - -p 8080:8080 -p 8185:8185 -p 9999:9999 -p 9090:9090 \ - -v ${CONFIGURATION_PROPERTIES_FILE:-/dev/null}:/app/configuration.properties \ - -v ${LOGGING_PROPERTIES_FILE:-/dev/null}:/app/logging.properties \ - -v ${OPENTELEMETRY_PROPERTIES_FILE:-/dev/null}:/app/opentelemetry.properties \ - -i edc-dataplane-azure-vault:latest -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/edc-dataplane-azure-vault/notice.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/edc-dataplane-azure-vault/notice.md deleted file mode 100644 index b318440295b..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/edc-dataplane-azure-vault/notice.md +++ /dev/null @@ -1,28 +0,0 @@ -# Notice for Docker image - -An EDC Data Plane using the Azure KeyVault. - -DockerHub: - -Eclipse Tractus-X product(s) installed within the image: - -## Tractus-X EDC Data Plane - -- GitHub: -- Project home: -- Dockerfile: -- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE) - -## Used base image - -- [eclipse-temurin:17.0.6_10-jre-alpine](https://github.com/adoptium/containers) -- Official Eclipse Temurin DockerHub page: -- Eclipse Temurin Project: -- Additional information about the Eclipse Temurin - images: - -As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc -from the base distribution, along with any direct or indirect dependencies of the primary software being contained). - -As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies -with any relevant licenses for all software contained within. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/edc-dataplane-base/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/edc-dataplane-base/README.md deleted file mode 100644 index 89ec915067b..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/edc-dataplane-base/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# EDC Data-Plane Base Module - -## Building - -```shell -./gardlew :edc-dataplane:edc-dataplane-base:build -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/edc-dataplane-hashicorp-vault/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/edc-dataplane-hashicorp-vault/README.md deleted file mode 100644 index aeac639468e..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/edc-dataplane-hashicorp-vault/README.md +++ /dev/null @@ -1,94 +0,0 @@ -# EDC Data-Plane Hashicorp Vault - -## Building - -```shell -./gardlew :edc-dataplane:edc-dataplane-hashicorp-vault:dockerize -``` - -## Configuration - -Listed below are configuration keys needed to get the `edc-dataplane-hashicorp-vault` up and running. -Details regarding each configuration property can be found at the [documentary section of the EDC](https://github.com/eclipse-edc/Connector/tree/main/docs). - -| Key | Required | Example | Description | -|-----------------------------------------|----------|---------------------------------------------|-------------| -| web.http.default.port | X | 8080 | | -| web.http.default.path | X | /api | | -| web.http.public.port | X | 8181 | | -| web.http.public.path | X | | | -| web.http.control.port | X | 9999 | | -| web.http.control.path | X | /api/controlplane/control | | -| edc.receiver.http.endpoint | X | | | -| edc.hostname | | localhost | | -| edc.oauth.client.id | X | daps-oauth-client-id | | -| edc.vault.hashicorp.url | X | | | -| edc.vault.hashicorp.token | X | 55555555-6666-7777-8888-999999999999 | | -| edc.vault.hashicorp.timeout.seconds | | 30 | | -| edc.dataplane.token.validation.endpoint | X | | | - -### Example configuration.properties - -JDK properties-style configuration of the EDC Control-Plane is expected to be mounted to `/app/configuration.properties` within the container. - -```shell -# Create configuration.properties -export CONFIGURATION_PROPERTIES_FILE=$(mktemp /tmp/configuration.properties.XXXXXX) -cat << 'EOF' > ${CONFIGURATION_PROPERTIES_FILE} - -web.http.default.port=8080 -web.http.default.path=/api -web.http.public.port=8185 -web.http.public.path=/public -web.http.control.port=9999 -web.http.control.path=/api/dataplane/control - -# Validation endpoint of controlplane -edc.dataplane.token.validation.endpoint=http://controlplane:8182/validation/token - -# EDC hostname -edc.hostname=localhost - -# HashiCorp vault related configuration -edc.vault.hashicorp.url=http://vault -edc.vault.hashicorp.token=55555555-6666-7777-8888-999999999999 -edc.vault.hashicorp.timeout.seconds=30 -EOF -``` - -### Example logging.properties - -```shell -# Create logging.properties -export LOGGING_PROPERTIES_FILE=$(mktemp /tmp/logging.properties.XXXXXX) -cat << 'EOF' > ${LOGGING_PROPERTIES_FILE} -.level=INFO -org.eclipse.edc.level=ALL -handlers=java.util.logging.ConsoleHandler -java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter -java.util.logging.ConsoleHandler.level=ALL -java.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n -EOF -``` - -### Example opentelemetry.properties - -```shell -# Create opentelemetry.properties -export OPENTELEMETRY_PROPERTIES_FILE=$(mktemp /tmp/opentelemetry.properties.XXXXXX) -cat << 'EOF' > ${OPENTELEMETRY_PROPERTIES_FILE} -otel.javaagent.enabled=true -otel.javaagent.debug=false -EOF -``` - -## Running - -```shell -docker run \ - -p 8080:8080 -p 8185:8185 -p 9999:9999 -p 9090:9090 \ - -v ${CONFIGURATION_PROPERTIES_FILE:-/dev/null}:/app/configuration.properties \ - -v ${LOGGING_PROPERTIES_FILE:-/dev/null}:/app/logging.properties \ - -v ${OPENTELEMETRY_PROPERTIES_FILE:-/dev/null}:/app/opentelemetry.properties \ - -i edc-dataplane-hashicorp-vault:latest -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/edc-dataplane-hashicorp-vault/notice.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/edc-dataplane-hashicorp-vault/notice.md deleted file mode 100644 index 667042ed4b3..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-dataplane/edc-dataplane-hashicorp-vault/notice.md +++ /dev/null @@ -1,28 +0,0 @@ -# Notice for Docker image - -An EDC Data Plane using the HashiCorp Vault - -DockerHub: - -Eclipse Tractus-X product(s) installed within the image: - -## Tractus-X-EDC Data Plane - -- GitHub: -- Project home: -- Dockerfile: -- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE) - -## Used base image - -- [eclipse-temurin:17.0.6_10-jre-alpine](https://github.com/adoptium/containers) -- Official Eclipse Temurin DockerHub page: -- Eclipse Temurin Project: -- Additional information about the Eclipse Temurin - images: - -As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc -from the base distribution, along with any direct or indirect dependencies of the primary software being contained). - -As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies -with any relevant licenses for all software contained within. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/business-partner-validation/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/business-partner-validation/README.md deleted file mode 100644 index 339417771c2..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/business-partner-validation/README.md +++ /dev/null @@ -1,189 +0,0 @@ -# Business Partner Validation Extension - -Using the Business Partner Validation Extension it's possible to add configurable validation against -BPNs in the `ContractDefinition.AccessPolicy`. Using a BPN in `ContractDefinition.ContractPolicy` is possible, too, but once the contract is complete there is no policy enforcement in place from the EDC. - -It is recommended to have a basic understanding of the EDC contract/policy domain before using this extension. The -corresponding documentation can be found in the [EDC GitHub Repository](https://github.com/eclipse-edc/Connector). - -The business partner number of another connector is part of its DAPS token. Once a BPN constraint is used in an access -policy the connector checks the token before sending out contract offers. - -Example of business partner constraint: - -```json -{ - "leftExpression": { - "value": "BusinessPartner" - }, - "rightExpression": { - "value": "BPNLCDQ90000X42KU" - }, - "operator": "EQ" -} -``` - -The `leftExpression` must always contain 'BusinessPartner', so that the policy functions of this extension are invoked. -Additionally, the only `operator` that is supported by these policy functions is 'EQ'. Finally, the `rightExpression` -must contain the Business Partner Number. - -## Single BusinessPartnerNumber example - -The most simple BPN policy would allow the usage of certain data to a single Business Partner. An example `Policy` is -shown below. In this example the `edctype` properties are added, so that this policy may even be sent to the Management API. - -```json -{ - "uid": "", - "prohibitions": [], - "obligations": [], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "USE" - }, - "constraints": [ - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BusinessPartnerNumber" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "" - }, - "operator": "EQ" - } - ] - } - ] -} -``` - -## Multiple BusinessPartnerNumber example - -To define multiple BPN and allow multiple participants to use the data the `orconstraint` should be used. -It will permit the constraints contained to be evaluated using the `OR` operator. - -```json -{ - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "USE" - }, - "constraints": [ - { - "edctype": "dataspaceconnector:orconstraint", - "constraints": [ - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BusinessPartnerNumber" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "" - }, - "operator": "EQ" - }, - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BusinessPartnerNumber" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "" - }, - "operator": "EQ" - }, - - ... - - // other constraints can be added - ] - } - ], - "duties": [] - } - ] -} -``` - -## Important: EDC Policies are input sensitive - -Please be aware that the EDC ignores all Rules and Constraint it does not understand. This could cause your constrained policies to be public. - -### Example 1 for accidentially public - -```json -{ - "uid": "1", - "prohibitions": [], - "obligations": [], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "MY-USE" - }, - "constraints": [ - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BusinessPartnerNumber" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BPNLCDQ90000X42KU" - }, - "operator": "EQ" - } - ] - } - ] -} -``` - -This policy is public available, even though the constraint is described correct. The reason is, that this extension only registeres the Policy.Action `USE` within the EDC. Any other Action Type will have the EDC ignore the corresponding permission, hence interpret the polics as public policy. - -### Example 2 for accidentially public - -```json -{ - "uid": "1", - "prohibitions": [], - "obligations": [], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "USE" - }, - "constraints": [ - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BusinesPartnerNumber" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BPNLCDQ90000X42KU" - }, - "operator": "EQ" - } - ] - } - ] -} -``` - -This policy is public available, too. The cause is a typo in the left-expression of the constraint. This extension only registers the `Constraint.LeftExpression` `BusinessPartnerNumber` within the EDC. Any other term will have the EDC ignore the corresponding constraint, hence interpret the policies as public policy. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/cx-oauth2/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/cx-oauth2/README.md deleted file mode 100644 index c796ac24561..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/cx-oauth2/README.md +++ /dev/null @@ -1,47 +0,0 @@ -# Tractus-X OAuth2 Extension - -## Why Tractus-X needs this extension - -In IDS the DAPS token audience is always `idsc:IDS_CONNECTORS_ALL`. At first glance this makes it possible for other connectors to steal and reuse an received token. To mitigate this security risk IDS introduces something called `transportCertsSha256`, which couples the connector audience with its corresponding TLS/SSL certificate. - -From [GitHub IDS-G](https://github.com/International-Data-Spaces-Association/IDS-G/tree/main/Components/IdentityProvider/DAPS) - -> - **transportCertsSha256** Contains the public keys of the used transport certificates, hashed using SHA256. The identifying X509 certificate should not be used for the communication encryption. Therefore, the receiving party needs to connect the identity of a connector by relating its hostname (from the communication encryption layer) and the used private/public key pair, with its IDS identity claim of the DAT. The public transportation key must be one of the `transportCertsSha256` values. Otherwise, the receiving connector must expect that the requesting connector is using a false identity claim. In general, this claim holds an Array of Strings, but it may optionally hold a single String instead if the Array would have exactly one element. - -The reason IDS did this is to prevent the IDS DAPS to know, which connectors talk to each other. But this solution introduces a new level of complexity for different deployment scenarios. The OAuth2 Extension introduces the classic audience validation again, so that users do not have to deal with these things for now. - -## Configuration - -| Key | Description | Mandatory | Default | -|:--------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|------------| -| edc.oauth.token.url | Token URL of the DAPS | X | | -| edc.oauth.public.key.alias | Vault alias of the public key | X | | -| edc.oauth.client.id | DAPS client id of the connector | X | | -| edc.oauth.private.key.alias | Vault lias of the private key | X | | -| edc.oauth.token.expiration.seconds | | | 5 minutes | -| edc.oauth.validation.nbf.leeway | DAPS token request leeway | | 10 seconds | -| edc.oauth.provider.jwks.refresh | Time between refresh of the DAPS json web key set | | 5 minutes | -| edc.ids.endpoint.audience | The audience the connector requests from the DAPS. Should be the IDS URL of the connector, e.g. `http://plato-edc-controlplane:8282/api/v1/ids/data` | X | | -| edc.ids.validation.referringconnector | Adds checks to the DAPS token. Validation that the `referringConnector` equals the `issuerConnector` and the `securityProfile` of the token is equal to the profile of the IDS message | | false | - -## Audience Validation - -Instead of the `idsc:IDS_CONNECTORS_ALL` the connector requests a specific audience from the DAPS. This audience will be the IDS URL, the connector intends to call. - -When a connector receives a message, it will checks the token audience is equal to the configured value in `edc.ids.endpoint.audience`. - -![sequence diagram](./diagrams/sequence.png) - -## Participant Extension - -Starting from `0.0.1-milestone-9` EDC requires a mandatory setting `edc.participant.id`, which in this case should be the BPN number which is transmitted over the wire to identifying the participants IDs. -To verify that in the DAPS token an extension has been created, that extract from the `ClaimToken` the BPN number and then EDC compare that identity with the one provided over the wire, for security reason. - -By default, the extension parse the `referringConnector` url and extract the BPN number as the last parameter in the URL eg (). - -### Configuration - -| Key | Description | Mandatory | Default | -|:--------------------------------------|:----------------------------------------------------------|-----------|---------------| -| tx.participant.id.regex | Regex for extracting the BPN from the referringConnector | | [^/]+(?=/$|$) | -| tx.participant.id.regexGroup | Group number for the regex match | | 0 | diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/cx-oauth2/diagrams/sequence.png b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/cx-oauth2/diagrams/sequence.png deleted file mode 100644 index 784441b4e7d..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/cx-oauth2/diagrams/sequence.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/cx-oauth2/diagrams/sequence.puml b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/cx-oauth2/diagrams/sequence.puml deleted file mode 100644 index d2f20f27879..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/cx-oauth2/diagrams/sequence.puml +++ /dev/null @@ -1,24 +0,0 @@ -@startuml - -title CX-DAPS Audience Validation - -participant ConnectorA as "Connector A" -participant DAPS as "IDS DAPS" -participant ConnectorB as "Connector B" - -== Configuration == - -ConnectorB <-? : Configure //edc.ids.endpoint.audience//\nto ///api/v1/ids/data// - -== Request == - -?-> ConnectorA ++: Initiate Catalog Request\n/data/catalog?providerUrl=///api/v1/ids/data// - ConnectorA -> DAPS ++: Request Token for audience\n///api/v1/ids/data// - return DAPS Token - ConnectorA -> ConnectorB ++ : Send Request with Token - ConnectorB -> ConnectorB : Check Audience equals\n/api/v1/ids/data - ... continue request processing ... - return Catalog Response -return Catalog - -@enduml \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/data-encryption/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/data-encryption/README.md deleted file mode 100644 index 586dad775ba..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/data-encryption/README.md +++ /dev/null @@ -1,42 +0,0 @@ -# Data Encryption Extension - -The Eclipse Dataspace Connector encrypts sensitive information inside a token it sends to other applications (from possibly other companies). This extension implements the encryption of this data and should be used with secure keys and algorithms at all times. - -## Algorithm Configuration - -| Key | Description | Mandatory | Default | -|:--------------------------------------------|:-----------------------------------------------------------------------------------------------------------------|-----------|------------------| -| edc.data.encryption.algorithm | Algorithm for encryption and decryption. Must be ether 'AES' or 'NONE'. | | AES | - -## Strategies - -### 1. AES - -The Advanced Encryption Standard (AES) is the default encryption algorithm. For Authenticated Encryption with Associated Data (AEAD) it uses the Galois/Counter Mode or GCM. - -When using AES-GCM the key length must be ether 128-, 196- or 256bit. Keys must be stored stored Base64 encoded in the Vault, separated by a comma. - -It's possible to generate Keys using OpenSSL - -```bash -# 128 Bit -openssl rand -base64 16 - -# 196 Bit -openssl rand -base64 24 - -# 256 Bit -openssl rand -base64 32 -``` - -#### AES Configuration - -| Key | Description | Mandatory | Default | -|:------------------------------------|:----------------------------------------------------------------------------|-----------|---------| -| edc.data.encryption.keys.alias | Symmetric Keys stored in the Vault under the configured alias. | X | | -| edc.data.encryption.caching.enabled | Enable caching to request only keys from the vault after the cache expires. | | false | -| edc.data.encryption.caching.seconds | Duration in seconds until the cache expires. | | 3600 | - -### 2. NONE - -This strategy does apply no encryption at all and should only be used for debugging purposes. Using NONE encryption may leak sensitive data to other connectors! diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/dataplane-proxy/edc-dataplane-proxy-consumer-api/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/dataplane-proxy/edc-dataplane-proxy-consumer-api/README.md deleted file mode 100644 index ec590c1a2aa..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/dataplane-proxy/edc-dataplane-proxy-consumer-api/README.md +++ /dev/null @@ -1,46 +0,0 @@ -# DataPlane Proxy Consumer API - -This is an API extension that interacts with the EDR/cache for directly fetching the data -without knowing the EDR. - -It contains only one endpoint with `POST` for fetching data: - -The path is `/aas/request` and the body is something like this example: - -```json -{ - "assetId": "1", - "endpointUrl": "http://localhost:8181/api/gateway/aas/test" -} -``` - -The body should contain the `assetId` or the `transferProcessId` which identify the data that we want to fetch -and an `endpointUrl` which is the provider gateway on which the data is available. More info [here](../edc-dataplane-proxy-provider-api/README.md) on the gateway. - -Alternatively if the `endpointUrl` is not known or the gateway on the provider side is not configured, it can be omitted and the `Edr#endpointUrl` -will be used. In this scenario if needed users can provide additional properties to the request for composing the final -url: - -- `pathSegments` sub path to append to the base url -- `queryParams` query parameters to add to the url - -Example with base url `http://localhost:8080/test` - -```json -{ - "assetId": "1", - "pathSegments": "/sub", - "queryParams": "foo=bar" -} -``` - -The final url will look like `http://localhost:8080/test/sub?foo=bar` composed by the DataPlane manager with the Http request flow, - -> Note: the endpoint is not protected with configured `AuthenticationService`, which most likely will be the token based (auth key) one. - -## Configuration - -| Key | Required | Default | Description | -|---------------------------------|----------|--------------------------------------------| -| web.http.proxy.port | | 8186 | | -| web.http.proxy.path | | /proxy | | diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/dataplane-proxy/edc-dataplane-proxy-provider-api/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/dataplane-proxy/edc-dataplane-proxy-provider-api/README.md deleted file mode 100644 index 42daf4973c7..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/dataplane-proxy/edc-dataplane-proxy-provider-api/README.md +++ /dev/null @@ -1,23 +0,0 @@ -# DataPlane Proxy Provider API - -This extension provide additional dataplane extension for proxying requests to backends. -The configuration of the proxy can be found [here](../edc-dataplane-proxy-provider-core/README.md) - -The provider proxy is mounted into the EDC default context, and it's available in the path `/gateway` - -The proxy will look for subPath in the request and match the subpath with the configured ones and forward -the rest of the path and query parameters. - -For example: - -with this URL `http://localhost:8181/api/gateway/aas/test` it will look for the `aas` alias in the configuration, -and it will compose the final url to call based on that configuration appending to it the remaining part of the path and query -parameters. - -When the proxy receive a request, it must contain the EDR, which will be decoded with the `token` validation endpoint. - -## Configuration - -| Key | Required | Default | Description | -|---------------------------------|----------|----------------------------------------------------------------------------------------| -| tx.dpf.provider.proxy.thread.pool | | 10 | Thread pool size for the provider data plane proxy gateway | diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/dataplane-proxy/edc-dataplane-proxy-provider-core/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/dataplane-proxy/edc-dataplane-proxy-provider-core/README.md deleted file mode 100644 index 706a31e7816..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/dataplane-proxy/edc-dataplane-proxy-provider-core/README.md +++ /dev/null @@ -1,13 +0,0 @@ -# DataPlane Proxy Provider Core - -This extension provide the base service and configuration for the DataPlane Provider Proxy. - -## Configuration - -| Key | Required | Default | Description | -|----------------------------------------------------|----------------------------------------------------------------------------------| -| tx.dpf.proxy.gateway.alias.proxied.path |X | 10 | The backend URL to proxy | -| tx.dpf.proxy.gateway.alias.proxied.edr.forward | | false | If the original EDR must be forwarded to the backend | -| tx.dpf.proxy.gateway.alias.proxied.edr.headerKey | | Edc-Edr | The header name to use when forwarding the EDR | - -Where `alias` is the first part of the subpath after `gateway` mentioned [here](../edc-dataplane-proxy-provider-api/README.md) diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/dataplane-selector-configuration/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/dataplane-selector-configuration/README.md deleted file mode 100644 index 7ee61fac523..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/dataplane-selector-configuration/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# Data Plane Selector Configuration Extension - -This control-plane extension makes it possible configure one or more Data Plane Instances. During a transfer the control -plane will look for an instance with matching capabilities to transfer data. - -## Configuration - -Per data plane instance the following settings must be configured. As `` any unique string is valid. - -| Key | Description | Mandatory | Example | -|:------------------------------------------------------------|:--------------------------------------------------|-----------|------------------------------------------------------------------| -| edc.dataplane.selector.````.url | URL to connect to the Data Plane Instance. | X | | -| edc.dataplane.selector.````.sourcetypes | Source Types in a comma separated List. | X | HttpData | -| edc.dataplane.selector.````.destinationtypes | Destination Types in a comma separated List. | X | HttpProxy | -| edc.dataplane.selector.````.properties | Additional properties of the Data Plane Instance. | (X) | { "publicApiUrl": "" } | - -The property `publicApiUrl` is mandatory for Data Plane Instances with destination type `HttpProxy`. - -### Helm Example Configuration using environment variables - -```yaml -EDC_DATAPLANE_SELECTOR_PLATOPLANE_URL: http://plato-edc-dataplane:9999/api/dataplane/control -EDC_DATAPLANE_SELECTOR_PLATOPLANE_SOURCETYPES : HttpData -EDC_DATAPLANE_SELECTOR_PLATOPLANE_DESTINATIONTYPES: HttpProxy -EDC_DATAPLANE_SELECTOR_PLATOPLANE_PROPERTIES: >- - { - "publicApiUrl": "http://plato-edc-dataplane:8185/api/public" - } -``` diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/edr/edr-api/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/edr/edr-api/README.md deleted file mode 100644 index 084715dcc8e..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/edr/edr-api/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Control Plane EDR API - -This module provides extensions to the EDC management API for dealing with EDR tokens. - -The extensions are added to the same context as the management APIs, so no additional configuration is required. - -The base path of the API will be `/edrs` - -This module for now provides three APIs: - -- Initiating an EDR negotiation token -- Fetching the available EDRs -- Fetching the single EDR - -The initiate negotiation EDR leverage the callbacks mechanism introduced in the latest EDC, and it handles -the contract negotiation and the transfer request in one API call. Once the transfer has been completed -the provider will return the EDR that will be stored into the consumer EDR store/cache. Users can interact -with the EDR store/cache for fetching the EDR and then requesting the data, or can use the `proxy` API described [here](../../dataplane-proxy/edc-dataplane-proxy-consumer-api/README.md) - -An overview on how to use the EDR APIs is available [here](../../../docs/samples/edr-api-overview/edr-api-overview.md) diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/edr/edr-cache-sql/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/edr/edr-cache-sql/README.md deleted file mode 100644 index 270d1f2666e..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/edr/edr-cache-sql/README.md +++ /dev/null @@ -1,27 +0,0 @@ -# SQL-based `EndpointDataReferenceCache` extension - -This extension provide a persistent implementation of `EndpointDataReferenceCache`. - -It will store in the database this fields: - -- transferProcessId -- agreementId -- assetId -- edrId - -It represents a single EDR negotiation done with the new Control Plane EDR APIs. - -The EDR itself it is stored in the participant vault with a prefixed key `edr__`. - -**_Note that the SQL statements (DDL) are specific to and only tested with PostgreSQL. Using it with other RDBMS may -work but might have unexpected side effects!_** - -## 1. Table schema - -see [schema.sql](docs/schema.sql). - -## 2. Configuration - -| Key | Description | Mandatory | Default | -|:---------------------------------------|:----------------------------------|-----------|---------| -| edc.datasource.edr.name | Datasource used by this extension | | edr | diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/postgresql-migration/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/postgresql-migration/README.md deleted file mode 100644 index 7a8b848c6ee..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/postgresql-migration/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# Postgresql SQL Migration Extension - -This extension applies SQL migrations to - -* the asset-index -* the contract-definition store -* contract-negotiation store -* policy store -* transfer-process store - -## Configuration - -| Key | Description | Mandatory | Default | -|:--------------------------------------------------------------------------|:-------------------------------------------------|-----------|----------| -| org.eclipse.tractusx.edc.postgresql.migration.asset.enabled | Enable migration for asset tables | | true | -| org.eclipse.tractusx.edc.postgresql.migration.contractdefinition.enabled | Enable migration for contract definition tables | | true | -| org.eclipse.tractusx.edc.postgresql.migration.contractnegotiation.enabled | Enable migration for contract negotiation tables | | true | -| org.eclipse.tractusx.edc.postgresql.migration.edr.enabled | Enable migration for edr tables | | true | -| org.eclipse.tractusx.edc.postgresql.migration.policy.enabled | Enable migration for policy tables | | true | -| org.eclipse.tractusx.edc.postgresql.migration.transferprocess.enabled | Enable migration for transfer process tables | | true | -| org.eclipse.tractusx.edc.postgresql.migration.schema | The DB schema to be used during migration | | "public" | diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/provision-additional-headers/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/provision-additional-headers/README.md deleted file mode 100644 index 61fe14873e5..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/provision-additional-headers/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# Provision: additional headers - -The goal of this extension is to provide additional headers to the request to the backend service done by the provider -in order to retrieve the data that will be given to the consumer. - -This gives for example the provider backend service the possibility to audit the data requests. - -The following headers are added to the `HttpDataAddress`: - -- `Edc-Contract-Agreement-Id`: the id of the contract agreement -- `Edc-Bpn`: the BPN of the consumer diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/ssi/jws2020-crypto-suite/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/ssi/jws2020-crypto-suite/README.md deleted file mode 100644 index eb6a7761adc..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/ssi/jws2020-crypto-suite/README.md +++ /dev/null @@ -1,70 +0,0 @@ -# JsonWebSignature2020 - -This module extends the [iron-verifiable-credentials library](https://github.com/filip26/iron-verifiable-credentials), -which we use in conjunction with [titanium-ld](https://github.com/filip26/titanium-json-ld/) with an implementation for -the [JsonWebSignature2020](https://www.w3.org/community/reports/credentials/CG-FINAL-lds-jws2020-20220721) crypto suite. - -## Technical aspects - -This implementation is actually mostly glue code between the `iron-verifiable-credentials` lib and the -well-known [Nimbus JOSE lib](https://connect2id.com/products/nimbus-jose-jwt), as all cryptographic primitives are taken -from Nimbus. - -VerifiableCredentials and VerifiablePresentations are processed as JSON(-LD) objects, so some familiarity with JSON-LD -is required. -The entrypoint into the cryptographic suite is the `Vc` class, which allows signing/issuing and verifying JSON-LD -structures. The following samples use explicit types for clarity. These are just some illustrative examples, please -check the `IssuerTests` and the `VerifierTests` for more comprehensive explanations. - -### Sign a VC - -```java -JwsSignature2020Suite suite = new JwsSignature2020Suite(JacksonJsonLd.createObjectMapper()); -JsonObject vc = createVcAsJsonLd(); -JWK keyPair = createKeyPairAsJwk(); -JwkMethod signKeys = new JwkMethod(id,type,controller,keyPair); - -var options = suite.createOptions() - .created(Instant.now()) - .verificationMethod(signKeys) // embeds the proof - .purpose(URI.create("https://w3id.org/security#assertionMethod")); - -Issuer signedVc = Vc.sign(vc, signKeys, options); - -JsonObject compacted = IssuerCompat.compact(signedVc); -``` - -### Verify a VC - -```java -JwsSignature2020Suite suite = new JwsSignature2020Suite(JacksonJsonLd.createObjectMapper()); -JsonObject vc = readSignedVc(); -Verifier result = Vc.verify(vc, suite); - -try { - result.isValid(); -} catch(VerificationError error) { - //handle -} -``` - -## Limitations & Known Issues - -Java 17 [dropped support](https://connect2id.com/products/nimbus-jose-jwt/examples/jwt-with-es256k-signature) for -the `secp256k1` curve. Alternatively, the BouncyCastle JCA provider could be used. -For this implementation, we chose to forego this at the benefit of a smaller library footprint. There is plenty of other -curves to choose from. - -On a similar note, support for Octet Keypairs (`"OKP"`) has not yet been added to the standard Java JCA, thus an -additional dependency `tink` is needed, -check [here](https://connect2id.com/products/nimbus-jose-jwt/examples/jwk-generation#okp) for details. If that is not -acceptable to you, please add a dependency exclusion to your build script. - -`iron-verifiable-credentials` is not 100% agnostic toward its crypto suites, for example there is -a [hard-coded context](https://github.com/filip26/iron-verifiable-credentials/blob/82d13326c5f64a0f38c75d417ffc263febfd970d/src/main/java/com/apicatalog/vc/processor/Issuer.java#L122) -added to the compacted JSON-LD, which is incorrect. It doesn't negatively impact the resulting JSON-LD, other than -possibly affecting processing times, but unfortunately it also makes it impossible to add more contexts, such -as . We mitigated this with -the [`IssuerCompat.java`](./src/main/java/org/eclipse/edc/security/signature/jws2020/IssuerCompat.java), which should be -used -for compaction. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/ssi/ssi-identity-core/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/ssi/ssi-identity-core/README.md deleted file mode 100644 index 59cc63bfe31..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/ssi/ssi-identity-core/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# SSI Core Identity Service Module - -This module contains an implementation of the EDC identity service for SSI. -The SsiIdentityService contains a `SsiTokenValidationService` for validating the `JWT` token, -that uses an implementation of `SsiCredentialClient` for validating the JWT token and then check custom rules registered in the `SsiValidationRuleRegistry` - -For obtaining the `JWT` token, the identity service also delegate to the `SsiCredentialClient` . - -The default implementation according to the first milestone [here](https://github.com/eclipse-tractusx/ssi-docu/tree/main/docs/architecture/cx-3-2) -will rely on an MIW and the implementations in available in the module `:edc-extensions:ssi:ssi-miw-credential-client`. - -The implementation also provide a rule registry `SsiValidationRuleRegistry` where custom rule can be registered for validating the `ClaimToken` extracted from the `JWT` token. - -Custom rule could be like: - -- Audience validation -- VP/VC validation -- Expiration -- ..etc - -## Configuration - -| Key | Required | Example | Description | -|-----------------------------------------|----------|----------------|---------------------------------------| -| tx.ssi.endpoint.audience | X | | Endpoint URL for audience check (DSP) | diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/ssi/ssi-miw-credential-client/README.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/ssi/ssi-miw-credential-client/README.md deleted file mode 100644 index 88316514786..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/edc-extensions/ssi/ssi-miw-credential-client/README.md +++ /dev/null @@ -1,34 +0,0 @@ -# MIW Client Credential Module - -This module contains an implementation of the `SsiCredentialClient` interface for SSI. -It basically narrows down to two operations: - -- obtaining a token for protocol communication -- validating the token - -For validating the token accordingly to the first milestone [here](https://github.com/eclipse-tractusx/ssi-docu/tree/main/docs/architecture/cx-3-2), the implemetation -just call the MIW for checking that the token and the VP claim inside are correct. Then extract the `JWT` claims into the `ClaimToken` for further checks. - -For obtaining a `JWT` token also it reaches the MIW, that will create a token with the `VP` claim inside. - -This module also contains two additional validation rules of VP/VC on the provider side. - -- `SsiCredentialIssuerValidationRule` checks if the issuer of the Verifiable Credential matches `tx.ssi.miw.authority.issuer` -- `SsiCredentialSubjectIdValidationRule` checks if the issuer of the JWT/VP matches the credential subject id in the Verifiable Credential - -## Configuration - -| Key | Required | Example | Description | -|----------------------------------|----------|----------------|-----------------------------------| -| tx.ssi.miw.url | X | | MIW URL | -| tx.ssi.miw.authority.id | X | | BPN number of the authority | -| tx.ssi.miw.authority.issuer | | | The id of the issuer (DID) | -| tx.ssi.oauth.token.url | X | | Token URL (Keycloak) | -| tx.ssi.oauth.client.id | X | | Client id | -| tx.ssi.oauth.client.secret.alias | X | | Vault alias for the client secret | - -By default, the `tx.ssi.miw.authority.issuer` is composed with `did:web::` - -Another mandatory settings is `tx.ssi.endpoint.audience` which is described [here](../ssi-identity-core/README.md) - -> Note: the `edc.participant.id` should match the BPN number contained in the OAuth2/Keycloak token and the one assigned by the portal to the user's organization. diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/pr_etiquette.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/pr_etiquette.md deleted file mode 100644 index 26b513a9f72..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/pr_etiquette.md +++ /dev/null @@ -1,70 +0,0 @@ -# Etiquette for pull requests - -## As an author - -Submitting pull requests in EDC should be done while adhering to a couple of simple rules. - -- Familiarize yourself - with [coding style](styleguide.md), [architectural patterns](docs/development/coding-principles.md) and - other contribution guidelines. -- No surprise PRs please. Before you submit a PR, open a discussion or an issue outlining your planned work and give - people time to comment. It may even be advisable to contact committers using the `@mention` feature. Unsolicited PRs - may get ignored or rejected. -- Create your working branch in your fork of Tractus-X EDC, and create the PR against the upstream `main` branch -- Create focused PRs: your work should be focused on one particular feature or bug. Do not create broad-scoped PRs that - solve multiple issues as reviewers may reject those PR bombs outright. -- Provide a clear description and motivation in the PR description in GitHub. This makes the reviewer's life much - easier. It is also helpful to outline the broad changes that were made, e.g. "Changes the schema of XYZ-Entity: - the `age` field changed from `long` to `String`". -- If you introduce new 3rd party dependencies, be sure to note them in the PR description and explain why they are - necessary. -- Stick to the established code style, please refer to the [styleguide document](styleguide.md). -- All tests should be green, especially when your PR is in `"Ready for review"` -- Mark PRs as `"Ready for review"` only when you're prepared to defend your work. By that time you have completed your - work and shouldn't need to push any more commits other than to incorporate review comments. -- Merge conflicts should be resolved by squashing all commits on the PR branch, rebasing onto `main` and - force-pushing. Do this when your PR is ready to review. -- If you require a reviewer's input while it's still in draft, please contact the designated reviewer using - the `@mention` feature and let them know what you'd like them to look at. -- Request a review from one of the committers. Requesting a review from anyone else is still possible, and - sometimes may be advisable, but only committers can merge PRs, so be sure to include them early on. -- Re-request reviews after all remarks have been adopted. This helps reviewers track their work in GitHub. -- If you disagree with a committer's remarks, feel free to object and argue, but if no agreement is reached, you'll have - to either accept the decision or withdraw your PR. -- Be civil and objective. No foul language, insulting or otherwise abusive language will be tolerated. -- The PR titles must follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). - - The title must follow the format as `(): `. - `build`, `chore`, `ci`, `docs`, `feat`, `fix`, `perf`, `refactor`, `revert`, `style`, `test` are allowed for - the ``. - - The length must be kept under 80 characters. - -## As a reviewer - -- Please complete reviews within two business days or delegate to another committer, removing yourself as a reviewer. -- If you have been requested as reviewer, but cannot do the review for any reason (lack of time or expertise in a - particular area, etc.) please comment that in the PR and remove yourself as a reviewer, suggesting a stand-in. - The [code owners document](CODEOWNERS) should help with that. -- Don't be overly pedantic. -- Don't argue basic principles (code style, architectural decisions, etc.) -- Use the `suggestion` feature of GitHub for small/simple changes. -- The following could serve you as a review checklist: - - no unnecessary dependencies in `build.gradle.kts` - - sensible unit tests, prefer unit tests over integration tests wherever possible (test runtime). Also check the - usage of test tags. - - code style - - simplicity and "uncluttered-ness" of the code - - overall focus of the PR -- Don't just wave through any PR. Please take the time to look at them carefully. -- Be civil and objective. No foul language, insulting or otherwise abusive language will be tolerated. The goal is to - _encourage_ contributions. - -## The technical committers (as of April 05, 2023) - -Main committers for the Tractus-X EDC project: - -- @paullatzelsperger -- @florianrusch-zf - -Alternatively, the following Tractus-X committers can also step in: - -- @SebastianBezold diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/resources/save_actions_scr.png b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/resources/save_actions_scr.png deleted file mode 100644 index 10ae06cb006..00000000000 Binary files a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/resources/save_actions_scr.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/styleguide.md b/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/styleguide.md deleted file mode 100644 index 695faf91d13..00000000000 --- a/docs-kits_versioned_docs/version-23.09/kits/tractusx-edc/styleguide.md +++ /dev/null @@ -1,62 +0,0 @@ -# Eclipse Tractus-X EDC Code Style Guide - -In order to maintain a coherent code style throughout the project we ask every contributor to adhere to a few simple -style guidelines. We assume most developers will use at least something like `vim` and therefore have support for -automatic code formatting, we are not going to list the guidelines here. If you absolutely want to take a look, checkout -the [config written in XML](resources/tx-checkstyle-config.xml). - -## Checkstyle configuration - -Checkstyle is a [tool](https://checkstyle.sourceforge.io/) that can statically analyze your source code to check against -a set of given rules. Those rules are formulated in an [XML document](resources/tx-checkstyle-config.xml). Many modern -IDEs have a plugin available for download that runs in the background and does code analysis. - -Our checkstyle config is based off of the [Google Style](https://checkstyle.sourceforge.io/google_style.html) with a few -additional rules such as the naming of constants and Types. - -_Note: currently we do **not** enforce the generation of Javadoc comments, even though documenting code is **highly** -recommended. We might enable this in the future, such that at least interfaces and public methods are commented._ - -## Running Checkstyle - -Checkstyle can be run in different ways: implicitly we run it through the `checkstyle` Gradle Plugin -during `gradle build` or `gradle check`. That will cause the build to fail if any violations are found. But in order to get better -usability and on-the-fly reporting, Checkstyle is also available as IDE plugins for many modern IDEs, and it can run -either on-demand or continuously in the background: - -- [IntelliJ IDEA plugin [recommended]]() -- [Eclipse IDE [recommended]]() - -### Checkstyle as PR validation - -Apart from running Checkstyle locally as IDE plugin, we do run it on -our GitHub Actions pipeline. At this time, Checkstyle will only spew out warnings, but -we may tighten the rules at a future time and without notice. This will result in failing GitHub Action pipelines. Also, -committers might reject PRs due to Checkstyle warnings. - -It is therefore **highly** recommended running Checkstyle locally as well. - -If you **do not wish** to run Checkstyle on you local machine, that's fine, but be prepared to get your PRs rejected -simply because of a naming or formatting error. - -## [Recommended] IntelliJ Code Style Configuration - -If you are using Jetbrains IntelliJ IDEA, we have created a specific code style configuration that will automatically -format your source code according to that style guide. This should eliminate most of the potential Checkstyle violations -right from the get-go. You will need to reformat your code manually or in a pre-commit hook though. - -## [Optional] Intellij SaveActions Plugin - -If you absolutely want to make sure that no piece of ever-so-slightly misformatted code even hits your hard disk, we -advise you to use the [SaveActions plugin](https://plugins.jetbrains.com/plugin/7642-save-actions) for IntelliJ IDEA. It -takes care that your code is always correctly formatted. Unfortunately SaveActions has no export feature, so please just -copy this configuration: - -![SaveActions configuration](resources/save_actions_scr.png) - -## [Optional] Generic `.editorConfig` - -For most other editors and IDEs we've supplied an [.editorConfig](resources/tx-codestyle.editorconfig) file that can be -placed at the appropriate location. The specific location will largely depend on your editor and your OS, please refer -to the -[official documentation](https://editorconfig.org) for details. diff --git a/docs-kits_versioned_docs/version-3.1.0/introduction.md b/docs-kits_versioned_docs/version-3.1.0/introduction.md deleted file mode 100644 index e10b99d0138..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/introduction.md +++ /dev/null @@ -1 +0,0 @@ -# Introduction diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/_category_.json b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/_category_.json deleted file mode 100644 index da9a4885a1c..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Documentation" -} diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/page_api-reference.md b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/page_api-reference.md deleted file mode 100644 index b21022f8d48..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/page_api-reference.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -id: API Reference -title: API Reference -description: '' -sidebar_position: 2 ---- - -The BPDM is comprised of two primary services: BPDM Pool and BPDM Gate. The Swagger UI interface, which is an interactive tool for exploring and testing RESTful APIs. Swagger UI provides a user-friendly interface for interacting with APIs, allowing you to make requests, view responses, and explore different API endpoints and operations, allowing you to drill down into specific endpoints and view the associated request parameters, response schemas, and sample responses. - -The Business Partner Data Management includes the services that manages and shares business partner data with other Catena-X services. In the following sections, the available methods and different controllers of the API are explained. -More Information to the open-source repository can be found on [GitHub](https://github.com/eclipse-tractusx/bpdm) - -## BPDM Pool Api reference - -The Business Partner Data Management Pool includes the services that manages and shares business partner data with other Catena-X services. In the following sections, the available methods and different controllers of the API are explained. - -### Available Methods - -| Request Method | Request Description| -| :----------- | :------------: | -| PUT | Update. The endpoint expects to receive the full updated record, including values that didn't change.| -| POST| Search | -| GET | Search for the best match | -| DELETE | Deletes all the records in the controller, resets the timestamp| - -### 1. Site Controller - -The Site Controller is the controller that creates, updates, or retrieves business partners of type site (referenced via BPNS). There are PUT, POST and GET requests possible and api those are availble under site controller are clustered in table below. Hyperlink in each record gives you more information about api endpoint. - -| Site Controller Apis| -| :----------- | -| [Update existing site business partners](../Software%20Development%20View/Pool%20Api/update-site.api.mdx) | -| [Create new site business partners](../Software%20Development%20View/Pool%20Api/create-site.api.mdx) | -| [Search site partners by BPNs and/or parent BPNs](../Software%20Development%20View/Pool%20Api/search-sites.api.mdx) | -| [Search Main Addresses](../Software%20Development%20View/Pool%20Api/search-main-addresses.api.mdx) | -| [Get site partners by bpn](../Software%20Development%20View/Pool%20Api/get-site.api.mdx) | - -### 2. Legal Entity Controller - -The Legal Entity Controller calls, searches, creates or updates existing business partners of type legal entity (referenced via BPNL). There are PUT, POST and GET requests possible. The endpoint expects a perfect match or looks for the highest relevancy, depending on the request made. Some of the requests need a obligatory parameter, like business partner number or id value. Hyperlink in each record gives you more information about api endpoint. - -| Legal Entity Controller Apis| -| :----------- | -| [Get page of legal entity business partners matching the search criteria](../Software%20Development%20View/Pool%20Api/get-legal-entities.api.mdx) | -| [Update existing legal entity business partners](../Software%20Development%20View/Pool%20Api/update-business-partners.api.mdx) | -| [Create new legal entity business partners](../Software%20Development%20View/Pool%20Api/create-business-partners.api.mdx)| -| [Confirms that the data of a legal entity business partner is still up to date.](../Software%20Development%20View/Pool%20Api/set-legal-entity-currentness.api.mdx)| -| [Search legal entity partners by BPNLs.](../Software%20Development%20View/Pool%20Api/search-sites-1.api.mdx) | -| [Search Legal Addresses.](../Software%20Development%20View/Pool%20Api/search-legal-addresses.api.mdx)| -| [Get legal entity business partner by identifier.](../Software%20Development%20View/Pool%20Api/get-legal-entity.api.mdx) | -| [Get site partners of a legal entity.](../Software%20Development%20View/Pool%20Api/get-sites.api.mdx) | -| [Get address partners of a legal entity.](../Software%20Development%20View/Pool%20Api/get-addresses.api.mdx) | - -### 3. Address Controller - -The Address Controller is the controller that updates, creates, or retrieves business partner records of type address via BPNA. There are PUT, POST and GET requests possible. Hyperlink in each record gives you more information about api endpoint. - -| Address Controller Apis| -| :----------- | -| [Get page of addresses matching the search criteria](../Software%20Development%20View/Pool%20Api/get-addresses-1.api.mdx) | -| [Update existing address business partners](../Software%20Development%20View/Pool%20Api/update-addresses.api.mdx) | -| [Create new address business partners](../Software%20Development%20View/Pool%20Api/create-addresses.api.mdx) | -| [Search address partners by BPNs and/or parent BPNs](../Software%20Development%20View/Pool%20Api/search-addresses.api.mdx) | -| [Get address partners by bpn](../Software%20Development%20View/Pool%20Api/get-address.api.mdx) | - -### 4. Open Search Controller - -The Open Search Controller is only used by the developers on the backend of the API. They are not relevant for the API end-users. Hyperlink in each record gives you more information about api endpoint. - -| Open Search Controller Apis| -| :----------- | -| [Fetch information about the latest OpenSearch export](../Software%20Development%20View/Pool%20Api/get-business-partners.api.mdx) | -| [Index new business partner records on OpenSearch](../Software%20Development%20View/Pool%20Api/export.api.mdx) | -| [Clear business partner index on OpenSearch](../Software%20Development%20View/Pool%20Api/clear.api.mdx) | - -### 5. Metadata Controller - -The Metadata Controller can retrieve and create legal forms, new issuing bodies, identifier types and identifier statuses. There are POST and GET requests possible. Hyperlink in each record gives you more information about api endpoint. - -| Metadata Controller | -| :----------- | -| [Get page of legal forms](../Software%20Development%20View/Pool%20Api/get-legal-forms.api.mdx) | -| [Create new legal form](../Software%20Development%20View/Pool%20Api/create-legal-form.api.mdx) | -| [Get page of issuing bodies](../Software%20Development%20View/Pool%20Api/get-issuing-bodies.api.mdx) | -| [Create new issuing body](../Software%20Development%20View/Pool%20Api/create-issuing-body.api.mdx) | -| [Get page of identifier types](../Software%20Development%20View/Pool%20Api/get-identifier-types.api.mdx) | -| [Create new identifier type](../Software%20Development%20View/Pool%20Api/create-identifier-type.api.mdx) | -| [Get page of identifier statuses](../Software%20Development%20View/Pool%20Api/get-identifier-stati.api.mdx) | -| [Create new identifier status](../Software%20Development%20View/Pool%20Api/create-identifier-status.api.mdx) | -| [Get valid identifier types for a country](../Software%20Development%20View/Pool%20Api/get-valid-identifier-types-for-country.api.mdx) | - -### 6. BPN Controller - -The BPN Controller can retrieve business partner numbers by identifiers. The request is limited to 5000 entries. The hyperlink in below record gives you more information about api endpoint. - -| BPN Controller Api| -| :----------- | -| [Find business partner numbers by identifiers](../Software%20Development%20View/Pool%20Api/find-bpns-by-identifiers.api.mdx) | - -### 7. Business Partner Controller - -The Business Partner Controller retrieves the change log entries per business partner number. The business partner number is a required field to execute the search. The hyperlink in below record gives you more information about api endpoint. - -| Business Partner Controller Api| -| :----------- | -| [Get business partner changelog entries by bpn](../Software%20Development%20View/Pool%20Api/get-changelog-entries.api.mdx) | - -## BPDM Gate Api reference - -The Business Partner Data Management Gate includes the services that managesto share business partner data with Catena-X.In the following sections, the available methods and different controllers of the API are explained. - -### Available Methods - -| Request Method | Request Description| -| :----------- | :------------: | -| PUT | Update. The endpoint expects to receive the full updated record, including values that didn't change.| -| POST| Search | -| GET | Search for the best match | -| DELETE | Deletes all the records in the controller, resets the timestamp| - -Gate service consist of five major controllers which are listed below. - -### 1. Site Controller - -The Site Controller is the controller that creates, updates, or retrieves business partners of type site (referenced via BPNS). There are PUT, POST and GET requests possible. - -| Site Controller Api| -| :----------- | -| [Get page of sites](../Software%20Development%20View/Gate%20Api/get-sites.api.mdx) | -| [Create or update sites](../Software%20Development%20View/Gate%20Api/upsert-sites.api.mdx) | -| [Get page of sites. Can optionally be filtered by external ids](../Software%20Development%20View/Gate%20Api/get-sites-output.api.mdx) | -| [Validate a site](../Software%20Development%20View/Gate%20Api/validate-site.api.mdx) | -| [Get site by external identifier](../Software%20Development%20View/Gate%20Api/get-site-by-external-id.api.mdx) | - -### 2. legal Entity Controller - -The Legal Entity Controller calls, searches, creates or updates existing business partners of type legal entity (referenced via BPNL). There are PUT, POST and GET requests possible. Some of the requests need a obligatory parameter, like external id. - -| legal Entity Controller | -| :----------- | -| [Get page of legal entities](../Software%20Development%20View/Gate%20Api/get-legal-entities.api.mdx) | -| [Create or update legal entities.](../Software%20Development%20View/Gate%20Api/upsert-legal-entities.api.mdx) | -| [Get page of legal entities. Can optionally be filtered by external ids](../Software%20Development%20View/Gate%20Api/get-legal-entities-output.api.mdx) | -| [Validate a legal entity](../Software%20Development%20View/Gate%20Api/validate-legal-entity.api.mdx) | -| [Get legal entity by external identifier](../Software%20Development%20View/Gate%20Api/get-legal-entity-by-external-id.api.mdx) | - -### 3. Address Controller - -The Address Controller is the controller that updates, creates, or retrieves business partner records of type address via BPNA. There are PUT, POST and GET requests possible. - -| Address Controller | -| :----------- | -| [Get page of addresses](../Software%20Development%20View/Gate%20Api/get-addresses.api.mdx) | -| [Create or update addresses](../Software%20Development%20View/Gate%20Api/upsert-addresses.api.mdx) | -| [Get page of addresses. Can optionally be filtered by external ids.](../Software%20Development%20View/Gate%20Api/get-addresses-output.api.mdx) | -| [Validate an address partner](../Software%20Development%20View/Gate%20Api/validate-site-1.api.mdx) | -| [Get address by external identifier](../Software%20Development%20View/Gate%20Api/get-address-by-external-id.api.mdx) | - -### 4. Business Partner Controller - -The business partner controller is controller that determines its likely type of either legal entity, site or address. It is possible that no type could be determined. -The candidate needs to contain either a name or an identifier as a minimum requirement. - -| Business Partner Controller | -| :----------- | -| [Determine the LSA type of a business partner candidate](../Software%20Development%20View/Gate%20Api/determine-lsa-type.api.mdx) | - -### 5. Changelog controller - -The changelog controller is controller that gets business partner changelog entries by list of external id from timestamp. -Only two POST api's available for search of business partner changelog details. - -| Changelog Controller | Description | -| :----------- | :----------- | -| POST /api/catena/business-partners/changelog/search | Retrive business partner changelog entries by list external id, from timestamp | -| POST /api/catena/business-partners/changelog/filter | RGet business partner changelog entries by from timestamp or Legal Entity, Site or Address type | diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/page_best-practices.md b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/page_best-practices.md deleted file mode 100644 index a9d646149a8..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/page_best-practices.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: Best Practices -title: Best Practices -description: '' -sidebar_position: 4 ---- - -Depending on usage, we have categorized best practices for two types of user. - -## Running BPDM service locally - -1. Ensure that you have all the prerequisites installed before attempting to run the BPDM service. These include Maven, JDK17, PostgreSQL 14.2, OpenSearch 2.1.0, Keycloak 17.0.0, and a connection to an SaaS. - -2. Follow the instructions provided in the [INSTALL.md](https://github.com/eclipse-tractusx/bpdm/blob/main/INSTALL.md) and [README.md](https://github.com/eclipse-tractusx/bpdm/blob/main/README.md) files carefully to ensure that you install and configure the service correctly. - -3. Use the default configuration settings for PostgreSQL and OpenSearch unless you have a specific reason to change them. - -4. Ensure that you have a Postgresql database and an Opensearch instance available to connect to before attempting to run the service or you can use existing config using [docker-compose.yml](https://github.com/eclipse-tractusx/bpdm/blob/main/docker-compose.yml). - -5. Check the configuration files, such as application.properties, application-auth.properties, and application-saas.properties, to ensure that they are correctly configured for your environment. - -6. Use the REST API documentation provided at and for the BPDM Pool and Gate respectively to familiarize yourself with the API and to test your setup. - -7. Use the profiles, such as default, auth, and saas, provided by the service to configure it for your specific use case. - -8. Ensure that you have a connection to the BPDM Pool API if you plan to use the BPDM Gate. Follow standard security practices when deploying the BPDM service, such as securing access to the service, and securing access to any data or credentials used by the service. - -## Intergrating with BPDM api - -1. Always use secure connections: - Ensure that you use HTTPS protocol instead of HTTP to make API requests to the BPDM server. This ensures the security and confidentiality of the data being transmitted. - -2. Follow the API documentation [getting Started section](page_documentation-bpdm.md#intergrating-with-bpdm-api) : - Read the BPDM API documentation carefully and follow the guidelines provided. This will help you to understand the API, its capabilities, and how to use it properly. - -3. Use proper authentication using OAuth 2.0: - Use the appropriate authentication method provided by BPDM service and also mentioned steps for [authentication](page_documentation-bpdm.md#intergrating-with-bpdm-api) to access the API. This will ensure that only authorized users have access to the API. - -4. Handle errors gracefully: - Always handle errors returned by the API gracefully and provide meaningful error messages to the user. This will help to diagnose and resolve any issues that may occur. - -5. Use appropriate data types: - Use the appropriate data types when sending data to the API and when receiving data from it. This will help to ensure that the data is correctly interpreted and processed by both your application and the API. - -6. Test thoroughly: - Test your application thoroughly before deploying it in a production environment. This will help to identify any issues or bugs before they can impact users or the BPDM API service. - -7. Monitor usage: - Monitor your application's usage of the BPDM API to ensure that it is not consuming too many resources or causing performance issues. If necessary, adjust your application's usage or scale up the resources it uses. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/page_documentation-bpdm.md b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/page_documentation-bpdm.md deleted file mode 100644 index bae0d417f37..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/page_documentation-bpdm.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -id: Introduction -title: Introduction -description: '' -sidebar_position: 1 ---- - -![Business partner kit banner](@site/static/img/BPKitIcon.png) - -### Business Partner KIT - -## Introduction - -BPDM (Business Partner Data Management) is a core component of the Catena-X project, which aims to create a secure, trusted, and standardized ecosystem for the exchange of data among various stakeholders in the automotive industry. BPDM provides services for querying, adding, and managing business partner base information in the Catena-X landscape. - -The BPDM is comprised of two primary services: BPDM Pool and BPDM Gate. The BPDM Pool serves as the single source of truth for business partner base information, including official identifiers, addresses, and other key details. Each record in the Pool has a unique identifier, called the business partner number (BPN), which enables it to be referenced across the entire Catena-X ecosystem. Business partner records in the Pool are organized into three categories: legal entities, sites, and partner addresses. A legal entity represents the primary information about a business partner, while a site may represent a plant or campus with several contact and delivery addresses. An address partner represents the location of a legal entity or site with a single contact/delivery address. - -The BPDM Pool offers an API that enables Catena-X members to query business partner records by BPN, other identifiers, or through a text search. This API is designed to provide quick and easy access to critical business partner data, allowing Catena-X members to make informed decisions based on reliable information. - -The BPDM Gate, on the other hand, provides a mechanism for Catena-X members to share their own business partner data with the Catena-X ecosystem. Members who share their data with Catena-X are called sharing members. Through the Gate service, sharing members can add their own business partner records and retrieve cleaned and enhanced data in return. This shared business partner data undergoes a validation and enhancement process before it is integrated into the BPDM Pool and assigned a BPN. - -Overall, BPDM plays a crucial role in creating a standardized and secure ecosystem for the exchange of business partner data in the automotive industry. Its services enable Catena-X members to easily access reliable and up-to-date business partner data and to share their own data with confidence, while ensuring data security and privacy. - -## Getting Started - -Getting started is easy. Here is a summary of the information that might help you get started: - -Depending on usage, we have categorised two separate sections that one is running the BPDM Service and another is integrating with the BPDM API. Then it will dive into the purpose of the API and the technical specification of how to set up the API and run it. The API documentation is written in Swagger. Here, the Swagger controllers and sections will be explained in detail in api reference topic. - -### Running BPDM service - -This section would provide instructions for a user who wants to run the BPDM service locally or deploy it on a remote server. -The BDPM is a SpringBoot Kotlin software project managed by Maven. The core information about the API setup is shown below. For the complete and up to date API setup, refer to the [GitHub website](https://github.com/eclipse-tractusx/bpdm#profiles). - -* BPDM Pool - - 1. BPDM Pool is a SpringBoot Kotlin software project managed by Maven. - 2. The project can be run with the following command: mvn clean spring-boot:run - 3. Prerequisites: Maven, JDK17, PostgreSQL 14.2, OpenSearch 2.1.0, Keycloak 17.0.0, Connection to an SaaS. - 4. The project requires a Postgresql database and an Opensearch instance to be available to connect to. - 5. Default configuration: postgres to run on localhost on port 5432, Opensearch to run on localhost on port 9200. - 6. Configuration files: application.properties, application-auth.properties, and application-saas.properties. - 7. REST API documentation: . - 8. Profiles: default, auth, and saas. - -* BPDM Gate - - 1. BPDM Gate is a SpringBoot Kotlin software project managed by Maven. - 2. The project can be run with the following command: mvn clean spring-boot:run - 3. Prerequisites: Maven, JDK17, Connection to an SaaS, Connection to BPDM Pool API, Keycloak 17.0.0. - 4. The Gate requires a remote SaaS storage and datasource to exchange data with. - 5. Default configuration: BPDM Pool instance expected at localhost with port 8080. - 6. Configuration files: application.properties, application-auth.properties, and application-pool-auth.properties. - 7. REST API documentation: . - 8. Profiles: default, auth, and auth-pool. - -It is important to follow the instructions mentioned in the [INSTALL.md](https://github.com/eclipse-tractusx/bpdm/blob/main/INSTALL.md) and [README.md](https://github.com/eclipse-tractusx/bpdm/blob/main/README.md) files to ensure successful installation and configuration. - -### Intergrating with BPDM api - -This section provides you info on how you can integrate with existing bpdm api service which is hosted on remote server. For better understanding, we have provided examples with dummy hostname. There is a reference implementation of the API on GitHub. The software as a service component is shown with the example of the actual conceptional/development partner. If the component is replaced, adjustments may be necessary. - -| Type | Description | Link | -| :----------- | :------------: | :------------: | -| Dummy Server | It is server where bpdm api is deployed | | - -As shown in above table, we have taken Dummy server for reference where BPDM service is already hosted. A local instance can also be set up and we just need following, - -* Software compiler: Maven -* Development environment: JDK 11 -* Database: PostgreSQL 14.2 -* Authentication: Keycloak 17.0.0 -* OpenSearch 2.1.0 (with enabled OpenSearch component) - -The API has different Spring profiles depending on the configuration purpose, for better understanding we have putted dummy profile for execution on remote server - -* default: when no environment specified -* local: for the execution on local machine (developer profile) -* dummy: for execution on remote environment - -The following table shows the dependencies of the profiles to each environment: - -| Type | Persist | Auth | Open Search | -| :----------- | :----------- | :----------- | :----------- | -| default | Localhost | Disabled | Disabled | -| local | Localhost | Disabled | Localhost | -| Dummy | dummy or Host define in BPDM_DB_HOST | Catena X dummy Keycloak | dummy or Host defined in BPDM_OPENSEARCH_HOST | - -Authentication: - -To integrate already deployed BPDM api with your application, you need to follow steps to generate bearer type token. -On how you can generate the token, you need to follow steps as listed below. There are many ways you can configure token to your application. - -Steps: - -1. Register the application: - Your application will need to register with BPDM in this case dummy OAuth 2.0 provider and obtain a client ID and client secret. - This process typically involves creating an account and specifying the required permissions and scopes that your application will need to access BPDM APIs. - -2. Redirect the your application user to BPDM OAuth 2.0 authorization endpoint: - Once the your application has obtained your client credentials, you can initiate the OAuth 2.0 authorization flow by redirecting your users to BPDM OAuth 2.0 authorization endpoint. - This endpoint typically involves prompting the user to grant permission for the your application to access BPDM APIs, specifying the required scopes, and possibly requiring the user to log in or authenticate with BPDM OAuth 2.0 provider. - -3. Receive an authorization code: - After the user grants permission, BPDM OAuth 2.0 authorization server will redirect the user back to the your application with an authorization code. - This code is a one-time use token that the your application will need to exchange for an access token in the next step. - -4. Exchange the authorization code for an access token: - Your application can exchange the authorization code for an access token by sending a request to BPDM OAuth 2.0 token endpoint, along with their client ID, client secret, authorization code, and any other required parameters. - This request typically uses the OAuth 2.0 grant type "authorization code." If the request is successful, BPDM OAuth 2.0 server will respond with an access token, which can be used to make API requests on behalf of the user. - -5. Use the access token to access the API: - Once your application has obtained an access token, you can use it to make API requests on behalf of the user. - The access token is typically sent in the "Authorization" header of API requests as a bearer token. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/page_troubleshooting.md b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/page_troubleshooting.md deleted file mode 100644 index 710544d2c22..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/page_troubleshooting.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -id: Troubleshooting -title: Troubleshooting -description: '' -sidebar_position: 5 ---- -Depending on usage, we have categorized trobleshooting for two types of user. - -## Running BPDM service locally - -1. Ensure that all the prerequisites are installed and properly configured before attempting to run the BPDM service. The required software includes Maven, JDK17, PostgreSQL 14.2, OpenSearch 2.1.0, and Keycloak 17.0.0. Make sure that you have the correct versions of these software installed and that they are properly configured. - -2. Make sure that the Postgresql database and Opensearch instance are available and can be connected to by the BPDM service. The default configuration expects Postgresql to run on localhost on port 5432 and Opensearch to run on localhost on port 9200. If you are running the database and/or instance on a different host or port, you will need to update the configuration files accordingly. - -3. Check the configuration files (application.properties, application-auth.properties, and application-saas.properties) for any errors or misconfigurations. These files contain important information about how the BPDM service is configured and what resources it relies on. - -4. If you are running the BPDM Gate, ensure that it can connect to the BPDM Pool API and the remote SaaS storage and datasource. The default configuration expects the BPDM Pool instance to be located at localhost with port 8080. If you are running the BPDM Pool on a different host or port, you will need to update the configuration files accordingly. - -5. Check the profiles (default, auth, and saas for BPDM Pool, and default, auth, and auth-pool for BPDM Gate) to make sure that they are properly configured for your specific use case. These profiles define how the BPDM service will behave under different circumstances and can be customized to fit your specific needs. - -6. If you encounter any errors or issues when running or deploying the BPDM service, refer to the [INSTALL.md](https://github.com/eclipse-tractusx/bpdm/blob/main/INSTALL.md) and [README.md](https://github.com/eclipse-tractusx/bpdm/blob/main/README.md) files for troubleshooting tips and other helpful information. These files contain detailed instructions on how to install and configure the BPDM service and can be a valuable resource when encountering problems. - -## Intergrating with BPDM api - -1. Connectivity issues: - Ensure that your application can communicate with the BPDM server over the network. Check the server status, firewall rules, and network configurations. - -2. Authorization issues: - Make sure that your application has obtained a valid access bearer token from BPDM OAuth 2.0 provider, and that the token has the necessary scopes and permissions to access the requested resources for more details can check on [authorization steps](page_documentation-bpdm.md#intergrating-with-bpdm-api). - -3. API endpoint issues: - Double-check that you are using the correct endpoint URLs, HTTP methods, and parameters when making API requests. Refer to the API documentation or contact the BPDM api support team for assistance. - -4. Data format issues: - Verify that the data format of your API requests and responses match the expected data format specified in the API documentation. For example, some API endpoints may require JSON payload, while others may require form data or query parameters. - -5. Error handling issues: - Handle any errors that may occur during API requests and responses, such as HTTP error codes, error messages, or exception stack traces. Check the API documentation for the expected error codes and messages, and handle them accordingly in your application code. - -6. API versioning issues: - Keep track of the BPDM API version changes and ensure that your application code is compatible with the current version. Test your application with different API versions and handle any compatibility issues accordingly. - -7. Environment issues: - Make sure that your application is using the correct environment profile (e.g. default, local, or dummy) depending on the deployment location and configuration. Check the configuration files and environment variables for any discrepancies or errors. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/page_use-cases.md b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/page_use-cases.md deleted file mode 100644 index c188ff2c6c0..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Documentation BPDM/page_use-cases.md +++ /dev/null @@ -1,1667 +0,0 @@ ---- -id: Use Cases -title: Use Cases -description: '' -sidebar_position: 3 ---- - -Here we have provided detailed examples of how the BPDM services can be used. This includes step-by-step instructions for each use case and code snippets showing how to make the API calls for better performance. - -## Use case 1. Create/setup test data on local system for Pool api - -Description: This use case provides step-by-step instructions for setting up the local environment and starting the Pool API service for the BPDM (Business Partner Data Management) system. By following these instructions, users can easily clone the repository, configure the necessary services using Docker, and run the Pool API service on their local system. - -This use case aims to provide users with clear and concise instructions, ensuring a smooth setup process for working with the BPDM Pool API on their local systems. - -### 1.1 Start BPDM Pool Api service - -1. Clone the repository: - - Go to the following GitHub repository: [https://github.com/eclipse-tractusx/bpdm](https://github.com/eclipse-tractusx/bpdm) - - Clone the repository to your local system using Git. You can use the following command: - - ```bash - git clone https://github.com/eclipse-tractusx/bpdm - ``` - - - Choose an IDE:You can use any IDE of your preference to view the code. One recommended IDE is IntelliJ IDEA as it is Kotlin springBoot application. - -2. Configure local service: - - Open the docker-compose.yml file in the project. - - This file contains the configuration for running a local instance of PostgreSQL and OpenSearch. - - Make sure you have Docker installed on your system. - - If you don't have your own database, you can use Docker to create a local instance of PostgreSQL and OpenSearch. - - Run the following command from the command prompt or from the IDE's terminal to start the Docker containers: - - ```bash - docker-compose up - ``` - -3. Start the Pool API service: - - Open your IDE and navigate to the following directory within the cloned repository: bpdm-pool/src/main/kotlin/org/eclipse/tractusx/bpdm/pool. - - Navigate to Application.kt file. - - Run the main class Application.kt to start the Pool API service. - - The service should start and listen on the specified port for local setup it will be on . - -### 1.2 Test data setup - -1. Download the Postman collection JSON file: - - Go to the following GitHub repository path: [https://github.com/eclipse-tractusx/bpdm/tree/main/docs/postman](https://github.com/eclipse-tractusx/bpdm/tree/main/docs/postman) - - Locate the JSON file named "BPDM Pool.postman_collection.json" and click on it to view its contents. - - Click the "Raw" button to download the file. - -2. Open Postman: - - If you don't have Postman installed, you can download it from the official website: [https://www.postman.com/downloads/](https://www.postman.com/downloads/) - - Open Postman on your local system. - -3. Import the collection: - - In the Postman application, click on the "Import" button located in the top left corner of the window. - - Select the "File" tab. - - Click on the "Choose Files" button and browse to the location where you downloaded the "BPDM Pool.postman_collection.json" file. - - Select the JSON file and click "Open" to import it. - -4. Verify the imported collection: - - After importing, you should see the "BPDM Pool" collection listed in the left sidebar of the Postman application. - - Click on the imported collection to expand it and view the available requests and folders. - -5. Set up environment variables: - - In Postman, click on the "Manage Environments" button located in the top right corner of the window (it looks like an eye icon). - - Click on the "Add" button to create a new environment. - - Provide a name for the environment (e.g., "BPDM Pool Local"). - - Add the following variables: - - Name: `Pool-Host`, Initial Value: `http://localhost:YOUR_PORT_NUMBER` - (Replace `YOUR_PORT_NUMBER` with the actual port number on which your Pool API service is running.) - -6. Check if metadata is available: - - Expand the "BPDM Pool" collection in the left sidebar. - - Click on the "GET identifier-types" request. - - In the request URL, replace `{{Pool-Host}}` with the appropriate Pool API host URL (e.g., `http://localhost:YOUR_PORT_NUMBER`). - - Click the "Send" button to make the request. - - Verify if the response contains the identifier types. - - - Similarly, repeat the above steps for the following requests: - - "GET issuing-bodies" - - "GET identifier-status" - - - If any of the metadata (identifier types, issuing bodies, identifier status) is not available in the response, you can create them using the respective "POST" requests provided in the Postman collection. - -Now you have imported the Postman collection and checked if the metadata is available using the provided endpoints. If any metadata is missing, you can create it using the corresponding requests in the collection. - -## Use Case 2. Request Legal Entity by identifier number - -Description: The Legal Entity Controller is a module within a larger system that facilitates the retrieval of information about a legal entity using their identifier number. In this use case, we are providing examples by starting services on local machine. - -The examples taken below are generic and depending on use cases, we have mentioned snippet of particular api request and response for better understanding. In this use case, consider you being user you have identifier and you want to get legal entity for same. - -### Example request call - -The request should be made first to check Catenea-X api for checking the identifier first. This request will be handled by metadata controller and will provide all available identifier type in particular enviroment. - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/identifier-types?page=0&size=100' -``` - -Response: - -```bash -{ - "totalElements": 26, - "totalPages": 1, - "page": 0, - "contentSize": 26, - "content": [ - { - "technicalKey": "EU_VAT_ID_DE", - "name": "Value added tax identification number", - "url": null - }, - { - "technicalKey": "EU_VAT_ID_FR", - "name": "Value added tax identification number", - "url": null - }, - { - "technicalKey": "EU_VAT_ID_AT", - "name": "Value added tax identification number", - "url": null - }, - { - "technicalKey": "EU_VAT_ID_BE", - "name": "Value added tax identification number", - "url": null - }, - { - "technicalKey": "EU_VAT_ID_CH", - "name": "Value added tax identification number", - "url": null - }, - { - "technicalKey": "EU_VAT_ID_CZ", - "name": "Value added tax identification number", - "url": null - }, - { - "technicalKey": "EU_VAT_ID_DK", - "name": "Value added tax identification number", - "url": null - }, - { - "technicalKey": "EU_VAT_ID_ES", - "name": "Value added tax identification number", - "url": null - }, - { - "technicalKey": "EU_VAT_ID_GB", - "name": "Value added tax identification number", - "url": null - }, - { - "technicalKey": "EU_VAT_ID_NO", - "name": "Value added tax identification number", - "url": null - }, - { - "technicalKey": "EU_VAT_ID_PL", - "name": "Value added tax identification number", - "url": null - }, - { - "technicalKey": "GS1_GLN", - "name": "Global Location Number", - "url": null - }, - { - "technicalKey": "LEI_ID", - "name": "Legal Entity Identifier", - "url": null - }, - { - "technicalKey": "DUNS_ID", - "name": "Data Universal Numbering System", - "url": null - }, - { - "technicalKey": "DE_BNUM", - "name": "Handelsregister (HRB)", - "url": null - }, - { - "technicalKey": "FR_SIREN", - "name": "Siren/Siret", - "url": null - }, - { - "technicalKey": "BR_ID_AT", - "name": "Firmenbuchnummer", - "url": null - }, - { - "technicalKey": "BE_ENT_NO", - "name": "Organisation number", - "url": null - }, - { - "technicalKey": "CH_UID", - "name": "Company Identification Number CH", - "url": null - }, - { - "technicalKey": "CZ_ICO", - "name": "Company Identification Number CZ", - "url": null - }, - { - "technicalKey": "CVR_DK", - "name": "Business Registration Number DK", - "url": null - }, - { - "technicalKey": "CIF_ES", - "name": "Certificado de Identificación Fiscal", - "url": null - }, - { - "technicalKey": "ID_CRN", - "name": "Company Registration Number", - "url": null - }, - { - "technicalKey": "NO_ORGID", - "name": "Organization Number", - "url": null - }, - { - "technicalKey": "PL_REG", - "name": "REGON", - "url": null - }, - { - "technicalKey": "CUSTOM_ID_TYPE", - "name": "Custom Identifier Type for Testing", - "url": null - } - ] -} -``` - -The response here showing technical key for identifier type with it's name. For better understanding of this use case, we are considering identifier type i.e. CUSTOM_ID_TYPE for future examples. - -Now as per the above response, you can check your desired technical identifier which is nothing but kind of VAT number for particular legal entity. Request to the Catena-X API for legal entities with a filter on legal entity identifier i.e. 123456789 and with idType as CUSTOM_ID_TYPE. The response you received is a JSON object that contains information about the legal entity that match your query. - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/legal-entities/123456789?idType=CUSTOM_ID_TYPE' -``` - -### 2.1 Direct response - -Scenario: The user enters a valid identifier number woth idType CUSTOM_ID_TYPE and the API returns information about only one legal entity. - -Flow: - -- The user inputs a valid identification number i.e. 123456789 and idType as CUSTOM_ID_TYPE to api request. -- The Legal Entity Controller displays the information about the legal entity as a response to the request. -- Once you have legal enity shown then direct response you can get using idType as BPN value as shown in below request and response. - -Response: - -```bash -{ - "bpn": "BPNL000000000001", - "identifiers": [ - { - "value": "123456789", - "type": { - "technicalKey": "CUSTOM_ID_TYPE", - "name": "Custom Identifier Type for Testing", - "url": null - }, - "issuingBody": { - "technicalKey": "CUSTOM_ISSUE_BODY", - "name": "Custom Issuing Body for Testing", - "url": null - }, - "status": { - "technicalKey": "CUSTOM_ID_STATUS", - "name": "Custom Identifier Status for Testing" - } - } - ], - "names": [ - { - "value": "Name of Company", - "shortName": "NoC", - "type": { - "technicalKey": "ACRONYM", - "name": "An acronym commonly used for a business partner.", - "url": "" - }, - "language": { - "technicalKey": "en", - "name": "English" - } - } - ], - "legalForm": { - "technicalKey": "CUSTOM_LEGAL_FORM", - "name": "Custom Legal Form for Testing", - "url": null, - "mainAbbreviation": "CLF_0001", - "language": { - "technicalKey": "en", - "name": "English" - }, - "categories": [ - { - "name": "holding company", - "url": null - } - ] - }, - "status": { - "officialDenotation": "Active", - "validFrom": "2020-12-16T05:54:48.942", - "validUntil": null, - "type": { - "technicalKey": "ACTIVE", - "name": "Active", - "url": "" - } - }, - "profileClassifications": [ - { - "value": "Farming of cattle, dairy farming", - "code": "01.21", - "type": { - "name": "NACE", - "url": "" - } - } - ], - "types": [], - "bankAccounts": [ - { - "trustScores": [], - "currency": { - "technicalKey": "EUR", - "name": "Euro" - }, - "internationalBankAccountIdentifier": "11223445569", - "internationalBankIdentifier": "TEST1234", - "nationalBankAccountIdentifier": "004566676", - "nationalBankIdentifier": "TEST223" - } - ], - "roles": [], - "relations": [], - "currentness": "2023-05-08T12:02:38.289932Z" -} -``` - -- If user putted wrong identifier number like below which is not available in DB then response will be as below. - -Bad request: - -```bash -curl --location 'http://localhost:8080/api/catena/legal-entities/name?idType=CUSTOM_ID_TYPE' -``` - -Response: - -```bash -{ - "timestamp": "2023-05-08T12:54:07.606+00:00", - "status": 404, - "error": "Not Found", - "path": "/api/catena/legal-entities/name" -} -``` - -### 2.2 Match Response - -Scenario: To get matched response, you can use multiple key and value pair. Multiple attributes like name, legalForm, status, classification etc can be used with desired known values for them. - -#### 2.2.1 Trade Scoring with Score -> take highest ranking - -Flow: - -- The user inputs a valid name key as Name of Company to the legal entity api request. -- The Legal Entity Controller provides response with multple legal entities. -- The Legal Entity Controller uses trade scoring to determine the highest ranking legal entity. -- The legal entity that matches values getting more score ranking. -- The Legal Entity Controller displays the information about the highest ranking legal entity to the user as response. -- Those legal entities having more scroe will take precedence like BPNL000000000001 got higher precedence with score 11.198933. - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/legal-entities?name=Name%20of%20Company&page=0&size=10' -``` - -Response: - -```bash -{ - "totalElements": 2, - "totalPages": 1, - "page": 0, - "contentSize": 2, - "content": [ - { - "score": 11.171583, - "legalEntity": { - "bpn": "BPNL000000000001", - "identifiers": [ - { - "value": "123456789", - "type": { - "technicalKey": "CUSTOM_ID_TYPE", - "name": "Custom Identifier Type for Testing", - "url": null - }, - "issuingBody": { - "technicalKey": "CUSTOM_ISSUE_BODY", - "name": "Custom Issuing Body for Testing", - "url": null - }, - "status": { - "technicalKey": "CUSTOM_ID_STATUS", - "name": "Custom Identifier Status for Testing" - } - } - ], - "names": [ - { - "value": "Name of Company", - "shortName": "NoC", - "type": { - "technicalKey": "ACRONYM", - "name": "An acronym commonly used for a business partner.", - "url": "" - }, - "language": { - "technicalKey": "en", - "name": "English" - } - } - ], - "legalForm": { - "technicalKey": "CUSTOM_LEGAL_FORM", - "name": "Custom Legal Form for Testing", - "url": null, - "mainAbbreviation": "CLF_0001", - "language": { - "technicalKey": "en", - "name": "English" - }, - "categories": [ - { - "name": "holding company", - "url": null - } - ] - }, - "status": { - "officialDenotation": "Active", - "validFrom": "2020-12-16T05:54:48.942", - "validUntil": null, - "type": { - "technicalKey": "ACTIVE", - "name": "Active", - "url": "" - } - }, - "profileClassifications": [ - { - "value": "Farming of cattle, dairy farming", - "code": "01.21", - "type": { - "name": "NACE", - "url": "" - } - } - ], - "types": [], - "bankAccounts": [ - { - "trustScores": [], - "currency": { - "technicalKey": "EUR", - "name": "Euro" - }, - "internationalBankAccountIdentifier": "11223445569", - "internationalBankIdentifier": "TEST1234", - "nationalBankAccountIdentifier": "004566676", - "nationalBankIdentifier": "TEST223" - } - ], - "roles": [], - "relations": [], - "currentness": "2023-05-08T12:02:38.289932Z" - } - }, - { - "score": 1.5469646, - "legalEntity": { - "bpn": "BPNL0000000001YN", - "identifiers": [ - { - "value": "987654321", - "type": { - "technicalKey": "CUSTOM_ID_TYPE", - "name": "Custom Identifier Type for Testing", - "url": null - }, - "issuingBody": { - "technicalKey": "CUSTOM_ISSUE_BODY", - "name": "Custom Issuing Body for Testing", - "url": null - }, - "status": { - "technicalKey": "CUSTOM_ID_STATUS", - "name": "Custom Identifier Status for Testing" - } - } - ], - "names": [ - { - "value": "Other Test Company", - "shortName": "OTC", - "type": { - "technicalKey": "REGISTERED", - "name": "The main name under which a business is officially registered in a country's business register.", - "url": "" - }, - "language": { - "technicalKey": "en", - "name": "English" - } - } - ], - "legalForm": { - "technicalKey": "CUSTOM_LEGAL_FORM", - "name": "Custom Legal Form for Testing", - "url": null, - "mainAbbreviation": "CLF_0001", - "language": { - "technicalKey": "en", - "name": "English" - }, - "categories": [ - { - "name": "holding company", - "url": null - } - ] - }, - "status": { - "officialDenotation": "Dissolved", - "validFrom": "2021-03-14T05:54:48.942", - "validUntil": null, - "type": { - "technicalKey": "DISSOLVED", - "name": "Dissolved", - "url": "" - } - }, - "profileClassifications": [ - { - "value": "Warehousing and Storage", - "code": "49", - "type": { - "name": "NAICS", - "url": "" - } - } - ], - "types": [], - "bankAccounts": [ - { - "trustScores": [], - "currency": { - "technicalKey": "EUR", - "name": "Euro" - }, - "internationalBankAccountIdentifier": "7654432212", - "internationalBankIdentifier": "TEST1234", - "nationalBankAccountIdentifier": "999847444", - "nationalBankIdentifier": "TEST223" - } - ], - "roles": [], - "relations": [], - "currentness": "2023-05-08T12:02:38.290191Z" - } - } - ] -} -``` - -#### 2.2.2 All scores are Equal or 0.0 -> no automatic match possible - -Flow: - -- The user inputs a valid key and vale to the legal entity api request. -- Consider use has enter key - legalForm and value - Custom Legal Form for Testing under api request shown below while quering. -- The Legal Entity Controlle API returns information about multiple legal entities. -- The Legal Entity Controller determines that all both two legal entities matching same filter. -- The Legal Entity Controller displays the information about both legal entities in response as shown in below. -- Here both legal entities i.e. BPNL000000000001 and BPNL0000000001YN are having same score which is 11.198933. -- Consider if user haven't applied any filter for attribute for this GET reuest then all legal enities will return as response and their score will be 0.0 - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/legal-entities?legalForm=Custom%20Legal%20Form%20for%20Testing&page=0&size=10' -``` - -Response: - -```bash -{ - "totalElements": 2, - "totalPages": 1, - "page": 0, - "contentSize": 2, - "content": [ - { - "score": 11.198933, - "legalEntity": { - "bpn": "BPNL000000000001", - "identifiers": [ - { - "value": "123456789", - "type": { - "technicalKey": "CUSTOM_ID_TYPE", - "name": "Custom Identifier Type for Testing", - "url": null - }, - "issuingBody": { - "technicalKey": "CUSTOM_ISSUE_BODY", - "name": "Custom Issuing Body for Testing", - "url": null - }, - "status": { - "technicalKey": "CUSTOM_ID_STATUS", - "name": "Custom Identifier Status for Testing" - } - } - ], - "names": [ - { - "value": "Name of Company", - "shortName": "NoC", - "type": { - "technicalKey": "ACRONYM", - "name": "An acronym commonly used for a business partner.", - "url": "" - }, - "language": { - "technicalKey": "en", - "name": "English" - } - } - ], - "legalForm": { - "technicalKey": "CUSTOM_LEGAL_FORM", - "name": "Custom Legal Form for Testing", - "url": null, - "mainAbbreviation": "CLF_0001", - "language": { - "technicalKey": "en", - "name": "English" - }, - "categories": [ - { - "name": "holding company", - "url": null - } - ] - }, - "status": { - "officialDenotation": "Active", - "validFrom": "2020-12-16T05:54:48.942", - "validUntil": null, - "type": { - "technicalKey": "ACTIVE", - "name": "Active", - "url": "" - } - }, - "profileClassifications": [ - { - "value": "Farming of cattle, dairy farming", - "code": "01.21", - "type": { - "name": "NACE", - "url": "" - } - } - ], - "types": [], - "bankAccounts": [ - { - "trustScores": [], - "currency": { - "technicalKey": "EUR", - "name": "Euro" - }, - "internationalBankAccountIdentifier": "11223445569", - "internationalBankIdentifier": "TEST1234", - "nationalBankAccountIdentifier": "004566676", - "nationalBankIdentifier": "TEST223" - } - ], - "roles": [], - "relations": [], - "currentness": "2023-05-08T12:02:38.289932Z" - } - }, - { - "score": 11.198933, - "legalEntity": { - "bpn": "BPNL0000000001YN", - "identifiers": [ - { - "value": "987654321", - "type": { - "technicalKey": "CUSTOM_ID_TYPE", - "name": "Custom Identifier Type for Testing", - "url": null - }, - "issuingBody": { - "technicalKey": "CUSTOM_ISSUE_BODY", - "name": "Custom Issuing Body for Testing", - "url": null - }, - "status": { - "technicalKey": "CUSTOM_ID_STATUS", - "name": "Custom Identifier Status for Testing" - } - } - ], - "names": [ - { - "value": "Other Test Company", - "shortName": "OTC", - "type": { - "technicalKey": "REGISTERED", - "name": "The main name under which a business is officially registered in a country's business register.", - "url": "" - }, - "language": { - "technicalKey": "en", - "name": "English" - } - } - ], - "legalForm": { - "technicalKey": "CUSTOM_LEGAL_FORM", - "name": "Custom Legal Form for Testing", - "url": null, - "mainAbbreviation": "CLF_0001", - "language": { - "technicalKey": "en", - "name": "English" - }, - "categories": [ - { - "name": "holding company", - "url": null - } - ] - }, - "status": { - "officialDenotation": "Dissolved", - "validFrom": "2021-03-14T05:54:48.942", - "validUntil": null, - "type": { - "technicalKey": "DISSOLVED", - "name": "Dissolved", - "url": "" - } - }, - "profileClassifications": [ - { - "value": "Warehousing and Storage", - "code": "49", - "type": { - "name": "NAICS", - "url": "" - } - } - ], - "types": [], - "bankAccounts": [ - { - "trustScores": [], - "currency": { - "technicalKey": "EUR", - "name": "Euro" - }, - "internationalBankAccountIdentifier": "7654432212", - "internationalBankIdentifier": "TEST1234", - "nationalBankAccountIdentifier": "999847444", - "nationalBankIdentifier": "TEST223" - } - ], - "roles": [], - "relations": [], - "currentness": "2023-05-08T12:02:38.290191Z" - } - } - ] -} -``` - -The response contains a few key fields that you can use to understand the information returned. - -- `totalElements` tells you the total number of legal entities that match your query. In this case, there are 10,978. -- `totalPages` tells you the total number of pages of legal entities. Since contentSize is set to 10, there are 1,098 pages in total.page tells you which page you are currently on. In this case, you are on the first page (page 0). -- `contentSize` tells you how many legal entities are included in the current page of results. In this case, there are 10 legal entities returned in the response. -- `content` is an array of legal entities that match your query. Each legal entity contains information about its identifiers, names, legal form, types, bank accounts, roles, and relations. - -### 2.3 Search particular legal entity - -Scenario: The user enters a valid BPN under request body and API returns information about legal entities in response. - -Flow: - -- The user inputs string in request body for api POST request call. -- If user entered value is correct i.e. if provided BPN is correct. Example in this request body provided "BPNL000000000001". -- Then Legal Entity Controller provide search result with one legal entity details. -- The Legal Entity Controller reads the BPNL (Business Partner Number List) from the API request and displays response as below. - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/legal-entities/search' \ ---header 'Content-Type: application/json' \ ---data '[ - "BPNL000000000001" -]' -``` - -Response: - -```bash -[ - { - "bpn": "BPNL000000000001", - "identifiers": [ - { - "value": "123456789", - "type": { - "technicalKey": "CUSTOM_ID_TYPE", - "name": "Custom Identifier Type for Testing", - "url": null - }, - "issuingBody": { - "technicalKey": "CUSTOM_ISSUE_BODY", - "name": "Custom Issuing Body for Testing", - "url": null - }, - "status": { - "technicalKey": "CUSTOM_ID_STATUS", - "name": "Custom Identifier Status for Testing" - } - } - ], - "names": [ - { - "value": "Name of Company", - "shortName": "NoC", - "type": { - "technicalKey": "ACRONYM", - "name": "An acronym commonly used for a business partner.", - "url": "" - }, - "language": { - "technicalKey": "en", - "name": "English" - } - } - ], - "legalForm": { - "technicalKey": "CUSTOM_LEGAL_FORM", - "name": "Custom Legal Form for Testing", - "url": null, - "mainAbbreviation": "CLF_0001", - "language": { - "technicalKey": "en", - "name": "English" - }, - "categories": [ - { - "name": "holding company", - "url": null - } - ] - }, - "status": { - "officialDenotation": "Active", - "validFrom": "2020-12-16T05:54:48.942", - "validUntil": null, - "type": { - "technicalKey": "ACTIVE", - "name": "Active", - "url": "" - } - }, - "profileClassifications": [ - { - "value": "Farming of cattle, dairy farming", - "code": "01.21", - "type": { - "name": "NACE", - "url": "" - } - } - ], - "types": [], - "bankAccounts": [ - { - "trustScores": [], - "currency": { - "technicalKey": "EUR", - "name": "Euro" - }, - "internationalBankAccountIdentifier": "11223445569", - "internationalBankIdentifier": "TEST1234", - "nationalBankAccountIdentifier": "004566676", - "nationalBankIdentifier": "TEST223" - } - ], - "roles": [], - "relations": [], - "currentness": "2023-05-08T12:02:38.289932Z" - } -] -``` - -### 2.4 Fetch sites for legal entity - -Scenario: The user enters a valid BPNL under pathparam and the API returns information about site legal entities. - -Flow: - -- The user inputs a valid BPNL in pathparam as shown in below GET api request. -- The Legal Entity Controller information about the legal entity sites as shown in response. -- The BPN in response are nothing but BPNS along with name of the site. -- The Legal Entity Controller provide details array of BPNS and name if more than one site is present. - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/legal-entities/BPNL000000000001/sites?page=0&size=10' -``` - -Response: - -```bash -{ - "totalElements": 2, - "totalPages": 1, - "page": 0, - "contentSize": 2, - "content": [ - { - "bpn": "BPNS000000000001", - "name": "Factory UT" - }, - { - "bpn": "BPNS0000000001YN", - "name": "Factory Sindelfingen" - } - ] -} -``` - -### 2.5 Fetch addresses for legal entity - -Scenario: The user enters a valid BPNL under pathparam and the API returns information about address partners legal entities. - -Flow: - -- The user inputs a valid BPNL in pathparam as shown in below GET api request. -- The Legal Entity Controller information about the legal entity address as shown in response. -- The BPN in response are nothing but BPNA along with number of other fields like version, careOf, contexts, country etc. -- The Legal Entity Controller provide details array of BPNA. - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/legal-entities/BPNL0000000001YN/addresses?page=0&size=10' -``` - -Response: - -```bash -{ - "totalElements": 1, - "totalPages": 1, - "page": 0, - "contentSize": 1, - "content": [ - { - "bpn": "BPNA0000000001YN", - "version": { - "characterSet": { - "technicalKey": "WESTERN_LATIN_STANDARD", - "name": "Western Latin Standard (ISO 8859-1; Latin-1)" - }, - "language": { - "technicalKey": "en", - "name": "English" - } - }, - "careOf": null, - "contexts": [], - "country": { - "technicalKey": "DE", - "name": "Germany" - }, - "administrativeAreas": [ - { - "value": "Baden-Wuerttemberg", - "shortName": "BW", - "fipsCode": "GM01", - "type": { - "technicalKey": "REGION", - "name": "Region", - "url": "" - }, - "language": { - "technicalKey": "en", - "name": "English" - } - } - ], - "postCodes": [ - { - "value": "80331", - "type": { - "technicalKey": "REGULAR", - "name": "Regular", - "url": "" - } - } - ], - "localities": [ - { - "value": "Bavaria", - "shortName": "B", - "type": { - "technicalKey": "CITY", - "name": "City", - "url": "" - }, - "language": { - "technicalKey": "en", - "name": "English" - } - } - ], - "thoroughfares": [ - { - "value": "Standort Strasse 10", - "name": "Standort Strasse", - "shortName": "Standort Str.", - "number": "10", - "direction": null, - "type": { - "technicalKey": "STREET", - "name": "Street", - "url": "" - }, - "language": { - "technicalKey": "en", - "name": "English" - } - } - ], - "premises": [], - "postalDeliveryPoints": [], - "geographicCoordinates": null, - "types": [ - { - "technicalKey": "UNSPECIFIC", - "name": "Unspecified", - "url": "" - } - ] - } - ] -} -``` - -## Use Case 3. Update data from Legal Entity and check changelog - -Description: This use case involves a user updating record for a legal entity business partner associated with a Business Partner Number (BPNL). Changelogs can be identified using business partner controller, it have one GET api request explained in below use case to show up the changelog details for provided BPN. - -The user can use an API call for the business partner controller, which retrieves the changelog for reuested BPNL. The business-partner-controller checks if there are any updates since the last update and fetches array of the updated data for the BPNL via the business partner controller if there are updates in provided date and time frame. The Legal Entity Controller can be use to update the legal entity. Similarly site controller and address controller can be used to update sites and address type business partners respectively. - -### 3.1 Get Changelog for BPNL via business-partner-controller - -Scenario: The user enters a valid BPN under query param and business partner controller api returns information about changelogs for legal entities and also filteration should be their to fetch changelog only after particular dates. - -Flow: - -- The user initiates a request to search for changelogs for a specific BPNL by providing BPN in api request. -- Here in example request, user has putted two query params named as bpn with value BPNL0000000001YN and modifiedAfter with value 2023-03-21T09:00:25.298594Z. -- The business-partner-controller returns the changelog for the BPNL entered. -- Also user can be filter data based on date named as Modified after paramter, The business-partner-controller checks if there are any updates since the last update. -- If there are updates, the business partner controller fetches the updated data for the BPNL. - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/business-partners/changelog?page=0&size=10&modifiedAfter=2023-03-21T09%3A00%3A25.298594Z&bpn=BPNL0000000001YN' -``` - -Response: - -```bash -{ - "totalElements": 2, - "totalPages": 1, - "page": 0, - "contentSize": 2, - "content": [ - { - "bpn": "BPNL0000000001YN", - "changelogType": "CREATE", - "timestamp": "2023-05-04T11:18:34.915176Z" - }, - { - "bpn": "BPNL0000000001YN", - "changelogType": "UPDATE", - "timestamp": "2023-05-08T12:02:38.323994Z" - } - ] -} -``` - -### 3.2 Changelog for update on business partner - -Scenario: Apply the changes or update on business partner of type legal entity, site and address through api request. Check changelog for each business partner. - -#### 3.2.1 Update Legal Entity - -Flow: - -- The user updates legal entity by hiting PUT api call as shown in request below. -- The legal entity controller updates business partner of type legal entity as per the provided request body. -- The Respone will be displayed to user with updated details for a message to the user that the legal entity data has been updated. - -Request: - -```bash -curl --location --request PUT 'http://localhost:8080/api/catena/legal-entities' \ ---header 'Content-Type: application/json' \ ---data '[ - { - "identifiers": [ - { - "value": "123456789", - "type": "CUSTOM_ID_TYPE", - "issuingBody": "CUSTOM_ISSUE_BODY", - "status": "CUSTOM_ID_STATUS" - } - ], - "names": [ - { - "value": "Name of Company Test", - "shortName": "NoC", - "type": "ACRONYM", - "language": "en" - } - ], - "legalForm": "CUSTOM_LEGAL_FORM", - "status": { - "officialDenotation": "Active", - "validFrom": "2020-12-16T05:54:48.942Z", - "type": "ACTIVE" - }, - "profileClassifications": [ - { - "value": "Farming of cattle, dairy farming", - "code": "01.21", - "type": "NACE" - } - ], - "bankAccounts": [ - { - "currency": "EUR", - "internationalBankAccountIdentifier": "11223445569", - "internationalBankIdentifier": "TEST1234", - "nationalBankAccountIdentifier": "004566676", - "nationalBankIdentifier": "TEST223" - } - ], - "legalAddress": { - "version": { - "characterSet": "WESTERN_LATIN_STANDARD", - "language": "en" - }, - "country": "DE", - "administrativeAreas": [ - { - "value": "Baden-Wuerttemberg", - "shortName": "BW", - "fipsCode": "GM01", - "type": "REGION" - } - ], - "postCodes": [ - { - "value": "70546", - "type": "REGULAR" - } - ], - "localities": [ - { - "value": "Stuttgart", - "shortName": "S", - "type": "CITY" - } - ], - "thoroughfares": [ - { - "value": "Stuttgarter Strasse 1", - "name": "Stuttgarter Strasse", - "shortName": "Stuttgarter Str.", - "number": "1", - "type": "STREET" - } - ], - "premises": [ - { - "value": "Building A", - "shortName": "A", - "number": "A", - "type": "BUILDING" - } - ], - "postalDeliveryPoints": [ - { - "value": "On-site Mailbox", - "type": "MAILBOX" - } - ], - "geographicCoordinates": { - "longitude": 0, - "latitude": 0, - "altitude": 0 - }, - "types": [ - "HEADQUARTER", - "REGISTERED" - ] - }, - "bpn": "BPNL000000000001" - }, - { - "identifiers": [ - { - "value": "987654321", - "type": "CUSTOM_ID_TYPE", - "issuingBody": "CUSTOM_ISSUE_BODY", - "status": "CUSTOM_ID_STATUS" - } - ], - "names": [ - { - "value": "Other Test Company", - "shortName": "OTC", - "type": "REGISTERED", - "language": "en" - } - ], - "legalForm": "CUSTOM_LEGAL_FORM", - "status": { - "officialDenotation": "Dissolved", - "validFrom": "2021-03-14T05:54:48.942Z", - "type": "DISSOLVED" - }, - "profileClassifications": [ - { - "value": "Warehousing and Storage", - "code": "49", - "type": "NAICS" - } - ], - "bankAccounts": [ - { - "currency": "EUR", - "internationalBankAccountIdentifier": "7654432212", - "internationalBankIdentifier": "TEST1234", - "nationalBankAccountIdentifier": "999847444", - "nationalBankIdentifier": "TEST223" - } - ], - "legalAddress": { - "version": { - "characterSet": "WESTERN_LATIN_STANDARD", - "language": "en" - }, - "country": "DE", - "administrativeAreas": [ - { - "value": "Bavaria", - "shortName": "B", - "fipsCode": "GM02", - "type": "REGION" - } - ], - "postCodes": [ - { - "value": "80331", - "type": "REGULAR" - } - ], - "localities": [ - { - "value": "Munich", - "shortName": "M", - "type": "CITY" - } - ], - "thoroughfares": [ - { - "value": "Muenchener Strasse 1", - "name": "Muenchener Strasse", - "shortName": "Munchener Str.", - "number": "1", - "type": "STREET" - } - ], - "premises": [ - { - "value": "Block 1", - "shortName": "B1", - "number": "1", - "type": "BUILDING" - } - ], - "postalDeliveryPoints": [ - { - "value": "On-site Mailbox", - "type": "MAILBOX" - } - ], - "geographicCoordinates": { - "longitude": 0, - "latitude": 0, - "altitude": 0 - }, - "types": [ - "HEADQUARTER", - "REGISTERED" - ] - }, - "bpn": "BPNL0000000001YN" - } -]' -``` - -#### 3.2.2 Update Site - -Flow: - -- The user updates site by hiting PUT api call as shown in request below. -- The site controller updates business partner of type site as per the provided request body. -- The Respone will be displayed to user with updated details for a message to the user that the site data has been updated. - -Request: - -```bash -curl --location --request PUT 'http://localhost:8080/api/catena/sites' \ ---header 'Content-Type: application/json' \ ---data '[ - { - "name": "Factory UT test", - "mainAddress": { - "version": { - "characterSet": "WESTERN_LATIN_STANDARD", - "language": "en" - }, - "country": "DE", - "administrativeAreas": [ - { - "value": "Baden-Wuerttemberg", - "shortName": "BW", - "fipsCode": "GM01", - "type": "REGION" - } - ], - "postCodes": [ - { - "value": "70327", - "type": "REGULAR" - } - ], - "localities": [ - { - "value": "Stuttgart", - "shortName": "S", - "type": "CITY" - } - ], - "thoroughfares": [ - { - "value": "Untertuerckheim Strasse 1", - "name": "Untertuerckheim Strasse", - "shortName": "Untertuerckheim Str.", - "number": "1", - "type": "STREET" - } - ], - "premises": [ - { - "value": "Gate 1", - "shortName": "G1", - "number": "1", - "type": "BUILDING" - } - ], - "types": [ - "UNSPECIFIC" - ] - }, - "bpn": "BPNS000000000001" - }, - { - "name": "Factory Sindelfingen", - "mainAddress": { - "version": { - "characterSet": "WESTERN_LATIN_STANDARD", - "language": "en" - }, - "country": "DE", - "administrativeAreas": [ - { - "value": "Baden-Wuerttemberg", - "shortName": "BW", - "fipsCode": "GM01", - "type": "REGION" - } - ], - "postCodes": [ - { - "value": "71034", - "type": "REGULAR" - } - ], - "localities": [ - { - "value": "Sindelfinden", - "shortName": "BB", - "type": "CITY" - } - ], - "thoroughfares": [ - { - "value": "Sindelfinger Strasse 1", - "name": "Sindelfinger Strasse", - "shortName": "Sindelfinger Str.", - "number": "1", - "type": "STREET" - } - ], - "premises": [ - { - "value": "Building 8", - "shortName": "G8", - "number": "8", - "type": "BUILDING" - } - ], - "types": [ - "UNSPECIFIC" - ] - }, - "bpn": "BPNS0000000001YN" - } -]' -``` - -#### 3.2.3 Update Addresses - -Flow: - -- The user updates address by hiting PUT api call as shown in request below. -- The address controller updates business partner of type address as per the provided request body. -- The Respone will be displayed to user with updated details for a message to the user that the address data has been updated. - -Request: - -```bash -curl --location --request PUT 'http://localhost:8080/api/catena/addresses' \ ---header 'Content-Type: application/json' \ ---data '[ - { - "version": { - "characterSet": "WESTERN_LATIN_STANDARD", - "language": "en" - }, - "country": "DE", - "administrativeAreas": [ - { - "value": "Baden-Wuerttemberg-test", - "shortName": "BW", - "fipsCode": "GM01", - "type": "REGION" - } - ], - "postCodes": [ - { - "value": "70327", - "type": "REGULAR" - } - ], - "localities": [ - { - "value": "Stuttgart", - "shortName": "S", - "type": "CITY" - } - ], - "thoroughfares": [ - { - "value": "Tor Strasse 1", - "name": "Tor Strasse", - "shortName": "Tor Str.", - "number": "1", - "type": "STREET" - } - ], - "premises": [ - { - "value": "Gate 1", - "shortName": "1", - "number": "1", - "type": "BUILDING" - } - ], - "types": [ - "UNSPECIFIC" - ], - "bpn": "BPNA000000000001" - }, - { - "version": { - "characterSet": "WESTERN_LATIN_STANDARD", - "language": "en" - }, - "country": "DE", - "administrativeAreas": [ - { - "value": "Baden-Wuerttemberg", - "shortName": "BW", - "fipsCode": "GM01", - "type": "REGION" - } - ], - "postCodes": [ - { - "value": "80331", - "type": "REGULAR" - } - ], - "localities": [ - { - "value": "Bavaria", - "shortName": "B", - "type": "CITY" - } - ], - "thoroughfares": [ - { - "value": "Standort Strasse 10", - "name": "Standort Strasse", - "shortName": "Standort Str.", - "number": "10", - "type": "STREET" - } - ], - "types": [ - "UNSPECIFIC" - ], - "bpn": "BPNA0000000001YN" - } -]' -``` - -Below api reuqest from business partner controller checks changelog on each business partner type and in response controller provide either business partner newly created or updated along with timestamp with filter on provided timestamp. Here, we have added filter for business partner type which we have updated in respective update flow. - -Request: - -```bash -curl --location 'http://localhost:8080/api/catena/business-partners/changelog?page=0&size=10&modifiedAfter=2023-03-21T09%3A00%3A25.298594Z&bpn=BPNL000000000001&bpn=BPNS000000000001&bpn=BPNA0000000001YN' -``` - -Response: - -```bash -{ - "totalElements": 10, - "totalPages": 1, - "page": 0, - "contentSize": 10, - "content": [ - { - "bpn": "BPNL000000000001", - "changelogType": "CREATE", - "timestamp": "2023-05-04T11:18:34.911829Z" - }, - { - "bpn": "BPNS000000000001", - "changelogType": "CREATE", - "timestamp": "2023-05-04T11:33:19.068153Z" - }, - { - "bpn": "BPNL000000000001", - "changelogType": "UPDATE", - "timestamp": "2023-05-08T12:02:38.323393Z" - }, - { - "bpn": "BPNA0000000001YN", - "changelogType": "CREATE", - "timestamp": "2023-05-08T12:41:28.431110Z" - }, - { - "bpn": "BPNA0000000001YN", - "changelogType": "UPDATE", - "timestamp": "2023-05-08T12:41:44.772685Z" - }, - { - "bpn": "BPNL000000000001", - "changelogType": "UPDATE", - "timestamp": "2023-05-09T05:13:36.308001Z" - }, - { - "bpn": "BPNA0000000001YN", - "changelogType": "UPDATE", - "timestamp": "2023-05-09T05:18:45.536015Z" - }, - { - "bpn": "BPNS000000000001", - "changelogType": "UPDATE", - "timestamp": "2023-05-09T05:23:13.258840Z" - }, - { - "bpn": "BPNA0000000001YN", - "changelogType": "UPDATE", - "timestamp": "2023-05-09T06:11:08.272858Z" - }, - { - "bpn": "BPNA0000000001YN", - "changelogType": "UPDATE", - "timestamp": "2023-05-09T06:11:21.191976Z" - } - ] -} -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate.info.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate.info.mdx deleted file mode 100644 index 63f66ac9b43..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: business-partner-data-management-gate -title: "Business Partner Data Management Gate" -description: "A gate for a member to share business partner data with CatenaX" -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 - -# Business Partner Data Management Gate - - - -A gate for a member to share business partner data with CatenaX - - - \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/determine-lsa-type.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/determine-lsa-type.api.mdx deleted file mode 100644 index 4da94c73ed6..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/determine-lsa-type.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: determine-lsa-type -title: "Determine the LSA type of a business partner candidate" -description: "For one business partner candidate this request determines its likely type of either legal entity, site or address.It is possible that no type could be determined.The candidate needs to contain either a name or an identifier as a minimum requirement." -sidebar_label: "Determine the LSA type of a business partner candidate" -hide_title: true -hide_table_of_contents: true -api: {"tags":["business-partner-controller"],"description":"For one business partner candidate this request determines its likely type of either legal entity, site or address.It is possible that no type could be determined.The candidate needs to contain either a name or an identifier as a minimum requirement.","operationId":"determineLsaType","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"},"status":{"type":"string"}},"description":"Identifier record for a business partner"}},"names":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["ACRONYM","DOING_BUSINESS_AS","ESTABLISHMENT","INTERNATIONAL","LOCAL","OTHER","REGISTERED","TRANSLITERATED","VAT_REGISTERED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Name record for a business partner"}},"legalForm":{"type":"string"},"status":{"type":"object","properties":{"officialDenotation":{"type":"string"},"validFrom":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","DISSOLVED","IN_LIQUIDATION","INACTIVE","INSOLVENCY","UNKNOWN"]}},"description":"Status record for a business partner"},"profileClassifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"code":{"type":"string"},"type":{"type":"string","enum":["NACE","NAF","NAICS","SIC"]}},"description":"Classification record for a business partner"}},"bankAccounts":{"type":"array","items":{"type":"object","properties":{"trustScores":{"type":"array","items":{"type":"number","format":"float"}},"currency":{"type":"string","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"internationalBankAccountIdentifier":{"type":"string"},"internationalBankIdentifier":{"type":"string"},"nationalBankAccountIdentifier":{"type":"string"},"nationalBankIdentifier":{"type":"string"}},"description":"Bank account record of a business partner"}},"address":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}}},"description":"Localized address record for a business partner"}}}}},"required":true},"responses":{"200":{"description":"Records were successfully processed.","content":{"*/*":{"schema":{"type":"object","properties":{"score":{"type":"number","format":"float"},"type":{"type":"string","enum":["LegalEntity","Site","Address","None"]}}}}}},"400":{"description":"No name and no identifier given, or malformed request"}},"method":"post","path":"/api/catena/business-partners/type-match","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":{"identifiers":[{"value":"string","type":"string","issuingBody":"string","status":"string"}],"names":[{"value":"string","shortName":"string","type":"ACRONYM","language":"undefined"}],"legalForm":"string","status":{"officialDenotation":"string","validFrom":"2023-05-31","validUntil":"2023-05-31","type":"ACTIVE"},"profileClassifications":[{"value":"string","code":"string","type":"NACE"}],"bankAccounts":[{"trustScores":[0],"currency":"UNDEFINED","internationalBankAccountIdentifier":"string","internationalBankIdentifier":"string","nationalBankAccountIdentifier":"string","nationalBankIdentifier":"string"}],"address":{"version":{"characterSet":"ARABIC","language":"undefined"},"careOf":"string","contexts":["string"],"country":"UNDEFINED","administrativeAreas":[{"value":"string","shortName":"string","fipsCode":"string","type":"COUNTY"}],"postCodes":[{"value":"string","type":"CEDEX"}],"localities":[{"value":"string","shortName":"string","type":"BLOCK"}],"thoroughfares":[{"value":"string","name":"string","shortName":"string","number":"string","direction":"string","type":"INDUSTRIAL_ZONE"}],"premises":[{"value":"string","shortName":"string","number":"string","type":"BUILDING"}],"postalDeliveryPoints":[{"value":"string","shortName":"string","number":"string","type":"INTERURBAN_DELIVERY_POINT"}],"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"types":["BRANCH_OFFICE"]}},"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0"},"postman":{"name":"Determine the LSA type of a business partner candidate","description":{"content":"For one business partner candidate this request determines its likely type of either legal entity, site or address.It is possible that no type could be determined.The candidate needs to contain either a name or an identifier as a minimum requirement.","type":"text/plain"},"url":{"path":["api","catena","business-partners","type-match"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Determine the LSA type of a business partner candidate - - - -For one business partner candidate this request determines its likely type of either legal entity, site or address.It is possible that no type could be determined.The candidate needs to contain either a name or an identifier as a minimum requirement. - -
Request Body required
    identifiers object[]
    names object[]
    status object
    - -Status record for a business partner - -
    profileClassifications object[]
    bankAccounts object[]
    address object
    - -Localized address record for a business partner - -
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -Records were successfully processed. - -
Schema
- -No name and no identifier given, or malformed request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-address-by-external-id.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-address-by-external-id.api.mdx deleted file mode 100644 index 798d319c8de..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-address-by-external-id.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-address-by-external-id -title: "Get address by external identifier" -description: "Get address by external identifier." -sidebar_label: "Get address by external identifier" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Get address by external identifier.","operationId":"getAddressByExternalId","parameters":[{"name":"externalId","in":"path","description":"External identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found address with external identifier","content":{"*/*":{"schema":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"},"processStartedAt":{"type":"string","format":"date-time"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."}}}},"404":{"description":"No address found under specified external identifier"}},"method":"get","path":"/api/catena/input/addresses/{externalId}","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0"},"postman":{"name":"Get address by external identifier","description":{"content":"Get address by external identifier.","type":"text/plain"},"url":{"path":["api","catena","input","addresses",":externalId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) External identifier","type":"text/plain"},"type":"any","value":"","key":"externalId"}]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get address by external identifier - - - -Get address by external identifier. - -
Path Parameters
- -Found address with external identifier - -
Schema
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -No address found under specified external identifier - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-output.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-output.api.mdx deleted file mode 100644 index 89842ee2c42..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-output.api.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -id: get-addresses-output -title: "Get page of addresses" -description: "Get page of addresses. Can optionally be filtered by external ids." -sidebar_label: "Get page of addresses" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Get page of addresses. Can optionally be filtered by external ids.","operationId":"getAddressesOutput","parameters":[{"name":"startAfter","in":"query","description":"Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":1,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"The requested page of addresses","content":{"*/*":{"schema":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"nextStartAfter":{"type":"string"},"content":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string"},"version":{"type":"object","properties":{"characterSet":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Localization record of an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["COUNTY","REGION","OTHER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Area of an address such as country region or county"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Postcode record of an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Locality record of an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Thoroughfare record of an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Premise record of an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Postal delivery point record of an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]},"name":{"type":"string"},"url":{"type":"string"}}}},"externalId":{"type":"string"},"legalEntityBpn":{"type":"string"},"siteBpn":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."}},"invalidEntries":{"type":"integer","format":"int32"},"pending":{"type":"array","items":{"type":"string"}},"errors":{"type":"array","items":{"title":"ErrorInfo","type":"object","properties":{"errorCode":{"type":"string","description":"BusinessPartnerOutputError","enum":["SharingProcessError","SharingTimeout","BpnNotInPool"]},"message":{"type":"string"},"entityKey":{"type":"string"}},"description":"Holds information about failures"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/api/catena/output/addresses/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0"},"postman":{"name":"Get page of addresses","description":{"content":"Get page of addresses. Can optionally be filtered by external ids.","type":"text/plain"},"url":{"path":["api","catena","output","addresses","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages.","type":"text/plain"},"key":"startAfter","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of addresses - - - -Get page of addresses. Can optionally be filtered by external ids. - -
Query Parameters
Request Body array
  • string
- -The requested page of addresses - -
Schema
    content object[]
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
    errors object[]
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-addresses.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-addresses.api.mdx deleted file mode 100644 index a8cd5bc50e7..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-addresses.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-addresses -title: "Get page of addresses" -description: "Get page of addresses." -sidebar_label: "Get page of addresses" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Get page of addresses.","operationId":"getAddresses","parameters":[{"name":"startAfter","in":"query","description":"Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":1,"type":"string","default":"10"}}],"responses":{"200":{"description":"The requested page of addresses","content":{"*/*":{"schema":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"nextStartAfter":{"type":"string"},"content":{"type":"array","items":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"},"processStartedAt":{"type":"string","format":"date-time"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."}},"invalidEntries":{"type":"integer","format":"int32"}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"get","path":"/api/catena/input/addresses","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0"},"postman":{"name":"Get page of addresses","description":{"content":"Get page of addresses.","type":"text/plain"},"url":{"path":["api","catena","input","addresses"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages.","type":"text/plain"},"key":"startAfter","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of addresses - - - -Get page of addresses. - -
Query Parameters
- -The requested page of addresses - -
Schema
    content object[]
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-output.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-output.api.mdx deleted file mode 100644 index 78a201b53f8..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-output.api.mdx +++ /dev/null @@ -1,118 +0,0 @@ ---- -id: get-legal-entities-output -title: "Get page of legal entities" -description: "Get page of legal entities. Can optionally be filtered by external ids." -sidebar_label: "Get page of legal entities" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Get page of legal entities. Can optionally be filtered by external ids.","operationId":"getLegalEntitiesOutput","parameters":[{"name":"startAfter","in":"query","description":"Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":1,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"The requested page of legal entities","content":{"*/*":{"schema":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"nextStartAfter":{"type":"string"},"content":{"type":"array","items":{"type":"object","properties":{"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"issuingBody":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"status":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a business partner"}},"names":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACRONYM","DOING_BUSINESS_AS","ESTABLISHMENT","INTERNATIONAL","LOCAL","OTHER","REGISTERED","TRANSLITERATED","VAT_REGISTERED"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Name record of a business partner"}},"legalForm":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"mainAbbreviation":{"type":"string"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}}},"description":"Legal form a business partner can have"},"status":{"type":"object","properties":{"officialDenotation":{"type":"string"},"validFrom":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","DISSOLVED","IN_LIQUIDATION","INACTIVE","INSOLVENCY","UNKNOWN"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Status of a business partner"},"profileClassifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"code":{"type":"string"},"type":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}},"description":"Classification record of a business partner"}},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRAND","LEGAL_ENTITY","ORGANIZATIONAL_UNIT","SITE","UNKNOWN"]},"name":{"type":"string"},"url":{"type":"string"}}}},"bankAccounts":{"type":"array","items":{"type":"object","properties":{"trustScores":{"type":"array","items":{"type":"number","format":"float"}},"currency":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"internationalBankAccountIdentifier":{"type":"string"},"internationalBankIdentifier":{"type":"string"},"nationalBankAccountIdentifier":{"type":"string"},"nationalBankIdentifier":{"type":"string"}},"description":"Bank account record for a business partner"}},"roles":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"relations":{"type":"array","items":{"type":"object","properties":{"relationClass":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["SAAS_HIERARCHY","SAAS_TRANSITION","CX_HIERARCHY","DNB_HIERARCHY","LEI_HIERARCHY"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF","CX_ADDRESS_OF","CX_SITE_OF","CX_OWNED_BY","DIRECT_LEGAL_RELATION","COMMERCIAL_ULTIMATE","DOMESTIC_BRANCH_RELATION","INTERNATIONAL_BRANCH_RELATION","DOMESTIC_LEGAL_ULTIMATE_RELATION","GLOBAL_LEGAL_ULTIMATE_RELATION","LEGAL_PREDECESSOR","LEGAL_SUCCESSOR","DNB_PARENT","DNB_HEADQUARTER","DNB_DOMESTIC_ULTIMATE","DNB_GLOBAL_ULTIMATE","LEI_DIRECT_PARENT","LEI_INTERNATIONAL_BRANCH","LEI_ULTIMATE_PARENT"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"startNode":{"type":"string"},"endNode":{"type":"string"},"startedAt":{"type":"string","format":"date-time"},"endedAt":{"type":"string","format":"date-time"}},"description":"Directed relation between two business partners"}},"legalAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Localization record of an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["COUNTY","REGION","OTHER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Area of an address such as country region or county"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Postcode record of an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Locality record of an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Thoroughfare record of an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Premise record of an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Postal delivery point record of an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]},"name":{"type":"string"},"url":{"type":"string"}}}}},"description":"Localized address record of a business partner"},"bpn":{"type":"string"},"externalId":{"type":"string"}},"description":"Legal entity with references"}},"invalidEntries":{"type":"integer","format":"int32"},"pending":{"type":"array","items":{"type":"string"}},"errors":{"type":"array","items":{"title":"ErrorInfo","type":"object","properties":{"errorCode":{"type":"string","description":"BusinessPartnerOutputError","enum":["SharingProcessError","SharingTimeout","BpnNotInPool"]},"message":{"type":"string"},"entityKey":{"type":"string"}},"description":"Holds information about failures"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/api/catena/output/legal-entities/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0"},"postman":{"name":"Get page of legal entities","description":{"content":"Get page of legal entities. Can optionally be filtered by external ids.","type":"text/plain"},"url":{"path":["api","catena","output","legal-entities","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages.","type":"text/plain"},"key":"startAfter","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of legal entities - - - -Get page of legal entities. Can optionally be filtered by external ids. - -
Query Parameters
Request Body array
  • string
- -The requested page of legal entities - -
Schema
    content object[]
    identifiers object[]
    type object
    issuingBody object
    status object
    - -Named type uniquely identified by its technical key - -
    names object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    legalForm object
    - -Legal form a business partner can have - -
    language object
    - -Named type uniquely identified by its technical key - -
    categories object[]
    status object
    - -Status of a business partner - -
    type object
    profileClassifications object[]
    type object
    - -General type with name and URL link for further information - -
    types object[]
    bankAccounts object[]
    currency object
    - -Named type uniquely identified by its technical key - -
    roles object[]
    relations object[]
    relationClass object
    - -Named type uniquely identified by its technical key - -
    type object
    - -Named type uniquely identified by its technical key - -
    legalAddress object
    - -Localized address record of a business partner - -
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
    errors object[]
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities.api.mdx deleted file mode 100644 index 55501594313..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: get-legal-entities -title: "Get page of legal entities" -description: "Get page of legal entities." -sidebar_label: "Get page of legal entities" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Get page of legal entities.","operationId":"getLegalEntities","parameters":[{"name":"startAfter","in":"query","description":"Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":1,"type":"string","default":"10"}}],"responses":{"200":{"description":"The requested page of legal entities","content":{"*/*":{"schema":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"nextStartAfter":{"type":"string"},"content":{"type":"array","items":{"type":"object","properties":{"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"},"status":{"type":"string"}},"description":"Identifier record for a business partner"}},"names":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["ACRONYM","DOING_BUSINESS_AS","ESTABLISHMENT","INTERNATIONAL","LOCAL","OTHER","REGISTERED","TRANSLITERATED","VAT_REGISTERED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Name record for a business partner"}},"legalForm":{"type":"string"},"status":{"type":"object","properties":{"officialDenotation":{"type":"string"},"validFrom":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","DISSOLVED","IN_LIQUIDATION","INACTIVE","INSOLVENCY","UNKNOWN"]}},"description":"Status record for a business partner"},"profileClassifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"code":{"type":"string"},"type":{"type":"string","enum":["NACE","NAF","NAICS","SIC"]}},"description":"Classification record for a business partner"}},"types":{"type":"array","items":{"type":"string","enum":["BRAND","LEGAL_ENTITY","ORGANIZATIONAL_UNIT","SITE","UNKNOWN"]}},"bankAccounts":{"type":"array","items":{"type":"object","properties":{"trustScores":{"type":"array","items":{"type":"number","format":"float"}},"currency":{"type":"string","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"internationalBankAccountIdentifier":{"type":"string"},"internationalBankIdentifier":{"type":"string"},"nationalBankAccountIdentifier":{"type":"string"},"nationalBankIdentifier":{"type":"string"}},"description":"Bank account record of a business partner"}},"legalAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}}},"description":"Localized address record for a business partner"},"externalId":{"type":"string"},"bpn":{"type":"string"},"processStartedAt":{"type":"string","format":"date-time"}},"description":"Legal entity with external id"}},"invalidEntries":{"type":"integer","format":"int32"}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"get","path":"/api/catena/input/legal-entities","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0"},"postman":{"name":"Get page of legal entities","description":{"content":"Get page of legal entities.","type":"text/plain"},"url":{"path":["api","catena","input","legal-entities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages.","type":"text/plain"},"key":"startAfter","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of legal entities - - - -Get page of legal entities. - -
Query Parameters
- -The requested page of legal entities - -
Schema
    content object[]
    identifiers object[]
    names object[]
    status object
    - -Status record for a business partner - -
    profileClassifications object[]
    bankAccounts object[]
    legalAddress object
    - -Localized address record for a business partner - -
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entity-by-external-id.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entity-by-external-id.api.mdx deleted file mode 100644 index 3d41a0ee69e..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entity-by-external-id.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: get-legal-entity-by-external-id -title: "Get legal entity by external identifier" -description: "Get legal entity by external identifier." -sidebar_label: "Get legal entity by external identifier" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Get legal entity by external identifier.","operationId":"getLegalEntityByExternalId","parameters":[{"name":"externalId","in":"path","description":"External identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found legal entity with external identifier","content":{"*/*":{"schema":{"type":"object","properties":{"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"},"status":{"type":"string"}},"description":"Identifier record for a business partner"}},"names":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["ACRONYM","DOING_BUSINESS_AS","ESTABLISHMENT","INTERNATIONAL","LOCAL","OTHER","REGISTERED","TRANSLITERATED","VAT_REGISTERED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Name record for a business partner"}},"legalForm":{"type":"string"},"status":{"type":"object","properties":{"officialDenotation":{"type":"string"},"validFrom":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","DISSOLVED","IN_LIQUIDATION","INACTIVE","INSOLVENCY","UNKNOWN"]}},"description":"Status record for a business partner"},"profileClassifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"code":{"type":"string"},"type":{"type":"string","enum":["NACE","NAF","NAICS","SIC"]}},"description":"Classification record for a business partner"}},"types":{"type":"array","items":{"type":"string","enum":["BRAND","LEGAL_ENTITY","ORGANIZATIONAL_UNIT","SITE","UNKNOWN"]}},"bankAccounts":{"type":"array","items":{"type":"object","properties":{"trustScores":{"type":"array","items":{"type":"number","format":"float"}},"currency":{"type":"string","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"internationalBankAccountIdentifier":{"type":"string"},"internationalBankIdentifier":{"type":"string"},"nationalBankAccountIdentifier":{"type":"string"},"nationalBankIdentifier":{"type":"string"}},"description":"Bank account record of a business partner"}},"legalAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}}},"description":"Localized address record for a business partner"},"externalId":{"type":"string"},"bpn":{"type":"string"},"processStartedAt":{"type":"string","format":"date-time"}},"description":"Legal entity with external id"}}}},"404":{"description":"No legal entity found under specified external identifier"}},"method":"get","path":"/api/catena/input/legal-entities/{externalId}","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0"},"postman":{"name":"Get legal entity by external identifier","description":{"content":"Get legal entity by external identifier.","type":"text/plain"},"url":{"path":["api","catena","input","legal-entities",":externalId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) External identifier","type":"text/plain"},"type":"any","value":"","key":"externalId"}]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get legal entity by external identifier - - - -Get legal entity by external identifier. - -
Path Parameters
- -Found legal entity with external identifier - -
Schema
    identifiers object[]
    names object[]
    status object
    - -Status record for a business partner - -
    profileClassifications object[]
    bankAccounts object[]
    legalAddress object
    - -Localized address record for a business partner - -
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -No legal entity found under specified external identifier - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-site-by-external-id.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-site-by-external-id.api.mdx deleted file mode 100644 index 6a49739cb45..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-site-by-external-id.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: get-site-by-external-id -title: "Get site by external identifier" -description: "Get site by external identifier." -sidebar_label: "Get site by external identifier" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Get site by external identifier.","operationId":"getSiteByExternalId","parameters":[{"name":"externalId","in":"path","description":"External identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found site with external identifier","content":{"*/*":{"schema":{"type":"object","properties":{"name":{"type":"string"},"mainAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}}},"description":"Localized address record for a business partner"},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"bpn":{"type":"string"},"processStartedAt":{"type":"string","format":"date-time"}},"description":"Site with legal entity reference"}}}},"404":{"description":"No site found under specified external identifier"}},"method":"get","path":"/api/catena/input/sites/{externalId}","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0"},"postman":{"name":"Get site by external identifier","description":{"content":"Get site by external identifier.","type":"text/plain"},"url":{"path":["api","catena","input","sites",":externalId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) External identifier","type":"text/plain"},"type":"any","value":"","key":"externalId"}]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get site by external identifier - - - -Get site by external identifier. - -
Path Parameters
- -Found site with external identifier - -
Schema
    mainAddress object
    - -Localized address record for a business partner - -
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -No site found under specified external identifier - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-sites-output.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-sites-output.api.mdx deleted file mode 100644 index e9cb60af3b0..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-sites-output.api.mdx +++ /dev/null @@ -1,82 +0,0 @@ ---- -id: get-sites-output -title: "Get page of sites" -description: "Get page of sites. Can optionally be filtered by external ids." -sidebar_label: "Get page of sites" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Get page of sites. Can optionally be filtered by external ids.","operationId":"getSitesOutput","parameters":[{"name":"startAfter","in":"query","description":"Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":1,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"The requested page of sites","content":{"*/*":{"schema":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"nextStartAfter":{"type":"string"},"content":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"mainAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Localization record of an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["COUNTY","REGION","OTHER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Area of an address such as country region or county"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Postcode record of an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Locality record of an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Thoroughfare record of an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Premise record of an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Postal delivery point record of an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]},"name":{"type":"string"},"url":{"type":"string"}}}}},"description":"Localized address record of a business partner"},"externalId":{"type":"string"},"bpn":{"type":"string"},"legalEntityBpn":{"type":"string"}},"description":"Site with legal entity reference."}},"invalidEntries":{"type":"integer","format":"int32"},"pending":{"type":"array","items":{"type":"string"}},"errors":{"type":"array","items":{"title":"ErrorInfo","type":"object","properties":{"errorCode":{"type":"string","description":"BusinessPartnerOutputError","enum":["SharingProcessError","SharingTimeout","BpnNotInPool"]},"message":{"type":"string"},"entityKey":{"type":"string"}},"description":"Holds information about failures"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/api/catena/output/sites/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0"},"postman":{"name":"Get page of sites","description":{"content":"Get page of sites. Can optionally be filtered by external ids.","type":"text/plain"},"url":{"path":["api","catena","output","sites","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages.","type":"text/plain"},"key":"startAfter","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of sites - - - -Get page of sites. Can optionally be filtered by external ids. - -
Query Parameters
Request Body array
  • string
- -The requested page of sites - -
Schema
    content object[]
    mainAddress object
    - -Localized address record of a business partner - -
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
    errors object[]
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-sites.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-sites.api.mdx deleted file mode 100644 index 03ef90e4ee5..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/get-sites.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: get-sites -title: "Get page of sites" -description: "Get page of sites." -sidebar_label: "Get page of sites" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Get page of sites.","operationId":"getSites","parameters":[{"name":"startAfter","in":"query","description":"Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":1,"type":"string","default":"10"}}],"responses":{"200":{"description":"The requested page of sites","content":{"*/*":{"schema":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"nextStartAfter":{"type":"string"},"content":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"mainAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}}},"description":"Localized address record for a business partner"},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"bpn":{"type":"string"},"processStartedAt":{"type":"string","format":"date-time"}},"description":"Site with legal entity reference"}},"invalidEntries":{"type":"integer","format":"int32"}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"get","path":"/api/catena/input/sites","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0"},"postman":{"name":"Get page of sites","description":{"content":"Get page of sites.","type":"text/plain"},"url":{"path":["api","catena","input","sites"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages.","type":"text/plain"},"key":"startAfter","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of sites - - - -Get page of sites. - -
Query Parameters
- -The requested page of sites - -
Schema
    content object[]
    mainAddress object
    - -Localized address record for a business partner - -
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/sidebar.js deleted file mode 100644 index cfe685fdb36..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate"},{"type":"category","label":"site-controller","link":{"type":"generated-index","title":"site-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/site-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-sites","label":"Get page of sites","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites","label":"Create or update sites.","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-sites-output","label":"Get page of sites","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/validate-site","label":"Validate a site","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-site-by-external-id","label":"Get site by external identifier","className":"api-method get"}]},{"type":"category","label":"legal-entity-controller","link":{"type":"generated-index","title":"legal-entity-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/legal-entity-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities","label":"Get page of legal entities","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities","label":"Create or update legal entities.","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-output","label":"Get page of legal entities","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/validate-legal-entity","label":"Validate a legal entity","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entity-by-external-id","label":"Get legal entity by external identifier","className":"api-method get"}]},{"type":"category","label":"address-controller","link":{"type":"generated-index","title":"address-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/address-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-addresses","label":"Get page of addresses","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/upsert-addresses","label":"Create or update addresses.","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-output","label":"Get page of addresses","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/validate-site-1","label":"Validate an address partner","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-address-by-external-id","label":"Get address by external identifier","className":"api-method get"}]},{"type":"category","label":"business-partner-controller","link":{"type":"generated-index","title":"business-partner-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/determine-lsa-type","label":"Determine the LSA type of a business partner candidate","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/upsert-addresses.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/upsert-addresses.api.mdx deleted file mode 100644 index 3957038b62f..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/upsert-addresses.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: upsert-addresses -title: "Create or update addresses." -description: "Create or update addresses. Updates instead of creating a new address if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of addresses in the request is limited to 100 entries." -sidebar_label: "Create or update addresses." -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Create or update addresses. Updates instead of creating a new address if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of addresses in the request is limited to 100 entries.","operationId":"upsertAddresses","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."}}}},"required":true},"responses":{"200":{"description":"Addresses were successfully updated or created","content":{"*/*":{"schema":{"type":"object"}}}},"400":{"description":"On malformed address request"}},"method":"put","path":"/api/catena/input/addresses","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":[{"version":{"characterSet":"ARABIC","language":"undefined"},"careOf":"string","contexts":["string"],"country":"UNDEFINED","administrativeAreas":[{"value":"string","shortName":"string","fipsCode":"string","type":"COUNTY"}],"postCodes":[{"value":"string","type":"CEDEX"}],"localities":[{"value":"string","shortName":"string","type":"BLOCK"}],"thoroughfares":[{"value":"string","name":"string","shortName":"string","number":"string","direction":"string","type":"INDUSTRIAL_ZONE"}],"premises":[{"value":"string","shortName":"string","number":"string","type":"BUILDING"}],"postalDeliveryPoints":[{"value":"string","shortName":"string","number":"string","type":"INTERURBAN_DELIVERY_POINT"}],"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"types":["BRANCH_OFFICE"],"externalId":"string","legalEntityExternalId":"string","siteExternalId":"string","bpn":"string"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0"},"postman":{"name":"Create or update addresses.","description":{"content":"Create or update addresses. Updates instead of creating a new address if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of addresses in the request is limited to 100 entries.","type":"text/plain"},"url":{"path":["api","catena","input","addresses"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create or update addresses. - - - -Create or update addresses. Updates instead of creating a new address if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of addresses in the request is limited to 100 entries. - -
Request Body array required
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -Addresses were successfully updated or created - -
Schema
  • object
- -On malformed address request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities.api.mdx deleted file mode 100644 index b17226235c8..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: upsert-legal-entities -title: "Create or update legal entities." -description: "Create or update legal entities. Updates instead of creating a new legal entity if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of legal entities in the request is limited to 100 entries." -sidebar_label: "Create or update legal entities." -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Create or update legal entities. Updates instead of creating a new legal entity if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of legal entities in the request is limited to 100 entries.","operationId":"upsertLegalEntities","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"},"status":{"type":"string"}},"description":"Identifier record for a business partner"}},"names":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["ACRONYM","DOING_BUSINESS_AS","ESTABLISHMENT","INTERNATIONAL","LOCAL","OTHER","REGISTERED","TRANSLITERATED","VAT_REGISTERED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Name record for a business partner"}},"legalForm":{"type":"string"},"status":{"type":"object","properties":{"officialDenotation":{"type":"string"},"validFrom":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","DISSOLVED","IN_LIQUIDATION","INACTIVE","INSOLVENCY","UNKNOWN"]}},"description":"Status record for a business partner"},"profileClassifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"code":{"type":"string"},"type":{"type":"string","enum":["NACE","NAF","NAICS","SIC"]}},"description":"Classification record for a business partner"}},"types":{"type":"array","items":{"type":"string","enum":["BRAND","LEGAL_ENTITY","ORGANIZATIONAL_UNIT","SITE","UNKNOWN"]}},"bankAccounts":{"type":"array","items":{"type":"object","properties":{"trustScores":{"type":"array","items":{"type":"number","format":"float"}},"currency":{"type":"string","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"internationalBankAccountIdentifier":{"type":"string"},"internationalBankIdentifier":{"type":"string"},"nationalBankAccountIdentifier":{"type":"string"},"nationalBankIdentifier":{"type":"string"}},"description":"Bank account record of a business partner"}},"legalAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}}},"description":"Localized address record for a business partner"},"externalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Legal entity with external id"}}}},"required":true},"responses":{"200":{"description":"Legal entities were successfully updated or created","content":{"*/*":{"schema":{"type":"object"}}}},"400":{"description":"On malformed legal entity request"}},"method":"put","path":"/api/catena/input/legal-entities","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":[{"identifiers":[{"value":"string","type":"string","issuingBody":"string","status":"string"}],"names":[{"value":"string","shortName":"string","type":"ACRONYM","language":"undefined"}],"legalForm":"string","status":{"officialDenotation":"string","validFrom":"2023-05-31","validUntil":"2023-05-31","type":"ACTIVE"},"profileClassifications":[{"value":"string","code":"string","type":"NACE"}],"types":["BRAND"],"bankAccounts":[{"trustScores":[0],"currency":"UNDEFINED","internationalBankAccountIdentifier":"string","internationalBankIdentifier":"string","nationalBankAccountIdentifier":"string","nationalBankIdentifier":"string"}],"legalAddress":{"version":{"characterSet":"ARABIC","language":"undefined"},"careOf":"string","contexts":["string"],"country":"UNDEFINED","administrativeAreas":[{"value":"string","shortName":"string","fipsCode":"string","type":"COUNTY"}],"postCodes":[{"value":"string","type":"CEDEX"}],"localities":[{"value":"string","shortName":"string","type":"BLOCK"}],"thoroughfares":[{"value":"string","name":"string","shortName":"string","number":"string","direction":"string","type":"INDUSTRIAL_ZONE"}],"premises":[{"value":"string","shortName":"string","number":"string","type":"BUILDING"}],"postalDeliveryPoints":[{"value":"string","shortName":"string","number":"string","type":"INTERURBAN_DELIVERY_POINT"}],"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"types":["BRANCH_OFFICE"]},"externalId":"string","bpn":"string"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0"},"postman":{"name":"Create or update legal entities.","description":{"content":"Create or update legal entities. Updates instead of creating a new legal entity if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of legal entities in the request is limited to 100 entries.","type":"text/plain"},"url":{"path":["api","catena","input","legal-entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create or update legal entities. - - - -Create or update legal entities. Updates instead of creating a new legal entity if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of legal entities in the request is limited to 100 entries. - -
Request Body array required
    identifiers object[]
    names object[]
    status object
    - -Status record for a business partner - -
    profileClassifications object[]
    bankAccounts object[]
    legalAddress object
    - -Localized address record for a business partner - -
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -Legal entities were successfully updated or created - -
Schema
  • object
- -On malformed legal entity request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites.api.mdx deleted file mode 100644 index edb0bc37f09..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: upsert-sites -title: "Create or update sites." -description: "Create or update sites. Updates instead of creating a new site if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of sites in the request is limited to 100 entries." -sidebar_label: "Create or update sites." -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Create or update sites. Updates instead of creating a new site if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of sites in the request is limited to 100 entries.","operationId":"upsertSites","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"mainAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}}},"description":"Localized address record for a business partner"},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Site with legal entity reference"}}}},"required":true},"responses":{"200":{"description":"Sites were successfully updated or created","content":{"*/*":{"schema":{"type":"object"}}}},"400":{"description":"On malformed site request"}},"method":"put","path":"/api/catena/input/sites","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":[{"name":"string","mainAddress":{"version":{"characterSet":"ARABIC","language":"undefined"},"careOf":"string","contexts":["string"],"country":"UNDEFINED","administrativeAreas":[{"value":"string","shortName":"string","fipsCode":"string","type":"COUNTY"}],"postCodes":[{"value":"string","type":"CEDEX"}],"localities":[{"value":"string","shortName":"string","type":"BLOCK"}],"thoroughfares":[{"value":"string","name":"string","shortName":"string","number":"string","direction":"string","type":"INDUSTRIAL_ZONE"}],"premises":[{"value":"string","shortName":"string","number":"string","type":"BUILDING"}],"postalDeliveryPoints":[{"value":"string","shortName":"string","number":"string","type":"INTERURBAN_DELIVERY_POINT"}],"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"types":["BRANCH_OFFICE"]},"externalId":"string","legalEntityExternalId":"string","bpn":"string"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0"},"postman":{"name":"Create or update sites.","description":{"content":"Create or update sites. Updates instead of creating a new site if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of sites in the request is limited to 100 entries.","type":"text/plain"},"url":{"path":["api","catena","input","sites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create or update sites. - - - -Create or update sites. Updates instead of creating a new site if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of sites in the request is limited to 100 entries. - -
Request Body array required
    mainAddress object
    - -Localized address record for a business partner - -
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -Sites were successfully updated or created - -
Schema
  • object
- -On malformed site request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/validate-legal-entity.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/validate-legal-entity.api.mdx deleted file mode 100644 index c1926d24af5..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/validate-legal-entity.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: validate-legal-entity -title: "Validate a legal entity" -description: "Determines errors in a legal entity record which keep it from entering the sharing process" -sidebar_label: "Validate a legal entity" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Determines errors in a legal entity record which keep it from entering the sharing process","operationId":"validateLegalEntity","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"},"status":{"type":"string"}},"description":"Identifier record for a business partner"}},"names":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["ACRONYM","DOING_BUSINESS_AS","ESTABLISHMENT","INTERNATIONAL","LOCAL","OTHER","REGISTERED","TRANSLITERATED","VAT_REGISTERED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Name record for a business partner"}},"legalForm":{"type":"string"},"status":{"type":"object","properties":{"officialDenotation":{"type":"string"},"validFrom":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","DISSOLVED","IN_LIQUIDATION","INACTIVE","INSOLVENCY","UNKNOWN"]}},"description":"Status record for a business partner"},"profileClassifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"code":{"type":"string"},"type":{"type":"string","enum":["NACE","NAF","NAICS","SIC"]}},"description":"Classification record for a business partner"}},"types":{"type":"array","items":{"type":"string","enum":["BRAND","LEGAL_ENTITY","ORGANIZATIONAL_UNIT","SITE","UNKNOWN"]}},"bankAccounts":{"type":"array","items":{"type":"object","properties":{"trustScores":{"type":"array","items":{"type":"number","format":"float"}},"currency":{"type":"string","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"internationalBankAccountIdentifier":{"type":"string"},"internationalBankIdentifier":{"type":"string"},"nationalBankAccountIdentifier":{"type":"string"},"nationalBankIdentifier":{"type":"string"}},"description":"Bank account record of a business partner"}},"legalAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}}},"description":"Localized address record for a business partner"},"externalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Legal entity with external id"}}},"required":true},"responses":{"200":{"description":"A validation response with possible errors","content":{"*/*":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["OK","ERROR"]},"errors":{"type":"array","items":{"type":"string"}}},"description":"Contains overall result of a sharing process validation request"}}}},"400":{"description":"On malformed legal entity requests"}},"method":"post","path":"/api/catena/input/legal-entities/validation","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":{"identifiers":[{"value":"string","type":"string","issuingBody":"string","status":"string"}],"names":[{"value":"string","shortName":"string","type":"ACRONYM","language":"undefined"}],"legalForm":"string","status":{"officialDenotation":"string","validFrom":"2023-05-31","validUntil":"2023-05-31","type":"ACTIVE"},"profileClassifications":[{"value":"string","code":"string","type":"NACE"}],"types":["BRAND"],"bankAccounts":[{"trustScores":[0],"currency":"UNDEFINED","internationalBankAccountIdentifier":"string","internationalBankIdentifier":"string","nationalBankAccountIdentifier":"string","nationalBankIdentifier":"string"}],"legalAddress":{"version":{"characterSet":"ARABIC","language":"undefined"},"careOf":"string","contexts":["string"],"country":"UNDEFINED","administrativeAreas":[{"value":"string","shortName":"string","fipsCode":"string","type":"COUNTY"}],"postCodes":[{"value":"string","type":"CEDEX"}],"localities":[{"value":"string","shortName":"string","type":"BLOCK"}],"thoroughfares":[{"value":"string","name":"string","shortName":"string","number":"string","direction":"string","type":"INDUSTRIAL_ZONE"}],"premises":[{"value":"string","shortName":"string","number":"string","type":"BUILDING"}],"postalDeliveryPoints":[{"value":"string","shortName":"string","number":"string","type":"INTERURBAN_DELIVERY_POINT"}],"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"types":["BRANCH_OFFICE"]},"externalId":"string","bpn":"string"},"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0"},"postman":{"name":"Validate a legal entity","description":{"content":"Determines errors in a legal entity record which keep it from entering the sharing process","type":"text/plain"},"url":{"path":["api","catena","input","legal-entities","validation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Validate a legal entity - - - -Determines errors in a legal entity record which keep it from entering the sharing process - -
Request Body required
    identifiers object[]
    names object[]
    status object
    - -Status record for a business partner - -
    profileClassifications object[]
    bankAccounts object[]
    legalAddress object
    - -Localized address record for a business partner - -
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -A validation response with possible errors - -
Schema
- -On malformed legal entity requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/validate-site-1.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/validate-site-1.api.mdx deleted file mode 100644 index 198448ed58c..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/validate-site-1.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: validate-site-1 -title: "Validate an address partner" -description: "Determines errors in an address partner record which keep it from entering the sharing process" -sidebar_label: "Validate an address partner" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Determines errors in an address partner record which keep it from entering the sharing process","operationId":"validateSite_1","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"siteExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address."}}},"required":true},"responses":{"200":{"description":"A validation response with possible errors","content":{"*/*":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["OK","ERROR"]},"errors":{"type":"array","items":{"type":"string"}}},"description":"Contains overall result of a sharing process validation request"}}}},"400":{"description":"On malformed address requests"}},"method":"post","path":"/api/catena/input/addresses/validation","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":{"version":{"characterSet":"ARABIC","language":"undefined"},"careOf":"string","contexts":["string"],"country":"UNDEFINED","administrativeAreas":[{"value":"string","shortName":"string","fipsCode":"string","type":"COUNTY"}],"postCodes":[{"value":"string","type":"CEDEX"}],"localities":[{"value":"string","shortName":"string","type":"BLOCK"}],"thoroughfares":[{"value":"string","name":"string","shortName":"string","number":"string","direction":"string","type":"INDUSTRIAL_ZONE"}],"premises":[{"value":"string","shortName":"string","number":"string","type":"BUILDING"}],"postalDeliveryPoints":[{"value":"string","shortName":"string","number":"string","type":"INTERURBAN_DELIVERY_POINT"}],"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"types":["BRANCH_OFFICE"],"externalId":"string","legalEntityExternalId":"string","siteExternalId":"string","bpn":"string"},"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0"},"postman":{"name":"Validate an address partner","description":{"content":"Determines errors in an address partner record which keep it from entering the sharing process","type":"text/plain"},"url":{"path":["api","catena","input","addresses","validation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Validate an address partner - - - -Determines errors in an address partner record which keep it from entering the sharing process - -
Request Body required
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -A validation response with possible errors - -
Schema
- -On malformed address requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/validate-site.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/validate-site.api.mdx deleted file mode 100644 index 0b00f9acfbf..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Gate Api/validate-site.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: validate-site -title: "Validate a site" -description: "Determines errors in a site record which keep it from entering the sharing process" -sidebar_label: "Validate a site" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Determines errors in a site record which keep it from entering the sharing process","operationId":"validateSite","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"mainAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}}},"description":"Localized address record for a business partner"},"externalId":{"type":"string"},"legalEntityExternalId":{"type":"string"},"bpn":{"type":"string"}},"description":"Site with legal entity reference"}}},"required":true},"responses":{"200":{"description":"A validation response with possible errors","content":{"*/*":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["OK","ERROR"]},"errors":{"type":"array","items":{"type":"string"}}},"description":"Contains overall result of a sharing process validation request"}}}},"400":{"description":"On malformed site requests"}},"method":"post","path":"/api/catena/input/sites/validation","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":{"name":"string","mainAddress":{"version":{"characterSet":"ARABIC","language":"undefined"},"careOf":"string","contexts":["string"],"country":"UNDEFINED","administrativeAreas":[{"value":"string","shortName":"string","fipsCode":"string","type":"COUNTY"}],"postCodes":[{"value":"string","type":"CEDEX"}],"localities":[{"value":"string","shortName":"string","type":"BLOCK"}],"thoroughfares":[{"value":"string","name":"string","shortName":"string","number":"string","direction":"string","type":"INDUSTRIAL_ZONE"}],"premises":[{"value":"string","shortName":"string","number":"string","type":"BUILDING"}],"postalDeliveryPoints":[{"value":"string","shortName":"string","number":"string","type":"INTERURBAN_DELIVERY_POINT"}],"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"types":["BRANCH_OFFICE"]},"externalId":"string","legalEntityExternalId":"string","bpn":"string"},"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.0.0"},"postman":{"name":"Validate a site","description":{"content":"Determines errors in a site record which keep it from entering the sharing process","type":"text/plain"},"url":{"path":["api","catena","input","sites","validation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Validate a site - - - -Determines errors in a site record which keep it from entering the sharing process - -
Request Body required
    mainAddress object
    - -Localized address record for a business partner - -
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -A validation response with possible errors - -
Schema
- -On malformed site requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool.info.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool.info.mdx deleted file mode 100644 index d330fc21656..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: business-partner-data-management-pool -title: "Business Partner Data Management Pool" -description: "Service that manages and shares business partner data with other CatenaX services" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 4.0.0 - -# Business Partner Data Management Pool - - - -Service that manages and shares business partner data with other CatenaX services - - - \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/clear.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/clear.api.mdx deleted file mode 100644 index 3b538c1896d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/clear.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: clear -title: "Clear business partner index on OpenSearch" -description: "Deletes all business partner records in the OpenSearch index. Also resets the timestamp from the last export." -sidebar_label: "Clear business partner index on OpenSearch" -hide_title: true -hide_table_of_contents: true -api: {"tags":["open-search-controller"],"description":"Deletes all business partner records in the OpenSearch index. Also resets the timestamp from the last export.","operationId":"clear","responses":{"200":{"description":"Index successfully cleared"},"500":{"description":"Clearing failed (no connection to OpenSearch or database)"}},"method":"delete","path":"/api/opensearch/business-partner","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Clear business partner index on OpenSearch","description":{"content":"Deletes all business partner records in the OpenSearch index. Also resets the timestamp from the last export.","type":"text/plain"},"url":{"path":["api","opensearch","business-partner"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"DELETE"}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Clear business partner index on OpenSearch - - - -Deletes all business partner records in the OpenSearch index. Also resets the timestamp from the last export. - -
- -Index successfully cleared - -
- -Clearing failed (no connection to OpenSearch or database) - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-addresses.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-addresses.api.mdx deleted file mode 100644 index ae2f018f027..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-addresses.api.mdx +++ /dev/null @@ -1,86 +0,0 @@ ---- -id: create-addresses -title: "Create new address business partners" -description: "Create new business partners of type address by specifying the BPN of the parent each address belongs to. A parent can be either a site or legal entity business partner. If the parent cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response." -sidebar_label: "Create new address business partners" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Create new business partners of type address by specifying the BPN of the parent each address belongs to. A parent can be either a site or legal entity business partner. If the parent cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","operationId":"createAddresses","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}},"parent":{"type":"string"},"index":{"type":"string"}},"description":"Request for creating new business partner record of type address"}}}},"required":true},"responses":{"200":{"description":"New business partner record successfully created","content":{"*/*":{"schema":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string"},"version":{"type":"object","properties":{"characterSet":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Localization record of an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["COUNTY","REGION","OTHER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Area of an address such as country region or county"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Postcode record of an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Locality record of an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Thoroughfare record of an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Premise record of an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Postal delivery point record of an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]},"name":{"type":"string"},"url":{"type":"string"}}}},"index":{"type":"string"}},"description":"Created business partners of type address"}}}}},"400":{"description":"On malformed requests"}},"method":"post","path":"/api/catena/addresses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"version":{"characterSet":"ARABIC","language":"undefined"},"careOf":"string","contexts":["string"],"country":"UNDEFINED","administrativeAreas":[{"value":"string","shortName":"string","fipsCode":"string","type":"COUNTY"}],"postCodes":[{"value":"string","type":"CEDEX"}],"localities":[{"value":"string","shortName":"string","type":"BLOCK"}],"thoroughfares":[{"value":"string","name":"string","shortName":"string","number":"string","direction":"string","type":"INDUSTRIAL_ZONE"}],"premises":[{"value":"string","shortName":"string","number":"string","type":"BUILDING"}],"postalDeliveryPoints":[{"value":"string","shortName":"string","number":"string","type":"INTERURBAN_DELIVERY_POINT"}],"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"types":["BRANCH_OFFICE"],"parent":"string","index":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Create new address business partners","description":{"content":"Create new business partners of type address by specifying the BPN of the parent each address belongs to. A parent can be either a site or legal entity business partner. If the parent cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","type":"text/plain"},"url":{"path":["api","catena","addresses"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create new address business partners - - - -Create new business partners of type address by specifying the BPN of the parent each address belongs to. A parent can be either a site or legal entity business partner. If the parent cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. - -
Request Body array required
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -New business partner record successfully created - -
Schema array
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners.api.mdx deleted file mode 100644 index 5a676eeceaf..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners.api.mdx +++ /dev/null @@ -1,138 +0,0 @@ ---- -id: create-business-partners -title: "Create new legal entity business partners" -description: "Create new business partners of type legal entity. The given additional identifiers of a record need to be unique, otherwise they are ignored. For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response." -sidebar_label: "Create new legal entity business partners" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Create new business partners of type legal entity. The given additional identifiers of a record need to be unique, otherwise they are ignored. For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","operationId":"createBusinessPartners","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"},"status":{"type":"string"}},"description":"Identifier record for a business partner"}},"names":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["ACRONYM","DOING_BUSINESS_AS","ESTABLISHMENT","INTERNATIONAL","LOCAL","OTHER","REGISTERED","TRANSLITERATED","VAT_REGISTERED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Name record for a business partner"}},"legalForm":{"type":"string"},"status":{"type":"object","properties":{"officialDenotation":{"type":"string"},"validFrom":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","DISSOLVED","IN_LIQUIDATION","INACTIVE","INSOLVENCY","UNKNOWN"]}},"description":"Status record for a business partner"},"profileClassifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"code":{"type":"string"},"type":{"type":"string","enum":["NACE","NAF","NAICS","SIC"]}},"description":"Classification record for a business partner"}},"types":{"type":"array","items":{"type":"string","enum":["BRAND","LEGAL_ENTITY","ORGANIZATIONAL_UNIT","SITE","UNKNOWN"]}},"bankAccounts":{"type":"array","items":{"type":"object","properties":{"trustScores":{"type":"array","items":{"type":"number","format":"float"}},"currency":{"type":"string","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"internationalBankAccountIdentifier":{"type":"string"},"internationalBankIdentifier":{"type":"string"},"nationalBankAccountIdentifier":{"type":"string"},"nationalBankIdentifier":{"type":"string"}},"description":"Bank account record of a business partner"}},"legalAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}}},"description":"Localized address record for a business partner"},"index":{"type":"string"}},"description":"Request for creating new business partner record of type legal entity"}}}},"required":true},"responses":{"200":{"description":"New business partner record successfully created","content":{"*/*":{"schema":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"issuingBody":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"status":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a business partner"}},"names":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACRONYM","DOING_BUSINESS_AS","ESTABLISHMENT","INTERNATIONAL","LOCAL","OTHER","REGISTERED","TRANSLITERATED","VAT_REGISTERED"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Name record of a business partner"}},"legalForm":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"mainAbbreviation":{"type":"string"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}}},"description":"Legal form a business partner can have"},"status":{"type":"object","properties":{"officialDenotation":{"type":"string"},"validFrom":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","DISSOLVED","IN_LIQUIDATION","INACTIVE","INSOLVENCY","UNKNOWN"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Status of a business partner"},"profileClassifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"code":{"type":"string"},"type":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}},"description":"Classification record of a business partner"}},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRAND","LEGAL_ENTITY","ORGANIZATIONAL_UNIT","SITE","UNKNOWN"]},"name":{"type":"string"},"url":{"type":"string"}}}},"bankAccounts":{"type":"array","items":{"type":"object","properties":{"trustScores":{"type":"array","items":{"type":"number","format":"float"}},"currency":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"internationalBankAccountIdentifier":{"type":"string"},"internationalBankIdentifier":{"type":"string"},"nationalBankAccountIdentifier":{"type":"string"},"nationalBankIdentifier":{"type":"string"}},"description":"Bank account record for a business partner"}},"roles":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"relations":{"type":"array","items":{"type":"object","properties":{"relationClass":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["SAAS_HIERARCHY","SAAS_TRANSITION","CX_HIERARCHY","DNB_HIERARCHY","LEI_HIERARCHY"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF","CX_ADDRESS_OF","CX_SITE_OF","CX_OWNED_BY","DIRECT_LEGAL_RELATION","COMMERCIAL_ULTIMATE","DOMESTIC_BRANCH_RELATION","INTERNATIONAL_BRANCH_RELATION","DOMESTIC_LEGAL_ULTIMATE_RELATION","GLOBAL_LEGAL_ULTIMATE_RELATION","LEGAL_PREDECESSOR","LEGAL_SUCCESSOR","DNB_PARENT","DNB_HEADQUARTER","DNB_DOMESTIC_ULTIMATE","DNB_GLOBAL_ULTIMATE","LEI_DIRECT_PARENT","LEI_INTERNATIONAL_BRANCH","LEI_ULTIMATE_PARENT"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"startNode":{"type":"string"},"endNode":{"type":"string"},"startedAt":{"type":"string","format":"date-time"},"endedAt":{"type":"string","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","format":"date-time"},"legalAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Localization record of an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["COUNTY","REGION","OTHER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Area of an address such as country region or county"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Postcode record of an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Locality record of an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Thoroughfare record of an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Premise record of an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Postal delivery point record of an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]},"name":{"type":"string"},"url":{"type":"string"}}}}},"description":"Localized address record of a business partner"},"index":{"type":"string"}},"description":"Created business partner of type legal entity"}}}}},"400":{"description":"On malformed requests"},"404":{"description":"Metadata referenced by technical key not found"}},"method":"post","path":"/api/catena/legal-entities","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"identifiers":[{"value":"string","type":"string","issuingBody":"string","status":"string"}],"names":[{"value":"string","shortName":"string","type":"ACRONYM","language":"undefined"}],"legalForm":"string","status":{"officialDenotation":"string","validFrom":"2023-05-31","validUntil":"2023-05-31","type":"ACTIVE"},"profileClassifications":[{"value":"string","code":"string","type":"NACE"}],"types":["BRAND"],"bankAccounts":[{"trustScores":[0],"currency":"UNDEFINED","internationalBankAccountIdentifier":"string","internationalBankIdentifier":"string","nationalBankAccountIdentifier":"string","nationalBankIdentifier":"string"}],"legalAddress":{"version":{"characterSet":"ARABIC","language":"undefined"},"careOf":"string","contexts":["string"],"country":"UNDEFINED","administrativeAreas":[{"value":"string","shortName":"string","fipsCode":"string","type":"COUNTY"}],"postCodes":[{"value":"string","type":"CEDEX"}],"localities":[{"value":"string","shortName":"string","type":"BLOCK"}],"thoroughfares":[{"value":"string","name":"string","shortName":"string","number":"string","direction":"string","type":"INDUSTRIAL_ZONE"}],"premises":[{"value":"string","shortName":"string","number":"string","type":"BUILDING"}],"postalDeliveryPoints":[{"value":"string","shortName":"string","number":"string","type":"INTERURBAN_DELIVERY_POINT"}],"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"types":["BRANCH_OFFICE"]},"index":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Create new legal entity business partners","description":{"content":"Create new business partners of type legal entity. The given additional identifiers of a record need to be unique, otherwise they are ignored. For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","type":"text/plain"},"url":{"path":["api","catena","legal-entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create new legal entity business partners - - - -Create new business partners of type legal entity. The given additional identifiers of a record need to be unique, otherwise they are ignored. For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. - -
Request Body array required
    identifiers object[]
    names object[]
    status object
    - -Status record for a business partner - -
    profileClassifications object[]
    bankAccounts object[]
    legalAddress object
    - -Localized address record for a business partner - -
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -New business partner record successfully created - -
Schema array
    identifiers object[]
    type object
    issuingBody object
    status object
    - -Named type uniquely identified by its technical key - -
    names object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    legalForm object
    - -Legal form a business partner can have - -
    language object
    - -Named type uniquely identified by its technical key - -
    categories object[]
    status object
    - -Status of a business partner - -
    type object
    profileClassifications object[]
    type object
    - -General type with name and URL link for further information - -
    types object[]
    bankAccounts object[]
    currency object
    - -Named type uniquely identified by its technical key - -
    roles object[]
    relations object[]
    relationClass object
    - -Named type uniquely identified by its technical key - -
    type object
    - -Named type uniquely identified by its technical key - -
    legalAddress object
    - -Localized address record of a business partner - -
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
- -On malformed requests - -
- -Metadata referenced by technical key not found - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-status.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-status.api.mdx deleted file mode 100644 index 71f6e1fd3f2..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-status.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-identifier-status -title: "Create new identifier status" -description: "Create a new identifier status which can be referenced by business partner records. A status further distinguishes an identifier by adding current status information such as active or revoked.The actual name of the identifier status is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems." -sidebar_label: "Create new identifier status" -hide_title: true -hide_table_of_contents: true -api: {"tags":["metadata-controller"],"description":"Create a new identifier status which can be referenced by business partner records. A status further distinguishes an identifier by adding current status information such as active or revoked.The actual name of the identifier status is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.","operationId":"createIdentifierStatus","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}}},"required":true},"responses":{"200":{"description":"New identifier status successfully created","content":{"*/*":{"schema":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}}}},"400":{"description":"On malformed request parameters"},"409":{"description":"Identifier status with specified technical key already exists"}},"method":"post","path":"/api/catena/identifier-status","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"technicalKey":"string","name":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Create new identifier status","description":{"content":"Create a new identifier status which can be referenced by business partner records. A status further distinguishes an identifier by adding current status information such as active or revoked.The actual name of the identifier status is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.","type":"text/plain"},"url":{"path":["api","catena","identifier-status"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create new identifier status - - - -Create a new identifier status which can be referenced by business partner records. A status further distinguishes an identifier by adding current status information such as active or revoked.The actual name of the identifier status is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems. - -
Request Body required
- -New identifier status successfully created - -
Schema
- -On malformed request parameters - -
- -Identifier status with specified technical key already exists - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type.api.mdx deleted file mode 100644 index c0489c30b2e..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-identifier-type -title: "Create new identifier type" -description: "Create a new identifier type which can be referenced by business partner records. Identifier types such as BPN or VAT determine with which kind of values a business partner can be identified with. The actual name of the identifier type is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems." -sidebar_label: "Create new identifier type" -hide_title: true -hide_table_of_contents: true -api: {"tags":["metadata-controller"],"description":"Create a new identifier type which can be referenced by business partner records. Identifier types such as BPN or VAT determine with which kind of values a business partner can be identified with. The actual name of the identifier type is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.","operationId":"createIdentifierType","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"New identifier type successfully created","content":{"*/*":{"schema":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}}}}},"400":{"description":"On malformed request parameters"},"409":{"description":"Identifier type with specified technical key already exists"}},"method":"post","path":"/api/catena/identifier-types","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"technicalKey":"string","name":"string","url":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Create new identifier type","description":{"content":"Create a new identifier type which can be referenced by business partner records. Identifier types such as BPN or VAT determine with which kind of values a business partner can be identified with. The actual name of the identifier type is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.","type":"text/plain"},"url":{"path":["api","catena","identifier-types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create new identifier type - - - -Create a new identifier type which can be referenced by business partner records. Identifier types such as BPN or VAT determine with which kind of values a business partner can be identified with. The actual name of the identifier type is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems. - -
Request Body required
- -New identifier type successfully created - -
Schema
- -On malformed request parameters - -
- -Identifier type with specified technical key already exists - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-issuing-body.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-issuing-body.api.mdx deleted file mode 100644 index fd11881210c..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-issuing-body.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-issuing-body -title: "Create new issuing body" -description: "Create a new issuing body which can be referenced by business partner records. An issuing body should be an entity which the Catena organisation trusts to issue identifiers.The actual name of the issuing body is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems." -sidebar_label: "Create new issuing body" -hide_title: true -hide_table_of_contents: true -api: {"tags":["metadata-controller"],"description":"Create a new issuing body which can be referenced by business partner records. An issuing body should be an entity which the Catena organisation trusts to issue identifiers.The actual name of the issuing body is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.","operationId":"createIssuingBody","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"New issuing body successfully created","content":{"*/*":{"schema":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}}}}},"400":{"description":"On malformed request parameters"},"409":{"description":"Issuing body with specified technical key already exists"}},"method":"post","path":"/api/catena/issuing-bodies","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"technicalKey":"string","name":"string","url":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Create new issuing body","description":{"content":"Create a new issuing body which can be referenced by business partner records. An issuing body should be an entity which the Catena organisation trusts to issue identifiers.The actual name of the issuing body is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.","type":"text/plain"},"url":{"path":["api","catena","issuing-bodies"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create new issuing body - - - -Create a new issuing body which can be referenced by business partner records. An issuing body should be an entity which the Catena organisation trusts to issue identifiers.The actual name of the issuing body is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems. - -
Request Body required
- -New issuing body successfully created - -
Schema
- -On malformed request parameters - -
- -Issuing body with specified technical key already exists - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form.api.mdx deleted file mode 100644 index c860df9a1c1..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: create-legal-form -title: "Create new legal form" -description: "Create a new legal form which can be referenced by business partner records. The actual name of the legal form is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems." -sidebar_label: "Create new legal form" -hide_title: true -hide_table_of_contents: true -api: {"tags":["metadata-controller"],"description":"Create a new legal form which can be referenced by business partner records. The actual name of the legal form is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.","operationId":"createLegalForm","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"mainAbbreviation":{"type":"string"},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"category":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}}},"description":"New legal form record to be referenced by business partners"}}},"required":true},"responses":{"200":{"description":"New legal form successfully created","content":{"*/*":{"schema":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"mainAbbreviation":{"type":"string"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}}},"description":"Legal form a business partner can have"}}}},"400":{"description":"On malformed request parameters"},"409":{"description":"Legal form with specified technical key already exists"}},"method":"post","path":"/api/catena/legal-forms","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"technicalKey":"string","name":"string","url":"string","mainAbbreviation":"string","language":"undefined","category":[{"name":"string","url":"string"}]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Create new legal form","description":{"content":"Create a new legal form which can be referenced by business partner records. The actual name of the legal form is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.","type":"text/plain"},"url":{"path":["api","catena","legal-forms"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create new legal form - - - -Create a new legal form which can be referenced by business partner records. The actual name of the legal form is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems. - -
Request Body required
    category object[]
- -New legal form successfully created - -
Schema
    language object
    - -Named type uniquely identified by its technical key - -
    categories object[]
- -On malformed request parameters - -
- -Legal form with specified technical key already exists - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-site.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-site.api.mdx deleted file mode 100644 index 422055ecf3e..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/create-site.api.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: create-site -title: "Create new site business partners" -description: "Create new business partners of type site by specifying the BPNL of the legal entity each site belongs to. If the legal entitiy cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response." -sidebar_label: "Create new site business partners" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Create new business partners of type site by specifying the BPNL of the legal entity each site belongs to. If the legal entitiy cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","operationId":"createSite","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"mainAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}}},"description":"Localized address record for a business partner"},"legalEntity":{"type":"string"},"index":{"type":"string"}},"description":"Request for creating new business partner record of type site"}}}},"required":true},"responses":{"200":{"description":"New business partner record successfully created","content":{"*/*":{"schema":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string"},"name":{"type":"string"},"mainAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Localization record of an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["COUNTY","REGION","OTHER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Area of an address such as country region or county"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Postcode record of an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Locality record of an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Thoroughfare record of an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Premise record of an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Postal delivery point record of an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]},"name":{"type":"string"},"url":{"type":"string"}}}}},"description":"Localized address record of a business partner"},"index":{"type":"string"}},"description":"Created business partner record of type site"}}}}},"400":{"description":"On malformed requests"}},"method":"post","path":"/api/catena/sites","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"name":"string","mainAddress":{"version":{"characterSet":"ARABIC","language":"undefined"},"careOf":"string","contexts":["string"],"country":"UNDEFINED","administrativeAreas":[{"value":"string","shortName":"string","fipsCode":"string","type":"COUNTY"}],"postCodes":[{"value":"string","type":"CEDEX"}],"localities":[{"value":"string","shortName":"string","type":"BLOCK"}],"thoroughfares":[{"value":"string","name":"string","shortName":"string","number":"string","direction":"string","type":"INDUSTRIAL_ZONE"}],"premises":[{"value":"string","shortName":"string","number":"string","type":"BUILDING"}],"postalDeliveryPoints":[{"value":"string","shortName":"string","number":"string","type":"INTERURBAN_DELIVERY_POINT"}],"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"types":["BRANCH_OFFICE"]},"legalEntity":"string","index":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Create new site business partners","description":{"content":"Create new business partners of type site by specifying the BPNL of the legal entity each site belongs to. If the legal entitiy cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","type":"text/plain"},"url":{"path":["api","catena","sites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create new site business partners - - - -Create new business partners of type site by specifying the BPNL of the legal entity each site belongs to. If the legal entitiy cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. - -
Request Body array required
    mainAddress object
    - -Localized address record for a business partner - -
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -New business partner record successfully created - -
Schema array
    mainAddress object
    - -Localized address record of a business partner - -
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/export.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/export.api.mdx deleted file mode 100644 index be7654e042f..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/export.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: export -title: "Index new business partner records on OpenSearch" -description: "Triggers an asynchronous export of business partner records from BPDM to OpenSearch. Only exports records which have been updated since the last export." -sidebar_label: "Index new business partner records on OpenSearch" -hide_title: true -hide_table_of_contents: true -api: {"tags":["open-search-controller"],"description":"Triggers an asynchronous export of business partner records from BPDM to OpenSearch. Only exports records which have been updated since the last export. ","operationId":"export","responses":{"200":{"description":"Export of records successfully","content":{"*/*":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["OPENSEARCH","SAAS_IMPORT"]},"status":{"type":"string","enum":["NOT_SYNCED","RUNNING","SUCCESS","ERROR"]},"count":{"type":"integer","format":"int32"},"progress":{"type":"number","format":"float"},"errorDetails":{"type":"string"},"startedAt":{"type":"string","format":"date-time"},"finishedAt":{"type":"string","format":"date-time"}}}}}},"500":{"description":"Export failed (no connection to OpenSearch or database)"}},"method":"post","path":"/api/opensearch/business-partner","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Index new business partner records on OpenSearch","description":{"content":"Triggers an asynchronous export of business partner records from BPDM to OpenSearch. Only exports records which have been updated since the last export. ","type":"text/plain"},"url":{"path":["api","opensearch","business-partner"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Index new business partner records on OpenSearch - - - -Triggers an asynchronous export of business partner records from BPDM to OpenSearch. Only exports records which have been updated since the last export. - -
- -Export of records successfully - -
Schema
- -Export failed (no connection to OpenSearch or database) - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers.api.mdx deleted file mode 100644 index 419969dcc21..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: find-bpns-by-identifiers -title: "Find business partner numbers by identifiers" -description: "Find business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to 5000 entries." -sidebar_label: "Find business partner numbers by identifiers" -hide_title: true -hide_table_of_contents: true -api: {"tags":["bpn-controller"],"description":"Find business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to 5000 entries.","operationId":"findBpnsByIdentifiers","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"idType":{"type":"string"},"idValues":{"type":"array","items":{"type":"string"}}},"description":"Contains identifiers to search legal entities by"}}},"required":true},"responses":{"200":{"description":"Found bpn to identifier value mappings","content":{"*/*":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"object","properties":{"idValue":{"type":"string"},"bpn":{"type":"string"}},"description":"Mapping of Business Partner Number to identifier value"}}}}},"400":{"description":"On malformed request parameters or if number of requested bpns exceeds limit"},"404":{"description":"Specified identifier type not found"}},"method":"post","path":"/api/catena/bpn/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"idType":"string","idValues":["string"]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Find business partner numbers by identifiers","description":{"content":"Find business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to 5000 entries.","type":"text/plain"},"url":{"path":["api","catena","bpn","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Find business partner numbers by identifiers - - - -Find business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to 5000 entries. - -
Request Body required
- -Found bpn to identifier value mappings - -
Schema array
- -On malformed request parameters or if number of requested bpns exceeds limit - -
- -Specified identifier type not found - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-address.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-address.api.mdx deleted file mode 100644 index a766cfdcf21..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-address.api.mdx +++ /dev/null @@ -1,86 +0,0 @@ ---- -id: get-address -title: "Get address partners by bpn" -description: "Get business partners of type address by bpn-a ignoring case." -sidebar_label: "Get address partners by bpn" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Get business partners of type address by bpn-a ignoring case.","operationId":"getAddress","parameters":[{"name":"bpn","in":"path","description":"Bpn value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found address with specified bpn","content":{"*/*":{"schema":{"type":"object","properties":{"address":{"type":"object","properties":{"bpn":{"type":"string"},"version":{"type":"object","properties":{"characterSet":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Localization record of an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["COUNTY","REGION","OTHER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Area of an address such as country region or county"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Postcode record of an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Locality record of an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Thoroughfare record of an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Premise record of an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Postal delivery point record of an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]},"name":{"type":"string"},"url":{"type":"string"}}}}},"description":"Business partner of type address"},"bpnLegalEntity":{"type":"string"},"bpnSite":{"type":"string"}},"description":"Business partner of type address with parent reference"}}}},"400":{"description":"On malformed request parameters"},"404":{"description":"No address found under specified bpn"}},"method":"get","path":"/api/catena/addresses/{bpn}","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Get address partners by bpn","description":{"content":"Get business partners of type address by bpn-a ignoring case.","type":"text/plain"},"url":{"path":["api","catena","addresses",":bpn"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Bpn value","type":"text/plain"},"type":"any","value":"","key":"bpn"}]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get address partners by bpn - - - -Get business partners of type address by bpn-a ignoring case. - -
Path Parameters
- -Found address with specified bpn - -
Schema
    address object
    - -Business partner of type address - -
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
- -On malformed request parameters - -
- -No address found under specified bpn - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1.api.mdx deleted file mode 100644 index a95e7307828..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1.api.mdx +++ /dev/null @@ -1,86 +0,0 @@ ---- -id: get-addresses-1 -title: "Get page of addresses matching the search criteria" -description: "This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score." -sidebar_label: "Get page of addresses matching the search criteria" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score.","operationId":"getAddresses_1","parameters":[{"name":"administrativeArea","in":"query","description":"Filter business partners by administrative area name","required":false,"schema":{"type":"string"}},{"name":"postCode","in":"query","description":"Filter business partners by postcode or postcodes","required":false,"schema":{"type":"string"}},{"name":"locality","in":"query","description":"Filter business partners by locality full denotation","required":false,"schema":{"type":"string"}},{"name":"thoroughfare","in":"query","description":"Filter business partners by thoroughfare full denotation","required":false,"schema":{"type":"string"}},{"name":"premise","in":"query","description":"Filter business partners by premise full denotation","required":false,"schema":{"type":"string"}},{"name":"postalDeliveryPoint","in":"query","description":"Filter business partners by postal delivery point full denotation","required":false,"schema":{"type":"string"}},{"name":"countryCode","in":"query","description":"Filter business partners by ISO 3166-1 alpha-2 country code","required":false,"schema":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of addresses matching the search criteria, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"score":{"type":"number","format":"float"},"address":{"type":"object","properties":{"address":{"type":"object","properties":{"bpn":{"type":"string"},"version":{"type":"object","properties":{"characterSet":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Localization record of an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["COUNTY","REGION","OTHER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Area of an address such as country region or county"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Postcode record of an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Locality record of an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Thoroughfare record of an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Premise record of an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Postal delivery point record of an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]},"name":{"type":"string"},"url":{"type":"string"}}}}},"description":"Business partner of type address"},"bpnLegalEntity":{"type":"string"},"bpnSite":{"type":"string"}},"description":"Business partner of type address with parent reference"}},"description":"Match with score for a business partner record of type address"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed search or pagination request"}},"method":"get","path":"/api/catena/addresses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Get page of addresses matching the search criteria","description":{"content":"This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score.","type":"text/plain"},"url":{"path":["api","catena","addresses"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter business partners by administrative area name","type":"text/plain"},"key":"administrativeArea","value":""},{"disabled":false,"description":{"content":"Filter business partners by postcode or postcodes","type":"text/plain"},"key":"postCode","value":""},{"disabled":false,"description":{"content":"Filter business partners by locality full denotation","type":"text/plain"},"key":"locality","value":""},{"disabled":false,"description":{"content":"Filter business partners by thoroughfare full denotation","type":"text/plain"},"key":"thoroughfare","value":""},{"disabled":false,"description":{"content":"Filter business partners by premise full denotation","type":"text/plain"},"key":"premise","value":""},{"disabled":false,"description":{"content":"Filter business partners by postal delivery point full denotation","type":"text/plain"},"key":"postalDeliveryPoint","value":""},{"disabled":false,"description":{"content":"Filter business partners by ISO 3166-1 alpha-2 country code","type":"text/plain"},"key":"countryCode","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of addresses matching the search criteria - - - -This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. - -
Query Parameters
- -Page of addresses matching the search criteria, may be empty - -
Schema
    content object[]
    address object
    - -Business partner of type address with parent reference - -
    address object
    - -Business partner of type address - -
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
- -On malformed search or pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses.api.mdx deleted file mode 100644 index 3fa7d4764d4..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses.api.mdx +++ /dev/null @@ -1,82 +0,0 @@ ---- -id: get-addresses -title: "Get address partners of a legal entity" -description: "Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's bpn ignoring case." -sidebar_label: "Get address partners of a legal entity" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's bpn ignoring case.","operationId":"getAddresses","parameters":[{"name":"bpn","in":"path","description":"Bpn value","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"The addresses for the specified bpn","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string"},"version":{"type":"object","properties":{"characterSet":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Localization record of an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["COUNTY","REGION","OTHER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Area of an address such as country region or county"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Postcode record of an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Locality record of an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Thoroughfare record of an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Premise record of an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Postal delivery point record of an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]},"name":{"type":"string"},"url":{"type":"string"}}}}},"description":"Business partner of type address"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"},"404":{"description":"No business partner found for specified bpn"}},"method":"get","path":"/api/catena/legal-entities/{bpn}/addresses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Get address partners of a legal entity","description":{"content":"Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's bpn ignoring case.","type":"text/plain"},"url":{"path":["api","catena","legal-entities",":bpn","addresses"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Bpn value","type":"text/plain"},"type":"any","value":"","key":"bpn"}]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get address partners of a legal entity - - - -Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's bpn ignoring case. - -
Path Parameters
Query Parameters
- -The addresses for the specified bpn - -
Schema
    content object[]
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
- -On malformed pagination request - -
- -No business partner found for specified bpn - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-admin-area-suggestion.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-admin-area-suggestion.api.mdx deleted file mode 100644 index b849d02e7cb..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-admin-area-suggestion.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-admin-area-suggestion -title: "Find best matches for given text in administrative areas" -description: "Performs search on administrative area names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible administrative area names in the search set." -sidebar_label: "Find best matches for given text in administrative areas" -hide_title: true -hide_table_of_contents: true -api: {"tags":["suggestion-controller"],"description":"Performs search on administrative area names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible administrative area names in the search set.","operationId":"getAdminAreaSuggestion","parameters":[{"name":"text","in":"query","description":"Show administrative area names best matching this text","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter legal entities by name","required":false,"schema":{"type":"string"}},{"name":"legalForm","in":"query","description":"Filter legal entities by legal form name","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter legal entities by status official denotation","required":false,"schema":{"type":"string"}},{"name":"classification","in":"query","description":"Filter legal entities by classification denotation","required":false,"schema":{"type":"string"}},{"name":"administrativeArea","in":"query","description":"Filter business partners by administrative area name","required":false,"schema":{"type":"string"}},{"name":"postCode","in":"query","description":"Filter business partners by postcode or postcodes","required":false,"schema":{"type":"string"}},{"name":"locality","in":"query","description":"Filter business partners by locality full denotation","required":false,"schema":{"type":"string"}},{"name":"thoroughfare","in":"query","description":"Filter business partners by thoroughfare full denotation","required":false,"schema":{"type":"string"}},{"name":"premise","in":"query","description":"Filter business partners by premise full denotation","required":false,"schema":{"type":"string"}},{"name":"postalDeliveryPoint","in":"query","description":"Filter business partners by postal delivery point full denotation","required":false,"schema":{"type":"string"}},{"name":"siteName","in":"query","description":"Filter sites by name","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Best matches found, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"suggestion":{"type":"string"},"relevancy":{"type":"number","format":"float"}},"description":"Shows a ranked suggestion based on a given search text"}}},"description":"Paginated collection of results"}}}}},"method":"get","path":"/api/catena/suggestions/addresses/administrative-areas","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Find best matches for given text in administrative areas","description":{"content":"Performs search on administrative area names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible administrative area names in the search set.","type":"text/plain"},"url":{"path":["api","catena","suggestions","addresses","administrative-areas"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Show administrative area names best matching this text","type":"text/plain"},"key":"text","value":""},{"disabled":false,"description":{"content":"Filter legal entities by name","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Filter legal entities by legal form name","type":"text/plain"},"key":"legalForm","value":""},{"disabled":false,"description":{"content":"Filter legal entities by status official denotation","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Filter legal entities by classification denotation","type":"text/plain"},"key":"classification","value":""},{"disabled":false,"description":{"content":"Filter business partners by administrative area name","type":"text/plain"},"key":"administrativeArea","value":""},{"disabled":false,"description":{"content":"Filter business partners by postcode or postcodes","type":"text/plain"},"key":"postCode","value":""},{"disabled":false,"description":{"content":"Filter business partners by locality full denotation","type":"text/plain"},"key":"locality","value":""},{"disabled":false,"description":{"content":"Filter business partners by thoroughfare full denotation","type":"text/plain"},"key":"thoroughfare","value":""},{"disabled":false,"description":{"content":"Filter business partners by premise full denotation","type":"text/plain"},"key":"premise","value":""},{"disabled":false,"description":{"content":"Filter business partners by postal delivery point full denotation","type":"text/plain"},"key":"postalDeliveryPoint","value":""},{"disabled":false,"description":{"content":"Filter sites by name","type":"text/plain"},"key":"siteName","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Find best matches for given text in administrative areas - - - -Performs search on administrative area names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible administrative area names in the search set. - -
Query Parameters
- -Best matches found, may be empty - -
Schema
    content object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-business-partners.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-business-partners.api.mdx deleted file mode 100644 index 5fa7ff6c545..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-business-partners.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-business-partners -title: "Fetch information about the latest OpenSearch export" -description: "Fetch information about the latest export (either ongoing or already finished)" -sidebar_label: "Fetch information about the latest OpenSearch export" -hide_title: true -hide_table_of_contents: true -api: {"tags":["open-search-controller"],"description":"Fetch information about the latest export (either ongoing or already finished)","operationId":"getBusinessPartners","responses":{"200":{"description":"Export information found","content":{"*/*":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["OPENSEARCH","SAAS_IMPORT"]},"status":{"type":"string","enum":["NOT_SYNCED","RUNNING","SUCCESS","ERROR"]},"count":{"type":"integer","format":"int32"},"progress":{"type":"number","format":"float"},"errorDetails":{"type":"string"},"startedAt":{"type":"string","format":"date-time"},"finishedAt":{"type":"string","format":"date-time"}}}}}},"500":{"description":"Fetching failed (no connection to database)"}},"method":"get","path":"/api/opensearch/business-partner","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Fetch information about the latest OpenSearch export","description":{"content":"Fetch information about the latest export (either ongoing or already finished)","type":"text/plain"},"url":{"path":["api","opensearch","business-partner"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Fetch information about the latest OpenSearch export - - - -Fetch information about the latest export (either ongoing or already finished) - -
- -Export information found - -
Schema
- -Fetching failed (no connection to database) - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries.api.mdx deleted file mode 100644 index cbf94a4cfbd..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-changelog-entries -title: "Get business partner changelog entries by bpn" -description: "Get business partner changelog entries by bpn ignoring case." -sidebar_label: "Get business partner changelog entries by bpn" -hide_title: true -hide_table_of_contents: true -api: {"tags":["business-partner-controller"],"description":"Get business partner changelog entries by bpn ignoring case.","operationId":"getChangelogEntries","parameters":[{"name":"bpn","in":"path","description":"Bpn value","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"The changelog entries for the specified bpn","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string"},"changelogType":{"type":"string","enum":["CREATE","UPDATE"]},"timestamp":{"type":"string","format":"date-time"}},"description":"Changelog entry for a business partner"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"},"404":{"description":"No business partner found for specified bpn"}},"method":"get","path":"/api/catena/business-partners/{bpn}/changelog","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Get business partner changelog entries by bpn","description":{"content":"Get business partner changelog entries by bpn ignoring case.","type":"text/plain"},"url":{"path":["api","catena","business-partners",":bpn","changelog"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Bpn value","type":"text/plain"},"type":"any","value":"","key":"bpn"}]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get business partner changelog entries by bpn - - - -Get business partner changelog entries by bpn ignoring case. - -
Path Parameters
Query Parameters
- -The changelog entries for the specified bpn - -
Schema
    content object[]
- -On malformed pagination request - -
- -No business partner found for specified bpn - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-classification-suggestion.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-classification-suggestion.api.mdx deleted file mode 100644 index e05d847a5fa..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-classification-suggestion.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-classification-suggestion -title: "Find best matches for given text in business partner classifications" -description: "Performs search on business partner classifications in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible business partner classifications in the search set." -sidebar_label: "Find best matches for given text in business partner classifications" -hide_title: true -hide_table_of_contents: true -api: {"tags":["suggestion-controller"],"description":"Performs search on business partner classifications in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible business partner classifications in the search set.","operationId":"getClassificationSuggestion","parameters":[{"name":"text","in":"query","description":"Show business partner classifications best matching this text","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter legal entities by name","required":false,"schema":{"type":"string"}},{"name":"legalForm","in":"query","description":"Filter legal entities by legal form name","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter legal entities by status official denotation","required":false,"schema":{"type":"string"}},{"name":"classification","in":"query","description":"Filter legal entities by classification denotation","required":false,"schema":{"type":"string"}},{"name":"administrativeArea","in":"query","description":"Filter business partners by administrative area name","required":false,"schema":{"type":"string"}},{"name":"postCode","in":"query","description":"Filter business partners by postcode or postcodes","required":false,"schema":{"type":"string"}},{"name":"locality","in":"query","description":"Filter business partners by locality full denotation","required":false,"schema":{"type":"string"}},{"name":"thoroughfare","in":"query","description":"Filter business partners by thoroughfare full denotation","required":false,"schema":{"type":"string"}},{"name":"premise","in":"query","description":"Filter business partners by premise full denotation","required":false,"schema":{"type":"string"}},{"name":"postalDeliveryPoint","in":"query","description":"Filter business partners by postal delivery point full denotation","required":false,"schema":{"type":"string"}},{"name":"siteName","in":"query","description":"Filter sites by name","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Best matches found, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"suggestion":{"type":"string"},"relevancy":{"type":"number","format":"float"}},"description":"Shows a ranked suggestion based on a given search text"}}},"description":"Paginated collection of results"}}}}},"method":"get","path":"/api/catena/suggestions/legal-entities/classifications","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Find best matches for given text in business partner classifications","description":{"content":"Performs search on business partner classifications in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible business partner classifications in the search set.","type":"text/plain"},"url":{"path":["api","catena","suggestions","legal-entities","classifications"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Show business partner classifications best matching this text","type":"text/plain"},"key":"text","value":""},{"disabled":false,"description":{"content":"Filter legal entities by name","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Filter legal entities by legal form name","type":"text/plain"},"key":"legalForm","value":""},{"disabled":false,"description":{"content":"Filter legal entities by status official denotation","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Filter legal entities by classification denotation","type":"text/plain"},"key":"classification","value":""},{"disabled":false,"description":{"content":"Filter business partners by administrative area name","type":"text/plain"},"key":"administrativeArea","value":""},{"disabled":false,"description":{"content":"Filter business partners by postcode or postcodes","type":"text/plain"},"key":"postCode","value":""},{"disabled":false,"description":{"content":"Filter business partners by locality full denotation","type":"text/plain"},"key":"locality","value":""},{"disabled":false,"description":{"content":"Filter business partners by thoroughfare full denotation","type":"text/plain"},"key":"thoroughfare","value":""},{"disabled":false,"description":{"content":"Filter business partners by premise full denotation","type":"text/plain"},"key":"premise","value":""},{"disabled":false,"description":{"content":"Filter business partners by postal delivery point full denotation","type":"text/plain"},"key":"postalDeliveryPoint","value":""},{"disabled":false,"description":{"content":"Filter sites by name","type":"text/plain"},"key":"siteName","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Find best matches for given text in business partner classifications - - - -Performs search on business partner classifications in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible business partner classifications in the search set. - -
Query Parameters
- -Best matches found, may be empty - -
Schema
    content object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-stati.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-stati.api.mdx deleted file mode 100644 index c5283443a7a..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-stati.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-identifier-stati -title: "Get page of identifier statuses" -description: "Lists all currently known identifier statuses in a paginated result" -sidebar_label: "Get page of identifier statuses" -hide_title: true -hide_table_of_contents: true -api: {"tags":["metadata-controller"],"description":"Lists all currently known identifier statuses in a paginated result","operationId":"getIdentifierStati","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of existing identifier statuses, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters"}},"method":"get","path":"/api/catena/identifier-status","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Get page of identifier statuses","description":{"content":"Lists all currently known identifier statuses in a paginated result","type":"text/plain"},"url":{"path":["api","catena","identifier-status"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of identifier statuses - - - -Lists all currently known identifier statuses in a paginated result - -
Query Parameters
- -Page of existing identifier statuses, may be empty - -
Schema
    content object[]
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types.api.mdx deleted file mode 100644 index 4e2c090d112..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-identifier-types -title: "Get page of identifier types" -description: "Lists all currently known identifier types in a paginated result" -sidebar_label: "Get page of identifier types" -hide_title: true -hide_table_of_contents: true -api: {"tags":["metadata-controller"],"description":"Lists all currently known identifier types in a paginated result","operationId":"getIdentifierTypes","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of existing identifier types, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters"}},"method":"get","path":"/api/catena/identifier-types","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Get page of identifier types","description":{"content":"Lists all currently known identifier types in a paginated result","type":"text/plain"},"url":{"path":["api","catena","identifier-types"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of identifier types - - - -Lists all currently known identifier types in a paginated result - -
Query Parameters
- -Page of existing identifier types, may be empty - -
Schema
    content object[]
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-issuing-bodies.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-issuing-bodies.api.mdx deleted file mode 100644 index 9e317c081f7..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-issuing-bodies.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-issuing-bodies -title: "Get page of issuing bodies" -description: "Lists all currently known issuing bodies in a paginated result" -sidebar_label: "Get page of issuing bodies" -hide_title: true -hide_table_of_contents: true -api: {"tags":["metadata-controller"],"description":"Lists all currently known issuing bodies in a paginated result","operationId":"getIssuingBodies","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of existing issuing bodies, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters"}},"method":"get","path":"/api/catena/issuing-bodies","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Get page of issuing bodies","description":{"content":"Lists all currently known issuing bodies in a paginated result","type":"text/plain"},"url":{"path":["api","catena","issuing-bodies"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of issuing bodies - - - -Lists all currently known issuing bodies in a paginated result - -
Query Parameters
- -Page of existing issuing bodies, may be empty - -
Schema
    content object[]
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities.api.mdx deleted file mode 100644 index 9f7539c303e..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities.api.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -id: get-legal-entities -title: "Get page of legal entity business partners matching the search criteria" -description: "This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score." -sidebar_label: "Get page of legal entity business partners matching the search criteria" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score.","operationId":"getLegalEntities","parameters":[{"name":"name","in":"query","description":"Filter legal entities by name","required":false,"schema":{"type":"string"}},{"name":"legalForm","in":"query","description":"Filter legal entities by legal form name","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter legal entities by status official denotation","required":false,"schema":{"type":"string"}},{"name":"classification","in":"query","description":"Filter legal entities by classification denotation","required":false,"schema":{"type":"string"}},{"name":"administrativeArea","in":"query","description":"Filter business partners by administrative area name","required":false,"schema":{"type":"string"}},{"name":"postCode","in":"query","description":"Filter business partners by postcode or postcodes","required":false,"schema":{"type":"string"}},{"name":"locality","in":"query","description":"Filter business partners by locality full denotation","required":false,"schema":{"type":"string"}},{"name":"thoroughfare","in":"query","description":"Filter business partners by thoroughfare full denotation","required":false,"schema":{"type":"string"}},{"name":"premise","in":"query","description":"Filter business partners by premise full denotation","required":false,"schema":{"type":"string"}},{"name":"postalDeliveryPoint","in":"query","description":"Filter business partners by postal delivery point full denotation","required":false,"schema":{"type":"string"}},{"name":"siteName","in":"query","description":"Filter sites by name","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of business partners matching the search criteria, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"score":{"type":"number","format":"float"},"legalEntity":{"type":"object","properties":{"bpn":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"issuingBody":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"status":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a business partner"}},"names":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACRONYM","DOING_BUSINESS_AS","ESTABLISHMENT","INTERNATIONAL","LOCAL","OTHER","REGISTERED","TRANSLITERATED","VAT_REGISTERED"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Name record of a business partner"}},"legalForm":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"mainAbbreviation":{"type":"string"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}}},"description":"Legal form a business partner can have"},"status":{"type":"object","properties":{"officialDenotation":{"type":"string"},"validFrom":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","DISSOLVED","IN_LIQUIDATION","INACTIVE","INSOLVENCY","UNKNOWN"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Status of a business partner"},"profileClassifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"code":{"type":"string"},"type":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}},"description":"Classification record of a business partner"}},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRAND","LEGAL_ENTITY","ORGANIZATIONAL_UNIT","SITE","UNKNOWN"]},"name":{"type":"string"},"url":{"type":"string"}}}},"bankAccounts":{"type":"array","items":{"type":"object","properties":{"trustScores":{"type":"array","items":{"type":"number","format":"float"}},"currency":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"internationalBankAccountIdentifier":{"type":"string"},"internationalBankIdentifier":{"type":"string"},"nationalBankAccountIdentifier":{"type":"string"},"nationalBankIdentifier":{"type":"string"}},"description":"Bank account record for a business partner"}},"roles":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"relations":{"type":"array","items":{"type":"object","properties":{"relationClass":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["SAAS_HIERARCHY","SAAS_TRANSITION","CX_HIERARCHY","DNB_HIERARCHY","LEI_HIERARCHY"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF","CX_ADDRESS_OF","CX_SITE_OF","CX_OWNED_BY","DIRECT_LEGAL_RELATION","COMMERCIAL_ULTIMATE","DOMESTIC_BRANCH_RELATION","INTERNATIONAL_BRANCH_RELATION","DOMESTIC_LEGAL_ULTIMATE_RELATION","GLOBAL_LEGAL_ULTIMATE_RELATION","LEGAL_PREDECESSOR","LEGAL_SUCCESSOR","DNB_PARENT","DNB_HEADQUARTER","DNB_DOMESTIC_ULTIMATE","DNB_GLOBAL_ULTIMATE","LEI_DIRECT_PARENT","LEI_INTERNATIONAL_BRANCH","LEI_ULTIMATE_PARENT"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"startNode":{"type":"string"},"endNode":{"type":"string"},"startedAt":{"type":"string","format":"date-time"},"endedAt":{"type":"string","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","format":"date-time"}},"description":"Business partner of type legal entity with currentness"}},"description":"Match with score for a business partner record of type legal entity"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed search or pagination request"}},"method":"get","path":"/api/catena/legal-entities","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Get page of legal entity business partners matching the search criteria","description":{"content":"This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score.","type":"text/plain"},"url":{"path":["api","catena","legal-entities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter legal entities by name","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Filter legal entities by legal form name","type":"text/plain"},"key":"legalForm","value":""},{"disabled":false,"description":{"content":"Filter legal entities by status official denotation","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Filter legal entities by classification denotation","type":"text/plain"},"key":"classification","value":""},{"disabled":false,"description":{"content":"Filter business partners by administrative area name","type":"text/plain"},"key":"administrativeArea","value":""},{"disabled":false,"description":{"content":"Filter business partners by postcode or postcodes","type":"text/plain"},"key":"postCode","value":""},{"disabled":false,"description":{"content":"Filter business partners by locality full denotation","type":"text/plain"},"key":"locality","value":""},{"disabled":false,"description":{"content":"Filter business partners by thoroughfare full denotation","type":"text/plain"},"key":"thoroughfare","value":""},{"disabled":false,"description":{"content":"Filter business partners by premise full denotation","type":"text/plain"},"key":"premise","value":""},{"disabled":false,"description":{"content":"Filter business partners by postal delivery point full denotation","type":"text/plain"},"key":"postalDeliveryPoint","value":""},{"disabled":false,"description":{"content":"Filter sites by name","type":"text/plain"},"key":"siteName","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of legal entity business partners matching the search criteria - - - -This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. - -
Query Parameters
- -Page of business partners matching the search criteria, may be empty - -
Schema
    content object[]
    legalEntity object
    - -Business partner of type legal entity with currentness - -
    identifiers object[]
    type object
    issuingBody object
    status object
    - -Named type uniquely identified by its technical key - -
    names object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    legalForm object
    - -Legal form a business partner can have - -
    language object
    - -Named type uniquely identified by its technical key - -
    categories object[]
    status object
    - -Status of a business partner - -
    type object
    profileClassifications object[]
    type object
    - -General type with name and URL link for further information - -
    types object[]
    bankAccounts object[]
    currency object
    - -Named type uniquely identified by its technical key - -
    roles object[]
    relations object[]
    relationClass object
    - -Named type uniquely identified by its technical key - -
    type object
    - -Named type uniquely identified by its technical key - -
- -On malformed search or pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity-1.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity-1.api.mdx deleted file mode 100644 index b623cd8c7e6..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity-1.api.mdx +++ /dev/null @@ -1,122 +0,0 @@ ---- -id: get-legal-entity-1 -title: "Get business partner by identifier" -description: "This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type." -sidebar_label: "Get business partner by identifier" -hide_title: true -hide_table_of_contents: true -api: {"tags":["business-partner-legacy-controller"],"description":"This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type.","operationId":"getLegalEntity_1","parameters":[{"name":"idValue","in":"path","description":"Identifier value","required":true,"schema":{"type":"string"}},{"name":"idType","in":"query","description":"Type of identifier to use, defaults to BPN when omitted","required":false,"schema":{"type":"string","default":"BPN"}}],"responses":{"200":{"description":"Found business partner with specified identifier","content":{"*/*":{"schema":{"type":"object","properties":{"uuid":{"type":"string"},"bpn":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"issuingBody":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"status":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a business partner"}},"names":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACRONYM","DOING_BUSINESS_AS","ESTABLISHMENT","INTERNATIONAL","LOCAL","OTHER","REGISTERED","TRANSLITERATED","VAT_REGISTERED"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Name record of a business partner"}},"legalForm":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"mainAbbreviation":{"type":"string"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}}},"description":"Legal form a business partner can have"},"status":{"type":"object","properties":{"officialDenotation":{"type":"string"},"validFrom":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","DISSOLVED","IN_LIQUIDATION","INACTIVE","INSOLVENCY","UNKNOWN"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Status of a business partner"},"profileClassifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"code":{"type":"string"},"type":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}},"description":"Classification record of a business partner"}},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRAND","LEGAL_ENTITY","ORGANIZATIONAL_UNIT","SITE","UNKNOWN"]},"name":{"type":"string"},"url":{"type":"string"}}}},"bankAccounts":{"type":"array","items":{"type":"object","properties":{"trustScores":{"type":"array","items":{"type":"number","format":"float"}},"currency":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"internationalBankAccountIdentifier":{"type":"string"},"internationalBankIdentifier":{"type":"string"},"nationalBankAccountIdentifier":{"type":"string"},"nationalBankIdentifier":{"type":"string"}},"description":"Bank account record for a business partner"}},"roles":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"relations":{"type":"array","items":{"type":"object","properties":{"relationClass":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["SAAS_HIERARCHY","SAAS_TRANSITION","CX_HIERARCHY","DNB_HIERARCHY","LEI_HIERARCHY"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF","CX_ADDRESS_OF","CX_SITE_OF","CX_OWNED_BY","DIRECT_LEGAL_RELATION","COMMERCIAL_ULTIMATE","DOMESTIC_BRANCH_RELATION","INTERNATIONAL_BRANCH_RELATION","DOMESTIC_LEGAL_ULTIMATE_RELATION","GLOBAL_LEGAL_ULTIMATE_RELATION","LEGAL_PREDECESSOR","LEGAL_SUCCESSOR","DNB_PARENT","DNB_HEADQUARTER","DNB_DOMESTIC_ULTIMATE","DNB_GLOBAL_ULTIMATE","LEI_DIRECT_PARENT","LEI_INTERNATIONAL_BRANCH","LEI_ULTIMATE_PARENT"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"startNode":{"type":"string"},"endNode":{"type":"string"},"startedAt":{"type":"string","format":"date-time"},"endedAt":{"type":"string","format":"date-time"}},"description":"Directed relation between two business partners"}},"addresses":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string"},"version":{"type":"object","properties":{"characterSet":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Localization record of an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["COUNTY","REGION","OTHER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Area of an address such as country region or county"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Postcode record of an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Locality record of an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Thoroughfare record of an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Premise record of an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Postal delivery point record of an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]},"name":{"type":"string"},"url":{"type":"string"}}}}},"description":"Business partner of type address"}},"sites":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string"},"name":{"type":"string"}},"description":"Business partner of type site"}},"currentness":{"type":"string","format":"date-time"}},"description":"Business Partner of type legal entity in deprecated response format","deprecated":true}}}},"400":{"description":"On malformed request parameters"},"404":{"description":"No business partner found under specified identifier or specified identifier type not found"}},"deprecated":true,"method":"get","path":"/api/catena/business-partner/{idValue}","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Get business partner by identifier","description":{"content":"This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type.","type":"text/plain"},"url":{"path":["api","catena","business-partner",":idValue"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Type of identifier to use, defaults to BPN when omitted","type":"text/plain"},"key":"idType","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Identifier value","type":"text/plain"},"type":"any","value":"","key":"idValue"}]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get business partner by identifier - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type. - -
Path Parameters
Query Parameters
- -Found business partner with specified identifier - -
Schema
    identifiers object[]
    type object
    issuingBody object
    status object
    - -Named type uniquely identified by its technical key - -
    names object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    legalForm object
    - -Legal form a business partner can have - -
    language object
    - -Named type uniquely identified by its technical key - -
    categories object[]
    status object
    - -Status of a business partner - -
    type object
    profileClassifications object[]
    type object
    - -General type with name and URL link for further information - -
    types object[]
    bankAccounts object[]
    currency object
    - -Named type uniquely identified by its technical key - -
    roles object[]
    relations object[]
    relationClass object
    - -Named type uniquely identified by its technical key - -
    type object
    - -Named type uniquely identified by its technical key - -
    addresses object[]
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
    sites object[]
- -On malformed request parameters - -
- -No business partner found under specified identifier or specified identifier type not found - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity.api.mdx deleted file mode 100644 index 7de73899e66..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity.api.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -id: get-legal-entity -title: "Get legal entity business partner by identifier" -description: "This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type." -sidebar_label: "Get legal entity business partner by identifier" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type.","operationId":"getLegalEntity","parameters":[{"name":"idValue","in":"path","description":"Identifier value","required":true,"schema":{"type":"string"}},{"name":"idType","in":"query","description":"Type of identifier to use, defaults to BPN when omitted","required":false,"schema":{"type":"string","default":"BPN"}}],"responses":{"200":{"description":"Found business partner with specified identifier","content":{"*/*":{"schema":{"type":"object","properties":{"bpn":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"issuingBody":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"status":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a business partner"}},"names":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACRONYM","DOING_BUSINESS_AS","ESTABLISHMENT","INTERNATIONAL","LOCAL","OTHER","REGISTERED","TRANSLITERATED","VAT_REGISTERED"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Name record of a business partner"}},"legalForm":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"mainAbbreviation":{"type":"string"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}}},"description":"Legal form a business partner can have"},"status":{"type":"object","properties":{"officialDenotation":{"type":"string"},"validFrom":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","DISSOLVED","IN_LIQUIDATION","INACTIVE","INSOLVENCY","UNKNOWN"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Status of a business partner"},"profileClassifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"code":{"type":"string"},"type":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}},"description":"Classification record of a business partner"}},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRAND","LEGAL_ENTITY","ORGANIZATIONAL_UNIT","SITE","UNKNOWN"]},"name":{"type":"string"},"url":{"type":"string"}}}},"bankAccounts":{"type":"array","items":{"type":"object","properties":{"trustScores":{"type":"array","items":{"type":"number","format":"float"}},"currency":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"internationalBankAccountIdentifier":{"type":"string"},"internationalBankIdentifier":{"type":"string"},"nationalBankAccountIdentifier":{"type":"string"},"nationalBankIdentifier":{"type":"string"}},"description":"Bank account record for a business partner"}},"roles":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"relations":{"type":"array","items":{"type":"object","properties":{"relationClass":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["SAAS_HIERARCHY","SAAS_TRANSITION","CX_HIERARCHY","DNB_HIERARCHY","LEI_HIERARCHY"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF","CX_ADDRESS_OF","CX_SITE_OF","CX_OWNED_BY","DIRECT_LEGAL_RELATION","COMMERCIAL_ULTIMATE","DOMESTIC_BRANCH_RELATION","INTERNATIONAL_BRANCH_RELATION","DOMESTIC_LEGAL_ULTIMATE_RELATION","GLOBAL_LEGAL_ULTIMATE_RELATION","LEGAL_PREDECESSOR","LEGAL_SUCCESSOR","DNB_PARENT","DNB_HEADQUARTER","DNB_DOMESTIC_ULTIMATE","DNB_GLOBAL_ULTIMATE","LEI_DIRECT_PARENT","LEI_INTERNATIONAL_BRANCH","LEI_ULTIMATE_PARENT"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"startNode":{"type":"string"},"endNode":{"type":"string"},"startedAt":{"type":"string","format":"date-time"},"endedAt":{"type":"string","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","format":"date-time"}},"description":"Business partner of type legal entity with currentness"}}}},"400":{"description":"On malformed request parameters"},"404":{"description":"No business partner found under specified identifier or specified identifier type not found"}},"method":"get","path":"/api/catena/legal-entities/{idValue}","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Get legal entity business partner by identifier","description":{"content":"This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type.","type":"text/plain"},"url":{"path":["api","catena","legal-entities",":idValue"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Type of identifier to use, defaults to BPN when omitted","type":"text/plain"},"key":"idType","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Identifier value","type":"text/plain"},"type":"any","value":"","key":"idValue"}]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get legal entity business partner by identifier - - - -This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type. - -
Path Parameters
Query Parameters
- -Found business partner with specified identifier - -
Schema
    identifiers object[]
    type object
    issuingBody object
    status object
    - -Named type uniquely identified by its technical key - -
    names object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    legalForm object
    - -Legal form a business partner can have - -
    language object
    - -Named type uniquely identified by its technical key - -
    categories object[]
    status object
    - -Status of a business partner - -
    type object
    profileClassifications object[]
    type object
    - -General type with name and URL link for further information - -
    types object[]
    bankAccounts object[]
    currency object
    - -Named type uniquely identified by its technical key - -
    roles object[]
    relations object[]
    relationClass object
    - -Named type uniquely identified by its technical key - -
    type object
    - -Named type uniquely identified by its technical key - -
- -On malformed request parameters - -
- -No business partner found under specified identifier or specified identifier type not found - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-form-suggestion.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-form-suggestion.api.mdx deleted file mode 100644 index 26f75a8a1ce..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-form-suggestion.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-legal-form-suggestion -title: "Find best matches for given text in business partner legal forms" -description: "Performs search on legal form names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible legal form names in the search set." -sidebar_label: "Find best matches for given text in business partner legal forms" -hide_title: true -hide_table_of_contents: true -api: {"tags":["suggestion-controller"],"description":"Performs search on legal form names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible legal form names in the search set.","operationId":"getLegalFormSuggestion","parameters":[{"name":"text","in":"query","description":"Show legal form names best matching this text","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter legal entities by name","required":false,"schema":{"type":"string"}},{"name":"legalForm","in":"query","description":"Filter legal entities by legal form name","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter legal entities by status official denotation","required":false,"schema":{"type":"string"}},{"name":"classification","in":"query","description":"Filter legal entities by classification denotation","required":false,"schema":{"type":"string"}},{"name":"administrativeArea","in":"query","description":"Filter business partners by administrative area name","required":false,"schema":{"type":"string"}},{"name":"postCode","in":"query","description":"Filter business partners by postcode or postcodes","required":false,"schema":{"type":"string"}},{"name":"locality","in":"query","description":"Filter business partners by locality full denotation","required":false,"schema":{"type":"string"}},{"name":"thoroughfare","in":"query","description":"Filter business partners by thoroughfare full denotation","required":false,"schema":{"type":"string"}},{"name":"premise","in":"query","description":"Filter business partners by premise full denotation","required":false,"schema":{"type":"string"}},{"name":"postalDeliveryPoint","in":"query","description":"Filter business partners by postal delivery point full denotation","required":false,"schema":{"type":"string"}},{"name":"siteName","in":"query","description":"Filter sites by name","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Best matches found, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"suggestion":{"type":"string"},"relevancy":{"type":"number","format":"float"}},"description":"Shows a ranked suggestion based on a given search text"}}},"description":"Paginated collection of results"}}}}},"method":"get","path":"/api/catena/suggestions/legal-entities/legal-forms","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Find best matches for given text in business partner legal forms","description":{"content":"Performs search on legal form names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible legal form names in the search set.","type":"text/plain"},"url":{"path":["api","catena","suggestions","legal-entities","legal-forms"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Show legal form names best matching this text","type":"text/plain"},"key":"text","value":""},{"disabled":false,"description":{"content":"Filter legal entities by name","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Filter legal entities by legal form name","type":"text/plain"},"key":"legalForm","value":""},{"disabled":false,"description":{"content":"Filter legal entities by status official denotation","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Filter legal entities by classification denotation","type":"text/plain"},"key":"classification","value":""},{"disabled":false,"description":{"content":"Filter business partners by administrative area name","type":"text/plain"},"key":"administrativeArea","value":""},{"disabled":false,"description":{"content":"Filter business partners by postcode or postcodes","type":"text/plain"},"key":"postCode","value":""},{"disabled":false,"description":{"content":"Filter business partners by locality full denotation","type":"text/plain"},"key":"locality","value":""},{"disabled":false,"description":{"content":"Filter business partners by thoroughfare full denotation","type":"text/plain"},"key":"thoroughfare","value":""},{"disabled":false,"description":{"content":"Filter business partners by premise full denotation","type":"text/plain"},"key":"premise","value":""},{"disabled":false,"description":{"content":"Filter business partners by postal delivery point full denotation","type":"text/plain"},"key":"postalDeliveryPoint","value":""},{"disabled":false,"description":{"content":"Filter sites by name","type":"text/plain"},"key":"siteName","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Find best matches for given text in business partner legal forms - - - -Performs search on legal form names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible legal form names in the search set. - -
Query Parameters
- -Best matches found, may be empty - -
Schema
    content object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms.api.mdx deleted file mode 100644 index 12e47b86181..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-legal-forms -title: "Get page of legal forms" -description: "Lists all currently known legal forms in a paginated result" -sidebar_label: "Get page of legal forms" -hide_title: true -hide_table_of_contents: true -api: {"tags":["metadata-controller"],"description":"Lists all currently known legal forms in a paginated result","operationId":"getLegalForms","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of existing legal forms, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"mainAbbreviation":{"type":"string"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}}},"description":"Legal form a business partner can have"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters"}},"method":"get","path":"/api/catena/legal-forms","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Get page of legal forms","description":{"content":"Lists all currently known legal forms in a paginated result","type":"text/plain"},"url":{"path":["api","catena","legal-forms"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of legal forms - - - -Lists all currently known legal forms in a paginated result - -
Query Parameters
- -Page of existing legal forms, may be empty - -
Schema
    content object[]
    language object
    - -Named type uniquely identified by its technical key - -
    categories object[]
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-locality-suggestion.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-locality-suggestion.api.mdx deleted file mode 100644 index a1a333f4938..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-locality-suggestion.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-locality-suggestion -title: "Find best matches for given text in localities" -description: "Performs search on locality denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible locality names in the search set." -sidebar_label: "Find best matches for given text in localities" -hide_title: true -hide_table_of_contents: true -api: {"tags":["suggestion-controller"],"description":"Performs search on locality denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible locality names in the search set.","operationId":"getLocalitySuggestion","parameters":[{"name":"text","in":"query","description":"Show locality names this text","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter legal entities by name","required":false,"schema":{"type":"string"}},{"name":"legalForm","in":"query","description":"Filter legal entities by legal form name","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter legal entities by status official denotation","required":false,"schema":{"type":"string"}},{"name":"classification","in":"query","description":"Filter legal entities by classification denotation","required":false,"schema":{"type":"string"}},{"name":"administrativeArea","in":"query","description":"Filter business partners by administrative area name","required":false,"schema":{"type":"string"}},{"name":"postCode","in":"query","description":"Filter business partners by postcode or postcodes","required":false,"schema":{"type":"string"}},{"name":"locality","in":"query","description":"Filter business partners by locality full denotation","required":false,"schema":{"type":"string"}},{"name":"thoroughfare","in":"query","description":"Filter business partners by thoroughfare full denotation","required":false,"schema":{"type":"string"}},{"name":"premise","in":"query","description":"Filter business partners by premise full denotation","required":false,"schema":{"type":"string"}},{"name":"postalDeliveryPoint","in":"query","description":"Filter business partners by postal delivery point full denotation","required":false,"schema":{"type":"string"}},{"name":"siteName","in":"query","description":"Filter sites by name","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Best matches found, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"suggestion":{"type":"string"},"relevancy":{"type":"number","format":"float"}},"description":"Shows a ranked suggestion based on a given search text"}}},"description":"Paginated collection of results"}}}}},"method":"get","path":"/api/catena/suggestions/addresses/localities","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Find best matches for given text in localities","description":{"content":"Performs search on locality denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible locality names in the search set.","type":"text/plain"},"url":{"path":["api","catena","suggestions","addresses","localities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Show locality names this text","type":"text/plain"},"key":"text","value":""},{"disabled":false,"description":{"content":"Filter legal entities by name","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Filter legal entities by legal form name","type":"text/plain"},"key":"legalForm","value":""},{"disabled":false,"description":{"content":"Filter legal entities by status official denotation","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Filter legal entities by classification denotation","type":"text/plain"},"key":"classification","value":""},{"disabled":false,"description":{"content":"Filter business partners by administrative area name","type":"text/plain"},"key":"administrativeArea","value":""},{"disabled":false,"description":{"content":"Filter business partners by postcode or postcodes","type":"text/plain"},"key":"postCode","value":""},{"disabled":false,"description":{"content":"Filter business partners by locality full denotation","type":"text/plain"},"key":"locality","value":""},{"disabled":false,"description":{"content":"Filter business partners by thoroughfare full denotation","type":"text/plain"},"key":"thoroughfare","value":""},{"disabled":false,"description":{"content":"Filter business partners by premise full denotation","type":"text/plain"},"key":"premise","value":""},{"disabled":false,"description":{"content":"Filter business partners by postal delivery point full denotation","type":"text/plain"},"key":"postalDeliveryPoint","value":""},{"disabled":false,"description":{"content":"Filter sites by name","type":"text/plain"},"key":"siteName","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Find best matches for given text in localities - - - -Performs search on locality denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible locality names in the search set. - -
Query Parameters
- -Best matches found, may be empty - -
Schema
    content object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-name-suggestion.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-name-suggestion.api.mdx deleted file mode 100644 index 100d61b4d1a..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-name-suggestion.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-name-suggestion -title: "Find best matches for given text in business partner names" -description: "Performs search on business partner names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible names in the search set." -sidebar_label: "Find best matches for given text in business partner names" -hide_title: true -hide_table_of_contents: true -api: {"tags":["suggestion-controller"],"description":"Performs search on business partner names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible names in the search set.","operationId":"getNameSuggestion","parameters":[{"name":"text","in":"query","description":"Show names best matching this text","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter legal entities by name","required":false,"schema":{"type":"string"}},{"name":"legalForm","in":"query","description":"Filter legal entities by legal form name","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter legal entities by status official denotation","required":false,"schema":{"type":"string"}},{"name":"classification","in":"query","description":"Filter legal entities by classification denotation","required":false,"schema":{"type":"string"}},{"name":"administrativeArea","in":"query","description":"Filter business partners by administrative area name","required":false,"schema":{"type":"string"}},{"name":"postCode","in":"query","description":"Filter business partners by postcode or postcodes","required":false,"schema":{"type":"string"}},{"name":"locality","in":"query","description":"Filter business partners by locality full denotation","required":false,"schema":{"type":"string"}},{"name":"thoroughfare","in":"query","description":"Filter business partners by thoroughfare full denotation","required":false,"schema":{"type":"string"}},{"name":"premise","in":"query","description":"Filter business partners by premise full denotation","required":false,"schema":{"type":"string"}},{"name":"postalDeliveryPoint","in":"query","description":"Filter business partners by postal delivery point full denotation","required":false,"schema":{"type":"string"}},{"name":"siteName","in":"query","description":"Filter sites by name","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Best matches found, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"suggestion":{"type":"string"},"relevancy":{"type":"number","format":"float"}},"description":"Shows a ranked suggestion based on a given search text"}}},"description":"Paginated collection of results"}}}}},"method":"get","path":"/api/catena/suggestions/legal-entities/names","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Find best matches for given text in business partner names","description":{"content":"Performs search on business partner names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible names in the search set.","type":"text/plain"},"url":{"path":["api","catena","suggestions","legal-entities","names"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Show names best matching this text","type":"text/plain"},"key":"text","value":""},{"disabled":false,"description":{"content":"Filter legal entities by name","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Filter legal entities by legal form name","type":"text/plain"},"key":"legalForm","value":""},{"disabled":false,"description":{"content":"Filter legal entities by status official denotation","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Filter legal entities by classification denotation","type":"text/plain"},"key":"classification","value":""},{"disabled":false,"description":{"content":"Filter business partners by administrative area name","type":"text/plain"},"key":"administrativeArea","value":""},{"disabled":false,"description":{"content":"Filter business partners by postcode or postcodes","type":"text/plain"},"key":"postCode","value":""},{"disabled":false,"description":{"content":"Filter business partners by locality full denotation","type":"text/plain"},"key":"locality","value":""},{"disabled":false,"description":{"content":"Filter business partners by thoroughfare full denotation","type":"text/plain"},"key":"thoroughfare","value":""},{"disabled":false,"description":{"content":"Filter business partners by premise full denotation","type":"text/plain"},"key":"premise","value":""},{"disabled":false,"description":{"content":"Filter business partners by postal delivery point full denotation","type":"text/plain"},"key":"postalDeliveryPoint","value":""},{"disabled":false,"description":{"content":"Filter sites by name","type":"text/plain"},"key":"siteName","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Find best matches for given text in business partner names - - - -Performs search on business partner names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible names in the search set. - -
Query Parameters
- -Best matches found, may be empty - -
Schema
    content object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-postal-deliver-point-suggestion.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-postal-deliver-point-suggestion.api.mdx deleted file mode 100644 index ee82431a43f..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-postal-deliver-point-suggestion.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-postal-deliver-point-suggestion -title: "Find best matches for given text in postal delivery points" -description: "Performs search on postal delivery point denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible postal delivery point names in the search set." -sidebar_label: "Find best matches for given text in postal delivery points" -hide_title: true -hide_table_of_contents: true -api: {"tags":["suggestion-controller"],"description":"Performs search on postal delivery point denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible postal delivery point names in the search set.","operationId":"getPostalDeliverPointSuggestion","parameters":[{"name":"text","in":"query","description":"Show postal delivery point names best matching this text","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter legal entities by name","required":false,"schema":{"type":"string"}},{"name":"legalForm","in":"query","description":"Filter legal entities by legal form name","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter legal entities by status official denotation","required":false,"schema":{"type":"string"}},{"name":"classification","in":"query","description":"Filter legal entities by classification denotation","required":false,"schema":{"type":"string"}},{"name":"administrativeArea","in":"query","description":"Filter business partners by administrative area name","required":false,"schema":{"type":"string"}},{"name":"postCode","in":"query","description":"Filter business partners by postcode or postcodes","required":false,"schema":{"type":"string"}},{"name":"locality","in":"query","description":"Filter business partners by locality full denotation","required":false,"schema":{"type":"string"}},{"name":"thoroughfare","in":"query","description":"Filter business partners by thoroughfare full denotation","required":false,"schema":{"type":"string"}},{"name":"premise","in":"query","description":"Filter business partners by premise full denotation","required":false,"schema":{"type":"string"}},{"name":"postalDeliveryPoint","in":"query","description":"Filter business partners by postal delivery point full denotation","required":false,"schema":{"type":"string"}},{"name":"siteName","in":"query","description":"Filter sites by name","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Best matches found, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"suggestion":{"type":"string"},"relevancy":{"type":"number","format":"float"}},"description":"Shows a ranked suggestion based on a given search text"}}},"description":"Paginated collection of results"}}}}},"method":"get","path":"/api/catena/suggestions/addresses/postal-delivery-points","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Find best matches for given text in postal delivery points","description":{"content":"Performs search on postal delivery point denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible postal delivery point names in the search set.","type":"text/plain"},"url":{"path":["api","catena","suggestions","addresses","postal-delivery-points"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Show postal delivery point names best matching this text","type":"text/plain"},"key":"text","value":""},{"disabled":false,"description":{"content":"Filter legal entities by name","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Filter legal entities by legal form name","type":"text/plain"},"key":"legalForm","value":""},{"disabled":false,"description":{"content":"Filter legal entities by status official denotation","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Filter legal entities by classification denotation","type":"text/plain"},"key":"classification","value":""},{"disabled":false,"description":{"content":"Filter business partners by administrative area name","type":"text/plain"},"key":"administrativeArea","value":""},{"disabled":false,"description":{"content":"Filter business partners by postcode or postcodes","type":"text/plain"},"key":"postCode","value":""},{"disabled":false,"description":{"content":"Filter business partners by locality full denotation","type":"text/plain"},"key":"locality","value":""},{"disabled":false,"description":{"content":"Filter business partners by thoroughfare full denotation","type":"text/plain"},"key":"thoroughfare","value":""},{"disabled":false,"description":{"content":"Filter business partners by premise full denotation","type":"text/plain"},"key":"premise","value":""},{"disabled":false,"description":{"content":"Filter business partners by postal delivery point full denotation","type":"text/plain"},"key":"postalDeliveryPoint","value":""},{"disabled":false,"description":{"content":"Filter sites by name","type":"text/plain"},"key":"siteName","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Find best matches for given text in postal delivery points - - - -Performs search on postal delivery point denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible postal delivery point names in the search set. - -
Query Parameters
- -Best matches found, may be empty - -
Schema
    content object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-postcode-suggestion.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-postcode-suggestion.api.mdx deleted file mode 100644 index 73ee42b5197..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-postcode-suggestion.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-postcode-suggestion -title: "Find best matches for given text in postcodes" -description: "Performs search on postcode values in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible postcode values in the search set." -sidebar_label: "Find best matches for given text in postcodes" -hide_title: true -hide_table_of_contents: true -api: {"tags":["suggestion-controller"],"description":"Performs search on postcode values in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible postcode values in the search set.","operationId":"getPostcodeSuggestion","parameters":[{"name":"text","in":"query","description":"Show postcodes best matching this text","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter legal entities by name","required":false,"schema":{"type":"string"}},{"name":"legalForm","in":"query","description":"Filter legal entities by legal form name","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter legal entities by status official denotation","required":false,"schema":{"type":"string"}},{"name":"classification","in":"query","description":"Filter legal entities by classification denotation","required":false,"schema":{"type":"string"}},{"name":"administrativeArea","in":"query","description":"Filter business partners by administrative area name","required":false,"schema":{"type":"string"}},{"name":"postCode","in":"query","description":"Filter business partners by postcode or postcodes","required":false,"schema":{"type":"string"}},{"name":"locality","in":"query","description":"Filter business partners by locality full denotation","required":false,"schema":{"type":"string"}},{"name":"thoroughfare","in":"query","description":"Filter business partners by thoroughfare full denotation","required":false,"schema":{"type":"string"}},{"name":"premise","in":"query","description":"Filter business partners by premise full denotation","required":false,"schema":{"type":"string"}},{"name":"postalDeliveryPoint","in":"query","description":"Filter business partners by postal delivery point full denotation","required":false,"schema":{"type":"string"}},{"name":"siteName","in":"query","description":"Filter sites by name","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Best matches found, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"suggestion":{"type":"string"},"relevancy":{"type":"number","format":"float"}},"description":"Shows a ranked suggestion based on a given search text"}}},"description":"Paginated collection of results"}}}}},"method":"get","path":"/api/catena/suggestions/addresses/postcodes","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Find best matches for given text in postcodes","description":{"content":"Performs search on postcode values in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible postcode values in the search set.","type":"text/plain"},"url":{"path":["api","catena","suggestions","addresses","postcodes"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Show postcodes best matching this text","type":"text/plain"},"key":"text","value":""},{"disabled":false,"description":{"content":"Filter legal entities by name","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Filter legal entities by legal form name","type":"text/plain"},"key":"legalForm","value":""},{"disabled":false,"description":{"content":"Filter legal entities by status official denotation","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Filter legal entities by classification denotation","type":"text/plain"},"key":"classification","value":""},{"disabled":false,"description":{"content":"Filter business partners by administrative area name","type":"text/plain"},"key":"administrativeArea","value":""},{"disabled":false,"description":{"content":"Filter business partners by postcode or postcodes","type":"text/plain"},"key":"postCode","value":""},{"disabled":false,"description":{"content":"Filter business partners by locality full denotation","type":"text/plain"},"key":"locality","value":""},{"disabled":false,"description":{"content":"Filter business partners by thoroughfare full denotation","type":"text/plain"},"key":"thoroughfare","value":""},{"disabled":false,"description":{"content":"Filter business partners by premise full denotation","type":"text/plain"},"key":"premise","value":""},{"disabled":false,"description":{"content":"Filter business partners by postal delivery point full denotation","type":"text/plain"},"key":"postalDeliveryPoint","value":""},{"disabled":false,"description":{"content":"Filter sites by name","type":"text/plain"},"key":"siteName","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Find best matches for given text in postcodes - - - -Performs search on postcode values in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible postcode values in the search set. - -
Query Parameters
- -Best matches found, may be empty - -
Schema
    content object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-premise-suggestion.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-premise-suggestion.api.mdx deleted file mode 100644 index 2284436a6bd..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-premise-suggestion.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-premise-suggestion -title: "Find best matches for given text in premises" -description: "Performs search on premise denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible premise names in the search set." -sidebar_label: "Find best matches for given text in premises" -hide_title: true -hide_table_of_contents: true -api: {"tags":["suggestion-controller"],"description":"Performs search on premise denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible premise names in the search set.","operationId":"getPremiseSuggestion","parameters":[{"name":"text","in":"query","description":"Show premise names best matching this text","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter legal entities by name","required":false,"schema":{"type":"string"}},{"name":"legalForm","in":"query","description":"Filter legal entities by legal form name","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter legal entities by status official denotation","required":false,"schema":{"type":"string"}},{"name":"classification","in":"query","description":"Filter legal entities by classification denotation","required":false,"schema":{"type":"string"}},{"name":"administrativeArea","in":"query","description":"Filter business partners by administrative area name","required":false,"schema":{"type":"string"}},{"name":"postCode","in":"query","description":"Filter business partners by postcode or postcodes","required":false,"schema":{"type":"string"}},{"name":"locality","in":"query","description":"Filter business partners by locality full denotation","required":false,"schema":{"type":"string"}},{"name":"thoroughfare","in":"query","description":"Filter business partners by thoroughfare full denotation","required":false,"schema":{"type":"string"}},{"name":"premise","in":"query","description":"Filter business partners by premise full denotation","required":false,"schema":{"type":"string"}},{"name":"postalDeliveryPoint","in":"query","description":"Filter business partners by postal delivery point full denotation","required":false,"schema":{"type":"string"}},{"name":"siteName","in":"query","description":"Filter sites by name","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Best matches found, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"suggestion":{"type":"string"},"relevancy":{"type":"number","format":"float"}},"description":"Shows a ranked suggestion based on a given search text"}}},"description":"Paginated collection of results"}}}}},"method":"get","path":"/api/catena/suggestions/addresses/premises","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Find best matches for given text in premises","description":{"content":"Performs search on premise denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible premise names in the search set.","type":"text/plain"},"url":{"path":["api","catena","suggestions","addresses","premises"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Show premise names best matching this text","type":"text/plain"},"key":"text","value":""},{"disabled":false,"description":{"content":"Filter legal entities by name","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Filter legal entities by legal form name","type":"text/plain"},"key":"legalForm","value":""},{"disabled":false,"description":{"content":"Filter legal entities by status official denotation","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Filter legal entities by classification denotation","type":"text/plain"},"key":"classification","value":""},{"disabled":false,"description":{"content":"Filter business partners by administrative area name","type":"text/plain"},"key":"administrativeArea","value":""},{"disabled":false,"description":{"content":"Filter business partners by postcode or postcodes","type":"text/plain"},"key":"postCode","value":""},{"disabled":false,"description":{"content":"Filter business partners by locality full denotation","type":"text/plain"},"key":"locality","value":""},{"disabled":false,"description":{"content":"Filter business partners by thoroughfare full denotation","type":"text/plain"},"key":"thoroughfare","value":""},{"disabled":false,"description":{"content":"Filter business partners by premise full denotation","type":"text/plain"},"key":"premise","value":""},{"disabled":false,"description":{"content":"Filter business partners by postal delivery point full denotation","type":"text/plain"},"key":"postalDeliveryPoint","value":""},{"disabled":false,"description":{"content":"Filter sites by name","type":"text/plain"},"key":"siteName","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Find best matches for given text in premises - - - -Performs search on premise denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible premise names in the search set. - -
Query Parameters
- -Best matches found, may be empty - -
Schema
    content object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-site-suggestion.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-site-suggestion.api.mdx deleted file mode 100644 index 1ad86559a5f..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-site-suggestion.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-site-suggestion -title: "Find best matches for given text in business partner sites" -description: "Performs search on site names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible site names in the search set." -sidebar_label: "Find best matches for given text in business partner sites" -hide_title: true -hide_table_of_contents: true -api: {"tags":["suggestion-controller"],"description":"Performs search on site names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible site names in the search set.","operationId":"getSiteSuggestion","parameters":[{"name":"text","in":"query","description":"Show site names best matching this text","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter legal entities by name","required":false,"schema":{"type":"string"}},{"name":"legalForm","in":"query","description":"Filter legal entities by legal form name","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter legal entities by status official denotation","required":false,"schema":{"type":"string"}},{"name":"classification","in":"query","description":"Filter legal entities by classification denotation","required":false,"schema":{"type":"string"}},{"name":"administrativeArea","in":"query","description":"Filter business partners by administrative area name","required":false,"schema":{"type":"string"}},{"name":"postCode","in":"query","description":"Filter business partners by postcode or postcodes","required":false,"schema":{"type":"string"}},{"name":"locality","in":"query","description":"Filter business partners by locality full denotation","required":false,"schema":{"type":"string"}},{"name":"thoroughfare","in":"query","description":"Filter business partners by thoroughfare full denotation","required":false,"schema":{"type":"string"}},{"name":"premise","in":"query","description":"Filter business partners by premise full denotation","required":false,"schema":{"type":"string"}},{"name":"postalDeliveryPoint","in":"query","description":"Filter business partners by postal delivery point full denotation","required":false,"schema":{"type":"string"}},{"name":"siteName","in":"query","description":"Filter sites by name","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Best matches found, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"suggestion":{"type":"string"},"relevancy":{"type":"number","format":"float"}},"description":"Shows a ranked suggestion based on a given search text"}}},"description":"Paginated collection of results"}}}}},"method":"get","path":"/api/catena/suggestions/sites/names","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Find best matches for given text in business partner sites","description":{"content":"Performs search on site names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible site names in the search set.","type":"text/plain"},"url":{"path":["api","catena","suggestions","sites","names"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Show site names best matching this text","type":"text/plain"},"key":"text","value":""},{"disabled":false,"description":{"content":"Filter legal entities by name","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Filter legal entities by legal form name","type":"text/plain"},"key":"legalForm","value":""},{"disabled":false,"description":{"content":"Filter legal entities by status official denotation","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Filter legal entities by classification denotation","type":"text/plain"},"key":"classification","value":""},{"disabled":false,"description":{"content":"Filter business partners by administrative area name","type":"text/plain"},"key":"administrativeArea","value":""},{"disabled":false,"description":{"content":"Filter business partners by postcode or postcodes","type":"text/plain"},"key":"postCode","value":""},{"disabled":false,"description":{"content":"Filter business partners by locality full denotation","type":"text/plain"},"key":"locality","value":""},{"disabled":false,"description":{"content":"Filter business partners by thoroughfare full denotation","type":"text/plain"},"key":"thoroughfare","value":""},{"disabled":false,"description":{"content":"Filter business partners by premise full denotation","type":"text/plain"},"key":"premise","value":""},{"disabled":false,"description":{"content":"Filter business partners by postal delivery point full denotation","type":"text/plain"},"key":"postalDeliveryPoint","value":""},{"disabled":false,"description":{"content":"Filter sites by name","type":"text/plain"},"key":"siteName","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Find best matches for given text in business partner sites - - - -Performs search on site names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible site names in the search set. - -
Query Parameters
- -Best matches found, may be empty - -
Schema
    content object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-site.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-site.api.mdx deleted file mode 100644 index 5b4c9567135..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-site.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-site -title: "Get site partners by bpn" -description: "Get business partners of type site by bpn-s ignoring case." -sidebar_label: "Get site partners by bpn" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Get business partners of type site by bpn-s ignoring case.","operationId":"getSite","parameters":[{"name":"bpn","in":"path","description":"Bpn value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found site with specified bpn","content":{"*/*":{"schema":{"type":"object","properties":{"site":{"type":"object","properties":{"bpn":{"type":"string"},"name":{"type":"string"}},"description":"Business partner of type site"},"bpnLegalEntity":{"type":"string"}},"description":"Business partner of type site with parent BPN"}}}},"400":{"description":"On malformed request parameters"},"404":{"description":"No site found under specified bpn"}},"method":"get","path":"/api/catena/sites/{bpn}","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Get site partners by bpn","description":{"content":"Get business partners of type site by bpn-s ignoring case.","type":"text/plain"},"url":{"path":["api","catena","sites",":bpn"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Bpn value","type":"text/plain"},"type":"any","value":"","key":"bpn"}]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get site partners by bpn - - - -Get business partners of type site by bpn-s ignoring case. - -
Path Parameters
- -Found site with specified bpn - -
Schema
    site object
    - -Business partner of type site - -
- -On malformed request parameters - -
- -No site found under specified bpn - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-sites.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-sites.api.mdx deleted file mode 100644 index bfa8e6db012..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-sites.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-sites -title: "Get site partners of a legal entity" -description: "Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpn ignoring case." -sidebar_label: "Get site partners of a legal entity" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpn ignoring case.","operationId":"getSites","parameters":[{"name":"bpn","in":"path","description":"Bpn value","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"The sites for the specified bpn","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string"},"name":{"type":"string"}},"description":"Business partner of type site"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"},"404":{"description":"No business partner found for specified bpn"}},"method":"get","path":"/api/catena/legal-entities/{bpn}/sites","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Get site partners of a legal entity","description":{"content":"Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpn ignoring case.","type":"text/plain"},"url":{"path":["api","catena","legal-entities",":bpn","sites"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Bpn value","type":"text/plain"},"type":"any","value":"","key":"bpn"}]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get site partners of a legal entity - - - -Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpn ignoring case. - -
Path Parameters
Query Parameters
- -The sites for the specified bpn - -
Schema
    content object[]
- -On malformed pagination request - -
- -No business partner found for specified bpn - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-status-suggestion.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-status-suggestion.api.mdx deleted file mode 100644 index be47f486208..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-status-suggestion.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-status-suggestion -title: "Find best matches for given text in business statuses" -description: "Performs search on business status denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible business status denotations in the search set." -sidebar_label: "Find best matches for given text in business statuses" -hide_title: true -hide_table_of_contents: true -api: {"tags":["suggestion-controller"],"description":"Performs search on business status denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible business status denotations in the search set.","operationId":"getStatusSuggestion","parameters":[{"name":"text","in":"query","description":"Show business status denotations best matching this text","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter legal entities by name","required":false,"schema":{"type":"string"}},{"name":"legalForm","in":"query","description":"Filter legal entities by legal form name","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter legal entities by status official denotation","required":false,"schema":{"type":"string"}},{"name":"classification","in":"query","description":"Filter legal entities by classification denotation","required":false,"schema":{"type":"string"}},{"name":"administrativeArea","in":"query","description":"Filter business partners by administrative area name","required":false,"schema":{"type":"string"}},{"name":"postCode","in":"query","description":"Filter business partners by postcode or postcodes","required":false,"schema":{"type":"string"}},{"name":"locality","in":"query","description":"Filter business partners by locality full denotation","required":false,"schema":{"type":"string"}},{"name":"thoroughfare","in":"query","description":"Filter business partners by thoroughfare full denotation","required":false,"schema":{"type":"string"}},{"name":"premise","in":"query","description":"Filter business partners by premise full denotation","required":false,"schema":{"type":"string"}},{"name":"postalDeliveryPoint","in":"query","description":"Filter business partners by postal delivery point full denotation","required":false,"schema":{"type":"string"}},{"name":"siteName","in":"query","description":"Filter sites by name","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Best matches found, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"suggestion":{"type":"string"},"relevancy":{"type":"number","format":"float"}},"description":"Shows a ranked suggestion based on a given search text"}}},"description":"Paginated collection of results"}}}}},"method":"get","path":"/api/catena/suggestions/legal-entities/statuses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Find best matches for given text in business statuses","description":{"content":"Performs search on business status denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible business status denotations in the search set.","type":"text/plain"},"url":{"path":["api","catena","suggestions","legal-entities","statuses"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Show business status denotations best matching this text","type":"text/plain"},"key":"text","value":""},{"disabled":false,"description":{"content":"Filter legal entities by name","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Filter legal entities by legal form name","type":"text/plain"},"key":"legalForm","value":""},{"disabled":false,"description":{"content":"Filter legal entities by status official denotation","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Filter legal entities by classification denotation","type":"text/plain"},"key":"classification","value":""},{"disabled":false,"description":{"content":"Filter business partners by administrative area name","type":"text/plain"},"key":"administrativeArea","value":""},{"disabled":false,"description":{"content":"Filter business partners by postcode or postcodes","type":"text/plain"},"key":"postCode","value":""},{"disabled":false,"description":{"content":"Filter business partners by locality full denotation","type":"text/plain"},"key":"locality","value":""},{"disabled":false,"description":{"content":"Filter business partners by thoroughfare full denotation","type":"text/plain"},"key":"thoroughfare","value":""},{"disabled":false,"description":{"content":"Filter business partners by premise full denotation","type":"text/plain"},"key":"premise","value":""},{"disabled":false,"description":{"content":"Filter business partners by postal delivery point full denotation","type":"text/plain"},"key":"postalDeliveryPoint","value":""},{"disabled":false,"description":{"content":"Filter sites by name","type":"text/plain"},"key":"siteName","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Find best matches for given text in business statuses - - - -Performs search on business status denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible business status denotations in the search set. - -
Query Parameters
- -Best matches found, may be empty - -
Schema
    content object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-sync-status.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-sync-status.api.mdx deleted file mode 100644 index 1e47ed1ad26..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-sync-status.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-sync-status -title: "Fetch information about the SaaS synchronization" -description: "Fetch information about the latest import (either ongoing or already finished)" -sidebar_label: "Fetch information about the SaaS synchronization" -hide_title: true -hide_table_of_contents: true -api: {"tags":["saas-controller"],"description":"Fetch information about the latest import (either ongoing or already finished)","operationId":"getSyncStatus","responses":{"200":{"description":"Import information found","content":{"*/*":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["OPENSEARCH","SAAS_IMPORT"]},"status":{"type":"string","enum":["NOT_SYNCED","RUNNING","SUCCESS","ERROR"]},"count":{"type":"integer","format":"int32"},"progress":{"type":"number","format":"float"},"errorDetails":{"type":"string"},"startedAt":{"type":"string","format":"date-time"},"finishedAt":{"type":"string","format":"date-time"}}}}}},"500":{"description":"Fetching failed (no connection to database)"}},"method":"get","path":"/api/saas/business-partner/sync","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Fetch information about the SaaS synchronization","description":{"content":"Fetch information about the latest import (either ongoing or already finished)","type":"text/plain"},"url":{"path":["api","saas","business-partner","sync"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Fetch information about the SaaS synchronization - - - -Fetch information about the latest import (either ongoing or already finished) - -
- -Import information found - -
Schema
- -Fetching failed (no connection to database) - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-thoroughfare-suggestion.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-thoroughfare-suggestion.api.mdx deleted file mode 100644 index de1dadf763d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-thoroughfare-suggestion.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-thoroughfare-suggestion -title: "Find best matches for given text in thoroughfares" -description: "Performs search on thoroughfare denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible thoroughfare names in the search set." -sidebar_label: "Find best matches for given text in thoroughfares" -hide_title: true -hide_table_of_contents: true -api: {"tags":["suggestion-controller"],"description":"Performs search on thoroughfare denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible thoroughfare names in the search set.","operationId":"getThoroughfareSuggestion","parameters":[{"name":"text","in":"query","description":"Show thoroughfare names best matching this text","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter legal entities by name","required":false,"schema":{"type":"string"}},{"name":"legalForm","in":"query","description":"Filter legal entities by legal form name","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter legal entities by status official denotation","required":false,"schema":{"type":"string"}},{"name":"classification","in":"query","description":"Filter legal entities by classification denotation","required":false,"schema":{"type":"string"}},{"name":"administrativeArea","in":"query","description":"Filter business partners by administrative area name","required":false,"schema":{"type":"string"}},{"name":"postCode","in":"query","description":"Filter business partners by postcode or postcodes","required":false,"schema":{"type":"string"}},{"name":"locality","in":"query","description":"Filter business partners by locality full denotation","required":false,"schema":{"type":"string"}},{"name":"thoroughfare","in":"query","description":"Filter business partners by thoroughfare full denotation","required":false,"schema":{"type":"string"}},{"name":"premise","in":"query","description":"Filter business partners by premise full denotation","required":false,"schema":{"type":"string"}},{"name":"postalDeliveryPoint","in":"query","description":"Filter business partners by postal delivery point full denotation","required":false,"schema":{"type":"string"}},{"name":"siteName","in":"query","description":"Filter sites by name","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Best matches found, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"suggestion":{"type":"string"},"relevancy":{"type":"number","format":"float"}},"description":"Shows a ranked suggestion based on a given search text"}}},"description":"Paginated collection of results"}}}}},"method":"get","path":"/api/catena/suggestions/addresses/thoroughfares","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Find best matches for given text in thoroughfares","description":{"content":"Performs search on thoroughfare denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible thoroughfare names in the search set.","type":"text/plain"},"url":{"path":["api","catena","suggestions","addresses","thoroughfares"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Show thoroughfare names best matching this text","type":"text/plain"},"key":"text","value":""},{"disabled":false,"description":{"content":"Filter legal entities by name","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Filter legal entities by legal form name","type":"text/plain"},"key":"legalForm","value":""},{"disabled":false,"description":{"content":"Filter legal entities by status official denotation","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Filter legal entities by classification denotation","type":"text/plain"},"key":"classification","value":""},{"disabled":false,"description":{"content":"Filter business partners by administrative area name","type":"text/plain"},"key":"administrativeArea","value":""},{"disabled":false,"description":{"content":"Filter business partners by postcode or postcodes","type":"text/plain"},"key":"postCode","value":""},{"disabled":false,"description":{"content":"Filter business partners by locality full denotation","type":"text/plain"},"key":"locality","value":""},{"disabled":false,"description":{"content":"Filter business partners by thoroughfare full denotation","type":"text/plain"},"key":"thoroughfare","value":""},{"disabled":false,"description":{"content":"Filter business partners by premise full denotation","type":"text/plain"},"key":"premise","value":""},{"disabled":false,"description":{"content":"Filter business partners by postal delivery point full denotation","type":"text/plain"},"key":"postalDeliveryPoint","value":""},{"disabled":false,"description":{"content":"Filter sites by name","type":"text/plain"},"key":"siteName","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Find best matches for given text in thoroughfares - - - -Performs search on thoroughfare denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible thoroughfare names in the search set. - -
Query Parameters
- -Best matches found, may be empty - -
Schema
    content object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-valid-identifier-types-for-country.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-valid-identifier-types-for-country.api.mdx deleted file mode 100644 index 73758bdf9da..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/get-valid-identifier-types-for-country.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-valid-identifier-types-for-country -title: "Get valid identifier types for a country" -description: "Returns which identifier types are valid and which ones are mandatory for a country specified by its ISO 3166-1 alpha-2 country code." -sidebar_label: "Get valid identifier types for a country" -hide_title: true -hide_table_of_contents: true -api: {"tags":["metadata-controller"],"description":"Returns which identifier types are valid and which ones are mandatory for a country specified by its ISO 3166-1 alpha-2 country code.","operationId":"getValidIdentifierTypesForCountry","parameters":[{"name":"country","in":"query","required":true,"schema":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]}}],"responses":{"200":{"description":"The identifier types","content":{"*/*":{"schema":{"type":"array","items":{"type":"object","properties":{"identifierType":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"mandatory":{"type":"boolean"}},"description":"Valid identifiers for a country"}}}}},"400":{"description":"On malformed request parameters"}},"method":"get","path":"/api/catena/identifier-types/for-country","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Get valid identifier types for a country","description":{"content":"Returns which identifier types are valid and which ones are mandatory for a country specified by its ISO 3166-1 alpha-2 country code.","type":"text/plain"},"url":{"path":["api","catena","identifier-types","for-country"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"country","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get valid identifier types for a country - - - -Returns which identifier types are valid and which ones are mandatory for a country specified by its ISO 3166-1 alpha-2 country code. - -
Query Parameters
- -The identifier types - -
Schema array
    identifierType object
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/import-business-partners.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/import-business-partners.api.mdx deleted file mode 100644 index 6480f0df8f8..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/import-business-partners.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: import-business-partners -title: "Import new business partner records from SaaS" -description: "Triggers an asynchronous import of new business partner records from SaaS. A SaaS record counts as new when it does not have a BPN and the BPDM service does not already have a record with the same SaaS ID. This import only regards records with a modifiedAfter timestamp since the last import." -sidebar_label: "Import new business partner records from SaaS" -hide_title: true -hide_table_of_contents: true -api: {"tags":["saas-controller"],"description":"Triggers an asynchronous import of new business partner records from SaaS. A SaaS record counts as new when it does not have a BPN and the BPDM service does not already have a record with the same SaaS ID. This import only regards records with a modifiedAfter timestamp since the last import.","operationId":"importBusinessPartners","responses":{"200":{"description":"Import successfully started","content":{"*/*":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["OPENSEARCH","SAAS_IMPORT"]},"status":{"type":"string","enum":["NOT_SYNCED","RUNNING","SUCCESS","ERROR"]},"count":{"type":"integer","format":"int32"},"progress":{"type":"number","format":"float"},"errorDetails":{"type":"string"},"startedAt":{"type":"string","format":"date-time"},"finishedAt":{"type":"string","format":"date-time"}}}}}},"409":{"description":"Import already running","content":{"*/*":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["OPENSEARCH","SAAS_IMPORT"]},"status":{"type":"string","enum":["NOT_SYNCED","RUNNING","SUCCESS","ERROR"]},"count":{"type":"integer","format":"int32"},"progress":{"type":"number","format":"float"},"errorDetails":{"type":"string"},"startedAt":{"type":"string","format":"date-time"},"finishedAt":{"type":"string","format":"date-time"}}}}}},"500":{"description":"Import couldn't start to unexpected error"}},"method":"post","path":"/api/saas/business-partner/sync","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Import new business partner records from SaaS","description":{"content":"Triggers an asynchronous import of new business partner records from SaaS. A SaaS record counts as new when it does not have a BPN and the BPDM service does not already have a record with the same SaaS ID. This import only regards records with a modifiedAfter timestamp since the last import.","type":"text/plain"},"url":{"path":["api","saas","business-partner","sync"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Import new business partner records from SaaS - - - -Triggers an asynchronous import of new business partner records from SaaS. A SaaS record counts as new when it does not have a BPN and the BPDM service does not already have a record with the same SaaS ID. This import only regards records with a modifiedAfter timestamp since the last import. - -
- -Import successfully started - -
Schema
- -Import already running - -
Schema
- -Import couldn't start to unexpected error - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses.api.mdx deleted file mode 100644 index 0d835764fdf..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses.api.mdx +++ /dev/null @@ -1,82 +0,0 @@ ---- -id: search-addresses -title: "Search address partners by BPNs and/or parent BPNs" -description: "Search business partners of type address by their BPN or their parent partners BPN (BPNLs or BPNS)." -sidebar_label: "Search address partners by BPNs and/or parent BPNs" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Search business partners of type address by their BPN or their parent partners BPN (BPNLs or BPNS).","operationId":"searchAddresses","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"legalEntities":{"type":"array","items":{"type":"string"}},"sites":{"type":"array","items":{"type":"string"}},"addresses":{"type":"array","items":{"type":"string"}}},"description":"Request for searching business partners of type address by parent BPNs"}}},"required":true},"responses":{"200":{"description":"Found sites for the specified sites and legal entities","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"address":{"type":"object","properties":{"bpn":{"type":"string"},"version":{"type":"object","properties":{"characterSet":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Localization record of an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["COUNTY","REGION","OTHER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Area of an address such as country region or county"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Postcode record of an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Locality record of an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Thoroughfare record of an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Premise record of an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Postal delivery point record of an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]},"name":{"type":"string"},"url":{"type":"string"}}}}},"description":"Business partner of type address"},"bpnLegalEntity":{"type":"string"},"bpnSite":{"type":"string"}},"description":"Business partner of type address with parent reference"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/api/catena/addresses/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"legalEntities":["string"],"sites":["string"],"addresses":["string"]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Search address partners by BPNs and/or parent BPNs","description":{"content":"Search business partners of type address by their BPN or their parent partners BPN (BPNLs or BPNS).","type":"text/plain"},"url":{"path":["api","catena","addresses","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Search address partners by BPNs and/or parent BPNs - - - -Search business partners of type address by their BPN or their parent partners BPN (BPNLs or BPNS). - -
Query Parameters
Request Body required
- -Found sites for the specified sites and legal entities - -
Schema
    content object[]
    address object
    - -Business partner of type address - -
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-business-partners.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-business-partners.api.mdx deleted file mode 100644 index e27754051c2..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-business-partners.api.mdx +++ /dev/null @@ -1,122 +0,0 @@ ---- -id: search-business-partners -title: "Get page of business partners matching the search criteria" -description: "This endpoint tries to find matches among all existing business partners, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score." -sidebar_label: "Get page of business partners matching the search criteria" -hide_title: true -hide_table_of_contents: true -api: {"tags":["business-partner-legacy-controller"],"description":"This endpoint tries to find matches among all existing business partners, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score.","operationId":"searchBusinessPartners","parameters":[{"name":"name","in":"query","description":"Filter legal entities by name","required":false,"schema":{"type":"string"}},{"name":"legalForm","in":"query","description":"Filter legal entities by legal form name","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter legal entities by status official denotation","required":false,"schema":{"type":"string"}},{"name":"classification","in":"query","description":"Filter legal entities by classification denotation","required":false,"schema":{"type":"string"}},{"name":"administrativeArea","in":"query","description":"Filter business partners by administrative area name","required":false,"schema":{"type":"string"}},{"name":"postCode","in":"query","description":"Filter business partners by postcode or postcodes","required":false,"schema":{"type":"string"}},{"name":"locality","in":"query","description":"Filter business partners by locality full denotation","required":false,"schema":{"type":"string"}},{"name":"thoroughfare","in":"query","description":"Filter business partners by thoroughfare full denotation","required":false,"schema":{"type":"string"}},{"name":"premise","in":"query","description":"Filter business partners by premise full denotation","required":false,"schema":{"type":"string"}},{"name":"postalDeliveryPoint","in":"query","description":"Filter business partners by postal delivery point full denotation","required":false,"schema":{"type":"string"}},{"name":"siteName","in":"query","description":"Filter sites by name","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of business partners matching the search criteria, may be empty","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"score":{"type":"number","format":"float"}},"description":"Match with score for a business partner of type legal entity in legacy format","deprecated":true}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed search or pagination request"}},"deprecated":true,"method":"get","path":"/api/catena/business-partner","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Get page of business partners matching the search criteria","description":{"content":"This endpoint tries to find matches among all existing business partners, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score.","type":"text/plain"},"url":{"path":["api","catena","business-partner"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter legal entities by name","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Filter legal entities by legal form name","type":"text/plain"},"key":"legalForm","value":""},{"disabled":false,"description":{"content":"Filter legal entities by status official denotation","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Filter legal entities by classification denotation","type":"text/plain"},"key":"classification","value":""},{"disabled":false,"description":{"content":"Filter business partners by administrative area name","type":"text/plain"},"key":"administrativeArea","value":""},{"disabled":false,"description":{"content":"Filter business partners by postcode or postcodes","type":"text/plain"},"key":"postCode","value":""},{"disabled":false,"description":{"content":"Filter business partners by locality full denotation","type":"text/plain"},"key":"locality","value":""},{"disabled":false,"description":{"content":"Filter business partners by thoroughfare full denotation","type":"text/plain"},"key":"thoroughfare","value":""},{"disabled":false,"description":{"content":"Filter business partners by premise full denotation","type":"text/plain"},"key":"premise","value":""},{"disabled":false,"description":{"content":"Filter business partners by postal delivery point full denotation","type":"text/plain"},"key":"postalDeliveryPoint","value":""},{"disabled":false,"description":{"content":"Filter sites by name","type":"text/plain"},"key":"siteName","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"*/*"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of business partners matching the search criteria - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -This endpoint tries to find matches among all existing business partners, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. - -
Query Parameters
- -Page of business partners matching the search criteria, may be empty - -
Schema
    content object[]
    businessPartner object
    - -Business Partner of type legal entity in deprecated response format - -
    identifiers object[]
    type object
    issuingBody object
    status object
    - -Named type uniquely identified by its technical key - -
    names object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    legalForm object
    - -Legal form a business partner can have - -
    language object
    - -Named type uniquely identified by its technical key - -
    categories object[]
    status object
    - -Status of a business partner - -
    type object
    profileClassifications object[]
    type object
    - -General type with name and URL link for further information - -
    types object[]
    bankAccounts object[]
    currency object
    - -Named type uniquely identified by its technical key - -
    roles object[]
    relations object[]
    relationClass object
    - -Named type uniquely identified by its technical key - -
    type object
    - -Named type uniquely identified by its technical key - -
    addresses object[]
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
    sites object[]
- -On malformed search or pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-legal-addresses.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-legal-addresses.api.mdx deleted file mode 100644 index 8304f698e7b..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-legal-addresses.api.mdx +++ /dev/null @@ -1,82 +0,0 @@ ---- -id: search-legal-addresses -title: "Search Legal Addresses" -description: "Search legal addresses of legal entities by BPNL" -sidebar_label: "Search Legal Addresses" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Search legal addresses of legal entities by BPNL","operationId":"searchLegalAddresses","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"The found legal addresses","content":{"*/*":{"schema":{"type":"array","items":{"type":"object","properties":{"legalEntity":{"type":"string"},"legalAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Localization record of an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["COUNTY","REGION","OTHER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Area of an address such as country region or county"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Postcode record of an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Locality record of an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Thoroughfare record of an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Premise record of an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Postal delivery point record of an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]},"name":{"type":"string"},"url":{"type":"string"}}}}},"description":"Localized address record of a business partner"}},"description":"Legal address record with parent BPN"}}}}},"400":{"description":"On malformed request parameters"}},"method":"post","path":"/api/catena/legal-entities/legal-addresses/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Search Legal Addresses","description":{"content":"Search legal addresses of legal entities by BPNL","type":"text/plain"},"url":{"path":["api","catena","legal-entities","legal-addresses","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Search Legal Addresses - - - -Search legal addresses of legal entities by BPNL - -
Request Body array required
  • string
- -The found legal addresses - -
Schema array
    legalAddress object
    - -Localized address record of a business partner - -
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-main-addresses.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-main-addresses.api.mdx deleted file mode 100644 index ee00ce0782f..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-main-addresses.api.mdx +++ /dev/null @@ -1,82 +0,0 @@ ---- -id: search-main-addresses -title: "Search Main Addresses" -description: "Search main addresses of site business partners by BPNS" -sidebar_label: "Search Main Addresses" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Search main addresses of site business partners by BPNS","operationId":"searchMainAddresses","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"The found main addresses","content":{"*/*":{"schema":{"type":"array","items":{"type":"object","properties":{"site":{"type":"string"},"mainAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Localization record of an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["COUNTY","REGION","OTHER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Area of an address such as country region or county"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Postcode record of an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Locality record of an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Thoroughfare record of an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Premise record of an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Postal delivery point record of an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]},"name":{"type":"string"},"url":{"type":"string"}}}}},"description":"Localized address record of a business partner"}},"description":"Main address record with parent BPN"}}}}},"400":{"description":"On malformed request parameters"}},"method":"post","path":"/api/catena/sites/main-addresses/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Search Main Addresses","description":{"content":"Search main addresses of site business partners by BPNS","type":"text/plain"},"url":{"path":["api","catena","sites","main-addresses","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Search Main Addresses - - - -Search main addresses of site business partners by BPNS - -
Request Body array required
  • string
- -The found main addresses - -
Schema array
    mainAddress object
    - -Localized address record of a business partner - -
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-sites-1.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-sites-1.api.mdx deleted file mode 100644 index d4080c7aab9..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-sites-1.api.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -id: search-sites-1 -title: "Search legal entity partners by BPNLs" -description: "Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to 5000 entries." -sidebar_label: "Search legal entity partners by BPNLs" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to 5000 entries.","operationId":"searchSites_1","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"Found legal entites","content":{"*/*":{"schema":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"issuingBody":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"status":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a business partner"}},"names":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACRONYM","DOING_BUSINESS_AS","ESTABLISHMENT","INTERNATIONAL","LOCAL","OTHER","REGISTERED","TRANSLITERATED","VAT_REGISTERED"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Name record of a business partner"}},"legalForm":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"mainAbbreviation":{"type":"string"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}}},"description":"Legal form a business partner can have"},"status":{"type":"object","properties":{"officialDenotation":{"type":"string"},"validFrom":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","DISSOLVED","IN_LIQUIDATION","INACTIVE","INSOLVENCY","UNKNOWN"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Status of a business partner"},"profileClassifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"code":{"type":"string"},"type":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}},"description":"Classification record of a business partner"}},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRAND","LEGAL_ENTITY","ORGANIZATIONAL_UNIT","SITE","UNKNOWN"]},"name":{"type":"string"},"url":{"type":"string"}}}},"bankAccounts":{"type":"array","items":{"type":"object","properties":{"trustScores":{"type":"array","items":{"type":"number","format":"float"}},"currency":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"internationalBankAccountIdentifier":{"type":"string"},"internationalBankIdentifier":{"type":"string"},"nationalBankAccountIdentifier":{"type":"string"},"nationalBankIdentifier":{"type":"string"}},"description":"Bank account record for a business partner"}},"roles":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"relations":{"type":"array","items":{"type":"object","properties":{"relationClass":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["SAAS_HIERARCHY","SAAS_TRANSITION","CX_HIERARCHY","DNB_HIERARCHY","LEI_HIERARCHY"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF","CX_ADDRESS_OF","CX_SITE_OF","CX_OWNED_BY","DIRECT_LEGAL_RELATION","COMMERCIAL_ULTIMATE","DOMESTIC_BRANCH_RELATION","INTERNATIONAL_BRANCH_RELATION","DOMESTIC_LEGAL_ULTIMATE_RELATION","GLOBAL_LEGAL_ULTIMATE_RELATION","LEGAL_PREDECESSOR","LEGAL_SUCCESSOR","DNB_PARENT","DNB_HEADQUARTER","DNB_DOMESTIC_ULTIMATE","DNB_GLOBAL_ULTIMATE","LEI_DIRECT_PARENT","LEI_INTERNATIONAL_BRANCH","LEI_ULTIMATE_PARENT"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"startNode":{"type":"string"},"endNode":{"type":"string"},"startedAt":{"type":"string","format":"date-time"},"endedAt":{"type":"string","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","format":"date-time"}},"description":"Business partner of type legal entity with currentness"}}}}},"400":{"description":"On malformed request parameters or if number of requested bpns exceeds limit"}},"method":"post","path":"/api/catena/legal-entities/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Search legal entity partners by BPNLs","description":{"content":"Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to 5000 entries.","type":"text/plain"},"url":{"path":["api","catena","legal-entities","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Search legal entity partners by BPNLs - - - -Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to 5000 entries. - -
Request Body array required
  • string
- -Found legal entites - -
Schema array
    identifiers object[]
    type object
    issuingBody object
    status object
    - -Named type uniquely identified by its technical key - -
    names object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    legalForm object
    - -Legal form a business partner can have - -
    language object
    - -Named type uniquely identified by its technical key - -
    categories object[]
    status object
    - -Status of a business partner - -
    type object
    profileClassifications object[]
    type object
    - -General type with name and URL link for further information - -
    types object[]
    bankAccounts object[]
    currency object
    - -Named type uniquely identified by its technical key - -
    roles object[]
    relations object[]
    relationClass object
    - -Named type uniquely identified by its technical key - -
    type object
    - -Named type uniquely identified by its technical key - -
- -On malformed request parameters or if number of requested bpns exceeds limit - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-sites.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-sites.api.mdx deleted file mode 100644 index 3b9d722eb97..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/search-sites.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: search-sites -title: "Search site partners by BPNs and/or parent BPNs" -description: "Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities" -sidebar_label: "Search site partners by BPNs and/or parent BPNs" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities","operationId":"searchSites","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"legalEntities":{"type":"array","items":{"type":"string"}},"sites":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"Found sites that belong to specified legal entites","content":{"*/*":{"schema":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"contentSize":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"type":"object","properties":{"site":{"type":"object","properties":{"bpn":{"type":"string"},"name":{"type":"string"}},"description":"Business partner of type site"},"bpnLegalEntity":{"type":"string"}},"description":"Business partner of type site with parent BPN"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters"}},"method":"post","path":"/api/catena/sites/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"legalEntities":["string"],"sites":["string"]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Search site partners by BPNs and/or parent BPNs","description":{"content":"Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities","type":"text/plain"},"url":{"path":["api","catena","sites","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Search site partners by BPNs and/or parent BPNs - - - -Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities - -
Query Parameters
Request Body required
- -Found sites that belong to specified legal entites - -
Schema
    content object[]
    site object
    - -Business partner of type site - -
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/set-legal-entity-currentness.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/set-legal-entity-currentness.api.mdx deleted file mode 100644 index 7f3013693ad..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/set-legal-entity-currentness.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: set-legal-entity-currentness -title: "Confirms that the data of a legal entity business partner is still up to date." -description: "Confirms that the data of a business partner is still up to date by saving the current timestamp at the time this POST-request is made as this business partner's 'currentness'. Ignores case of bpn." -sidebar_label: "Confirms that the data of a legal entity business partner is still up to date." -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Confirms that the data of a business partner is still up to date by saving the current timestamp at the time this POST-request is made as this business partner's \"currentness\". Ignores case of bpn.","operationId":"setLegalEntityCurrentness","parameters":[{"name":"bpn","in":"path","description":"Bpn value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Business partner's \"currentness\" successfully updated"},"400":{"description":"On malformed request parameters"},"404":{"description":"No business partner found for specified bpn"}},"method":"post","path":"/api/catena/legal-entities/{bpn}/confirm-up-to-date","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Confirms that the data of a legal entity business partner is still up to date.","description":{"content":"Confirms that the data of a business partner is still up to date by saving the current timestamp at the time this POST-request is made as this business partner's \"currentness\". Ignores case of bpn.","type":"text/plain"},"url":{"path":["api","catena","legal-entities",":bpn","confirm-up-to-date"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Bpn value","type":"text/plain"},"type":"any","value":"","key":"bpn"}]},"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Confirms that the data of a legal entity business partner is still up to date. - - - -Confirms that the data of a business partner is still up to date by saving the current timestamp at the time this POST-request is made as this business partner's "currentness". Ignores case of bpn. - -
Path Parameters
- -Business partner's "currentness" successfully updated - -
- -On malformed request parameters - -
- -No business partner found for specified bpn - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/sidebar.js deleted file mode 100644 index 72bae799cf3..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool"},{"type":"category","label":"site-controller","link":{"type":"generated-index","title":"site-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/site-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/update-site","label":"Update existing site business partners","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-site","label":"Create new site business partners","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-sites","label":"Search site partners by BPNs and/or parent BPNs","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-main-addresses","label":"Search Main Addresses","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-site","label":"Get site partners by bpn","className":"api-method get"}]},{"type":"category","label":"legal-entity-controller","link":{"type":"generated-index","title":"legal-entity-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/legal-entity-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities","label":"Get page of legal entity business partners matching the search criteria","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners","label":"Update existing legal entity business partners","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners","label":"Create new legal entity business partners","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/set-legal-entity-currentness","label":"Confirms that the data of a legal entity business partner is still up to date.","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-sites-1","label":"Search legal entity partners by BPNLs","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-legal-addresses","label":"Search Legal Addresses","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity","label":"Get legal entity business partner by identifier","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-sites","label":"Get site partners of a legal entity","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-addresses","label":"Get address partners of a legal entity","className":"api-method get"}]},{"type":"category","label":"address-controller","link":{"type":"generated-index","title":"address-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/address-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1","label":"Get page of addresses matching the search criteria","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/update-addresses","label":"Update existing address business partners","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-addresses","label":"Create new address business partners","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-addresses","label":"Search address partners by BPNs and/or parent BPNs","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-address","label":"Get address partners by bpn","className":"api-method get"}]},{"type":"category","label":"saas-controller","link":{"type":"generated-index","title":"saas-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/saas-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-sync-status","label":"Fetch information about the SaaS synchronization","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/import-business-partners","label":"Import new business partner records from SaaS","className":"api-method post"}]},{"type":"category","label":"open-search-controller","link":{"type":"generated-index","title":"open-search-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/open-search-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-business-partners","label":"Fetch information about the latest OpenSearch export","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/export","label":"Index new business partner records on OpenSearch","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/clear","label":"Clear business partner index on OpenSearch","className":"api-method delete"}]},{"type":"category","label":"metadata-controller","link":{"type":"generated-index","title":"metadata-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/metadata-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms","label":"Get page of legal forms","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form","label":"Create new legal form","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-issuing-bodies","label":"Get page of issuing bodies","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-issuing-body","label":"Create new issuing body","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types","label":"Get page of identifier types","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type","label":"Create new identifier type","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-stati","label":"Get page of identifier statuses","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-status","label":"Create new identifier status","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-valid-identifier-types-for-country","label":"Get valid identifier types for a country","className":"api-method get"}]},{"type":"category","label":"bpn-controller","link":{"type":"generated-index","title":"bpn-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/bpn-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers","label":"Find business partner numbers by identifiers","className":"api-method post"}]},{"type":"category","label":"suggestion-controller","link":{"type":"generated-index","title":"suggestion-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/suggestion-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-site-suggestion","label":"Find best matches for given text in business partner sites","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-status-suggestion","label":"Find best matches for given text in business statuses","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-name-suggestion","label":"Find best matches for given text in business partner names","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-legal-form-suggestion","label":"Find best matches for given text in business partner legal forms","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-classification-suggestion","label":"Find best matches for given text in business partner classifications","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-thoroughfare-suggestion","label":"Find best matches for given text in thoroughfares","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-premise-suggestion","label":"Find best matches for given text in premises","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-postcode-suggestion","label":"Find best matches for given text in postcodes","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-postal-deliver-point-suggestion","label":"Find best matches for given text in postal delivery points","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-locality-suggestion","label":"Find best matches for given text in localities","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-admin-area-suggestion","label":"Find best matches for given text in administrative areas","className":"api-method get"}]},{"type":"category","label":"business-partner-controller","link":{"type":"generated-index","title":"business-partner-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries","label":"Get business partner changelog entries by bpn","className":"api-method get"}]},{"type":"category","label":"business-partner-legacy-controller","link":{"type":"generated-index","title":"business-partner-legacy-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-legacy-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-business-partners","label":"Get page of business partners matching the search criteria","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity-1","label":"Get business partner by identifier","className":"menu__list-item--deprecated api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/update-addresses.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/update-addresses.api.mdx deleted file mode 100644 index df636c24952..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/update-addresses.api.mdx +++ /dev/null @@ -1,86 +0,0 @@ ---- -id: update-addresses -title: "Update existing address business partners" -description: "Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change." -sidebar_label: "Update existing address business partners" -hide_title: true -hide_table_of_contents: true -api: {"tags":["address-controller"],"description":"Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change.","operationId":"updateAddresses","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string"},"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}}},"description":"Request for updating a business partner record of type address"}}}},"required":true},"responses":{"200":{"description":"The successfully updated records","content":{"*/*":{"schema":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string"},"version":{"type":"object","properties":{"characterSet":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Localization record of an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["COUNTY","REGION","OTHER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Area of an address such as country region or county"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Postcode record of an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Locality record of an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Thoroughfare record of an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Premise record of an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Postal delivery point record of an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]},"name":{"type":"string"},"url":{"type":"string"}}}}},"description":"Business partner of type address"}}}}},"400":{"description":"On malformed requests"}},"method":"put","path":"/api/catena/addresses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"bpn":"string","version":{"characterSet":"ARABIC","language":"undefined"},"careOf":"string","contexts":["string"],"country":"UNDEFINED","administrativeAreas":[{"value":"string","shortName":"string","fipsCode":"string","type":"COUNTY"}],"postCodes":[{"value":"string","type":"CEDEX"}],"localities":[{"value":"string","shortName":"string","type":"BLOCK"}],"thoroughfares":[{"value":"string","name":"string","shortName":"string","number":"string","direction":"string","type":"INDUSTRIAL_ZONE"}],"premises":[{"value":"string","shortName":"string","number":"string","type":"BUILDING"}],"postalDeliveryPoints":[{"value":"string","shortName":"string","number":"string","type":"INTERURBAN_DELIVERY_POINT"}],"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"types":["BRANCH_OFFICE"]}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Update existing address business partners","description":{"content":"Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change.","type":"text/plain"},"url":{"path":["api","catena","addresses"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Update existing address business partners - - - -Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change. - -
Request Body array required
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -The successfully updated records - -
Schema array
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners.api.mdx deleted file mode 100644 index 6e46811216e..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners.api.mdx +++ /dev/null @@ -1,138 +0,0 @@ ---- -id: update-business-partners -title: "Update existing legal entity business partners" -description: "Update existing business partner records of type legal entity referenced via BPNL. The endpoint expects to receive the full updated record, including values that didn't change." -sidebar_label: "Update existing legal entity business partners" -hide_title: true -hide_table_of_contents: true -api: {"tags":["legal-entity-controller"],"description":"Update existing business partner records of type legal entity referenced via BPNL. The endpoint expects to receive the full updated record, including values that didn't change.","operationId":"updateBusinessPartners","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"},"status":{"type":"string"}},"description":"Identifier record for a business partner"}},"names":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["ACRONYM","DOING_BUSINESS_AS","ESTABLISHMENT","INTERNATIONAL","LOCAL","OTHER","REGISTERED","TRANSLITERATED","VAT_REGISTERED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Name record for a business partner"}},"legalForm":{"type":"string"},"status":{"type":"object","properties":{"officialDenotation":{"type":"string"},"validFrom":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","DISSOLVED","IN_LIQUIDATION","INACTIVE","INSOLVENCY","UNKNOWN"]}},"description":"Status record for a business partner"},"profileClassifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"code":{"type":"string"},"type":{"type":"string","enum":["NACE","NAF","NAICS","SIC"]}},"description":"Classification record for a business partner"}},"types":{"type":"array","items":{"type":"string","enum":["BRAND","LEGAL_ENTITY","ORGANIZATIONAL_UNIT","SITE","UNKNOWN"]}},"bankAccounts":{"type":"array","items":{"type":"object","properties":{"trustScores":{"type":"array","items":{"type":"number","format":"float"}},"currency":{"type":"string","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"internationalBankAccountIdentifier":{"type":"string"},"internationalBankIdentifier":{"type":"string"},"nationalBankAccountIdentifier":{"type":"string"},"nationalBankIdentifier":{"type":"string"}},"description":"Bank account record of a business partner"}},"legalAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}}},"description":"Localized address record for a business partner"}},"description":"Request for updating a business partner record of type legal entity"}}}},"required":true},"responses":{"200":{"description":"The successfully updated records","content":{"*/*":{"schema":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"issuingBody":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"status":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Identifier record of a business partner"}},"names":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACRONYM","DOING_BUSINESS_AS","ESTABLISHMENT","INTERNATIONAL","LOCAL","OTHER","REGISTERED","TRANSLITERATED","VAT_REGISTERED"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Name record of a business partner"}},"legalForm":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"mainAbbreviation":{"type":"string"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}}},"description":"Legal form a business partner can have"},"status":{"type":"object","properties":{"officialDenotation":{"type":"string"},"validFrom":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ACTIVE","DISSOLVED","IN_LIQUIDATION","INACTIVE","INSOLVENCY","UNKNOWN"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Status of a business partner"},"profileClassifications":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"code":{"type":"string"},"type":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"description":"General type with name and URL link for further information"}},"description":"Classification record of a business partner"}},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRAND","LEGAL_ENTITY","ORGANIZATIONAL_UNIT","SITE","UNKNOWN"]},"name":{"type":"string"},"url":{"type":"string"}}}},"bankAccounts":{"type":"array","items":{"type":"object","properties":{"trustScores":{"type":"array","items":{"type":"number","format":"float"}},"currency":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"internationalBankAccountIdentifier":{"type":"string"},"internationalBankIdentifier":{"type":"string"},"nationalBankAccountIdentifier":{"type":"string"},"nationalBankIdentifier":{"type":"string"}},"description":"Bank account record for a business partner"}},"roles":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string"},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"relations":{"type":"array","items":{"type":"object","properties":{"relationClass":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["SAAS_HIERARCHY","SAAS_TRANSITION","CX_HIERARCHY","DNB_HIERARCHY","LEI_HIERARCHY"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF","CX_ADDRESS_OF","CX_SITE_OF","CX_OWNED_BY","DIRECT_LEGAL_RELATION","COMMERCIAL_ULTIMATE","DOMESTIC_BRANCH_RELATION","INTERNATIONAL_BRANCH_RELATION","DOMESTIC_LEGAL_ULTIMATE_RELATION","GLOBAL_LEGAL_ULTIMATE_RELATION","LEGAL_PREDECESSOR","LEGAL_SUCCESSOR","DNB_PARENT","DNB_HEADQUARTER","DNB_DOMESTIC_ULTIMATE","DNB_GLOBAL_ULTIMATE","LEI_DIRECT_PARENT","LEI_INTERNATIONAL_BRANCH","LEI_ULTIMATE_PARENT"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"startNode":{"type":"string"},"endNode":{"type":"string"},"startedAt":{"type":"string","format":"date-time"},"endedAt":{"type":"string","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","format":"date-time"},"legalAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Localization record of an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["COUNTY","REGION","OTHER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Area of an address such as country region or county"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Postcode record of an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Locality record of an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Thoroughfare record of an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Premise record of an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Postal delivery point record of an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]},"name":{"type":"string"},"url":{"type":"string"}}}}},"description":"Localized address record of a business partner"},"index":{"type":"string"}},"description":"Created business partner of type legal entity"}}}}},"400":{"description":"On malformed requests"},"404":{"description":"Metadata referenced by technical key not found"}},"method":"put","path":"/api/catena/legal-entities","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"bpn":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string","status":"string"}],"names":[{"value":"string","shortName":"string","type":"ACRONYM","language":"undefined"}],"legalForm":"string","status":{"officialDenotation":"string","validFrom":"2023-05-31","validUntil":"2023-05-31","type":"ACTIVE"},"profileClassifications":[{"value":"string","code":"string","type":"NACE"}],"types":["BRAND"],"bankAccounts":[{"trustScores":[0],"currency":"UNDEFINED","internationalBankAccountIdentifier":"string","internationalBankIdentifier":"string","nationalBankAccountIdentifier":"string","nationalBankIdentifier":"string"}],"legalAddress":{"version":{"characterSet":"ARABIC","language":"undefined"},"careOf":"string","contexts":["string"],"country":"UNDEFINED","administrativeAreas":[{"value":"string","shortName":"string","fipsCode":"string","type":"COUNTY"}],"postCodes":[{"value":"string","type":"CEDEX"}],"localities":[{"value":"string","shortName":"string","type":"BLOCK"}],"thoroughfares":[{"value":"string","name":"string","shortName":"string","number":"string","direction":"string","type":"INDUSTRIAL_ZONE"}],"premises":[{"value":"string","shortName":"string","number":"string","type":"BUILDING"}],"postalDeliveryPoints":[{"value":"string","shortName":"string","number":"string","type":"INTERURBAN_DELIVERY_POINT"}],"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"types":["BRANCH_OFFICE"]}}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Update existing legal entity business partners","description":{"content":"Update existing business partner records of type legal entity referenced via BPNL. The endpoint expects to receive the full updated record, including values that didn't change.","type":"text/plain"},"url":{"path":["api","catena","legal-entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Update existing legal entity business partners - - - -Update existing business partner records of type legal entity referenced via BPNL. The endpoint expects to receive the full updated record, including values that didn't change. - -
Request Body array required
    identifiers object[]
    names object[]
    status object
    - -Status record for a business partner - -
    profileClassifications object[]
    bankAccounts object[]
    legalAddress object
    - -Localized address record for a business partner - -
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -The successfully updated records - -
Schema array
    identifiers object[]
    type object
    issuingBody object
    status object
    - -Named type uniquely identified by its technical key - -
    names object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    legalForm object
    - -Legal form a business partner can have - -
    language object
    - -Named type uniquely identified by its technical key - -
    categories object[]
    status object
    - -Status of a business partner - -
    type object
    profileClassifications object[]
    type object
    - -General type with name and URL link for further information - -
    types object[]
    bankAccounts object[]
    currency object
    - -Named type uniquely identified by its technical key - -
    roles object[]
    relations object[]
    relationClass object
    - -Named type uniquely identified by its technical key - -
    type object
    - -Named type uniquely identified by its technical key - -
    legalAddress object
    - -Localized address record of a business partner - -
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
- -On malformed requests - -
- -Metadata referenced by technical key not found - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/update-site.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/update-site.api.mdx deleted file mode 100644 index 5b117309560..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/Pool Api/update-site.api.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: update-site -title: "Update existing site business partners" -description: "Update existing business partner records of type site referenced via BPNS. The endpoint expects to receive the full updated record, including values that didn't change." -sidebar_label: "Update existing site business partners" -hide_title: true -hide_table_of_contents: true -api: {"tags":["site-controller"],"description":"Update existing business partner records of type site referenced via BPNS. The endpoint expects to receive the full updated record, including values that didn't change.","operationId":"updateSite","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string"},"name":{"type":"string"},"mainAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"language":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]}},"description":"Localization record for an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"string","enum":["COUNTY","REGION","OTHER"]}},"description":"Areas such as country regions or counties"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]}},"description":"Postcode record for an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]}},"description":"Locality record for an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]}},"description":"Thoroughfare record for an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]}},"description":"Premise record for an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]}},"description":"Postal delivery point record for an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]}}},"description":"Localized address record for a business partner"}},"description":"Request for updating a business partner record of type site"}}}},"required":true},"responses":{"200":{"description":"The successfully updated records","content":{"*/*":{"schema":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string"},"name":{"type":"string"},"mainAddress":{"type":"object","properties":{"version":{"type":"object","properties":{"characterSet":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["ARABIC","CHINESE","CHINESE_TRADITIONAL","CYRILLIC","GREEK","HANGUL_KOREAN","HEBREW","HIRAGANA","KANJI","KATAKANA","LATIN","THAI","WESTERN_LATIN_STANDARD","UNDEFINED"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Localization record of an address"},"careOf":{"type":"string"},"contexts":{"type":"array","items":{"type":"string"}},"country":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreas":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"fipsCode":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["COUNTY","REGION","OTHER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Area of an address such as country region or county"}},"postCodes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["CEDEX","LARGE_MAIL_USER","OTHER","POST_BOX","REGULAR"]},"name":{"type":"string"},"url":{"type":"string"}}}},"description":"Postcode record of an address"}},"localities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BLOCK","CITY","DISTRICT","OTHER","POST_OFFICE_CITY","QUARTER"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Locality record of an address such as city, block or district"}},"thoroughfares":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"direction":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INDUSTRIAL_ZONE","OTHER","RIVER","SQUARE","STREET"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Thoroughfare record of an address such as street, square or industrial zone"}},"premises":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BUILDING","OTHER","LEVEL","HARBOUR","ROOM","SUITE","UNIT","WAREHOUSE"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Premise record of an address such as building, room or floor"}},"postalDeliveryPoints":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"shortName":{"type":"string"},"number":{"type":"string"},"type":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["INTERURBAN_DELIVERY_POINT","MAIL_STATION","MAILBOX","OTHER","POST_OFFICE_BOX"]},"name":{"type":"string"},"url":{"type":"string"}}},"language":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"]},"name":{"type":"string"}},"description":"Named type uniquely identified by its technical key"}},"description":"Postal delivery point record of an address"}},"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}},"description":"Geo coordinates record for an address"},"types":{"type":"array","items":{"type":"object","properties":{"technicalKey":{"type":"string","enum":["BRANCH_OFFICE","CARE_OF","HEADQUARTER","LEGAL_ALTERNATIVE","PO_BOX","REGISTERED","REGISTERED_AGENT_MAIL","REGISTERED_AGENT_PHYSICAL","VAT_REGISTERED","UNSPECIFIC"]},"name":{"type":"string"},"url":{"type":"string"}}}}},"description":"Localized address record of a business partner"},"index":{"type":"string"}},"description":"Created business partner record of type site"}}}}},"400":{"description":"On malformed requests"}},"method":"put","path":"/api/catena/sites","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"bpn":"string","name":"string","mainAddress":{"version":{"characterSet":"ARABIC","language":"undefined"},"careOf":"string","contexts":["string"],"country":"UNDEFINED","administrativeAreas":[{"value":"string","shortName":"string","fipsCode":"string","type":"COUNTY"}],"postCodes":[{"value":"string","type":"CEDEX"}],"localities":[{"value":"string","shortName":"string","type":"BLOCK"}],"thoroughfares":[{"value":"string","name":"string","shortName":"string","number":"string","direction":"string","type":"INDUSTRIAL_ZONE"}],"premises":[{"value":"string","shortName":"string","number":"string","type":"BUILDING"}],"postalDeliveryPoints":[{"value":"string","shortName":"string","number":"string","type":"INTERURBAN_DELIVERY_POINT"}],"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"types":["BRANCH_OFFICE"]}}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"4.0.0"},"postman":{"name":"Update existing site business partners","description":{"content":"Update existing business partner records of type site referenced via BPNS. The endpoint expects to receive the full updated record, including values that didn't change.","type":"text/plain"},"url":{"path":["api","catena","sites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Update existing site business partners - - - -Update existing business partner records of type site referenced via BPNS. The endpoint expects to receive the full updated record, including values that didn't change. - -
Request Body array required
    mainAddress object
    - -Localized address record for a business partner - -
    version object
    - -Localization record for an address - -
    administrativeAreas object[]
    postCodes object[]
    localities object[]
    thoroughfares object[]
    premises object[]
    postalDeliveryPoints object[]
    geographicCoordinates object
    - -Geo coordinates record for an address - -
- -The successfully updated records - -
Schema array
    mainAddress object
    - -Localized address record of a business partner - -
    version object
    - -Localization record of an address - -
    characterSet object
    - -Named type uniquely identified by its technical key - -
    language object
    - -Named type uniquely identified by its technical key - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreas object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postCodes object[]
    type object
    localities object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    thoroughfares object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    premises object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    postalDeliveryPoints object[]
    type object
    language object
    - -Named type uniquely identified by its technical key - -
    geographicCoordinates object
    - -Geo coordinates record for an address - -
    types object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/_category_.json b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/_category_.json deleted file mode 100644 index e5c5b7565a3..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Development View" -} diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/page_software-development-view.md deleted file mode 100644 index 8db4563900c..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Software Development View/page_software-development-view.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: Specification -title: Specification -description: '' -sidebar_position: 1 ---- - -![Business partner kit banner](@site/static/img/BPKitIcon.png) - -### Business Partner KIT - -## Specification - -The Business Partner Pool API offers access to business partner data with for other Catena-X services. - -Swagger: [https://partners-pool.int.demo.catena-x.net/ui/swagger-ui/index.html](https://partners-pool.int.demo.catena-x.net/ui/swagger-ui/index.html) diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Success Stories/page_country-risk.md b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Success Stories/page_country-risk.md deleted file mode 100644 index f8cdb254c30..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/Success Stories/page_country-risk.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -id: Country Risk Score  -title: Country Risk Score  -description: 'Country Risk Score ' -sidebar_position: 1 ---- - -BPDM (Business Partner Data Management) aims to deliver first class master data and provide additional information regarding the company's business partners. This enables to make the best decision at all times based on actual data. This is especially helpful in a tender situation, for compliance processes or even for regulatory requirements. - -Therefore, as part of the "Know Your Business Partner"-approach, the Country Risk Score Application has been developed. - -![Country Risk Service](@site/static/img/country-risk-dashboard-min.png) - -The service offers a score per country based on several, customizable ratings. This score indicates how the respective situation in the selected country is. Currently integrated sources are e.g. the Corruption Perception Index (CPI) giving the user an indication how corrupt the respective country is, as well as the Basel AML Index which provides the user with the information about money laundring and terrorism financing in the country. As an outlook there are a lot more publicly available as well as chargeable ratings to be implemented. As well as the granularity which can be increased for the future to take into account that large countries could have better or worse regions (e.g. China, USA, Russia). - -Prerequisite to use this product: The consumer has to be sharing member as a company is only allowed to view the business partners they have uploaded initially. - -The open source solution is developed according to the Catena-X consortia and eclipse guidelines and was security checked. The repositories can be found here: - -- [https://github.com/eclipse-tractusx/vas-country-risk-frontend](https://github.com/eclipse-tractusx/vas-country-risk-frontend) -- [https://github.com/eclipse-tractusx/vas-country-risk-backend](https://github.com/eclipse-tractusx/vas-country-risk-backend) - -There is one main interface used from the Golden Record Product which is the GATE API in order to retrieve company specific business partners to be displayed in the dashboard. [https://github.com/eclipse-tractusx/bpdm/tree/main/docs/api](https://github.com/eclipse-tractusx/bpdm/tree/main/docs/api). - -While currently the country risk service is a dashboard without the possibility to share data, in the future there shall be the functionality to request a country risk score from our application for a provided BPN Number. This functionality can then be used by other use cases like traceability or by the sharing member itself to integrate the data into their own proprietary systems. For this a separate API will be developed which will be extended by an EDC in order to take care of the access and usage policy of the data. - -Once this interface is implemented and the EDC is set up, it can be ensured that the data fields are understood according to the defined semantics and peer-to-peer connections and effort can be minimized after initial setup. Therefore several Country Risk Service Providers are theoretically able to provide their data via this standardized API. This leads to great flexibility for the consumer and very little connection effort. - -Stay tuned for more information! diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/page_adoption-view.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/page_adoption-view.mdx deleted file mode 100644 index 317b1c4a39a..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/page_adoption-view.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: Adoption View -title: Adoption View -description: 'Business Partner Kit' -sidebar_position: 2 ---- - -![Business partner kit banner](@site/static/img/BPKitIcon.png) - -### Business Partner KIT - -# Unique business partner data sets for the whole data space. -### Basis for the integration of value-adding services in the area of business partner data management. - -The BusinessPartner Kit provides high-quality data records of business partners called golden record including a unique identifier and the business partner number (BPN). The BPN provides a standardized and unique identifier on legal entity, site and address level. The connected backend service removes duplicate data, adds missing information, and improves data quality from different data sources so-called sharing member. - -- **Legal Entity Level (BPN L)**: Search for a legal entity and get the high-quality data set. -- **Site Level (BPN S)**: Get the site information of a legal entity. A legal entity can have one or more sites. -- **Address Level (BPN A)**: Each legal entity and site has an address to find the company. - -**The Kit provides a homogeneous semantic with an open data model, enables the access to high quality data and provides one access point to the business partner data sets.** -
- -![BuildApps](@site/static/img/BPKITBuildApps.png) - -## 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). - ---- -
- -## 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 -- [Business Partner Number](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf) - -- [Business Partner Pool API](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0012_Business_Partner_Pool_API_v_1.1.1.pdf) - -- [Business Partner Issuing Agency](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0011_ISSUING_AGENCY_PlatformCapabilityBPDM_v_1.0.1.pdf) diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/page_changelog.md b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/page_changelog.md deleted file mode 100644 index 90952bb352d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/page_changelog.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: Changelog -title: Changelog -description: 'Business Partner Kit' -sidebar_position: 1 ---- - -![Business partner kit banner](@site/static/img/BPKitIcon.png) - -### Business Partner KIT - -All notable changes to this Kit will be documented in this file. - -## [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-3.1.0/kits/Business Partner Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/page_software-operation-view.md deleted file mode 100644 index 8317134dc55..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Business Partner Kit/page_software-operation-view.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -id: Operation View -title: Operation View -description: 'Business Partner Kit' -sidebar_position: 3 ---- - -![Business partner kit banner](@site/static/img/BPKitIcon.png) - -### Business Partner KIT - -## Installation Instructions - -This file contains information on how to configure and run the BPDM applications. - -## BPDM Pool - -BPDM Pool is a SpringBoot Kotlin software project managed by Maven. - -The project can be run with the following command: `mvn clean spring-boot:run` - -### Prerequisites - -* Maven -* JDK17 -* PostgreSQL 14.2 -* OpenSearch 2.1.0 -* Keycloak 17.0.0 (with enabled `auth` profile) -* Connection to an SaaS for the sharing process (with enabled `saas` profile) - -When running, the project requires a Postgresql database and an Opensearch instance to be available to connect to. -Per default configuration the application expects postgres to run on `localhost` on port `5432`. -Opensearch needs to run on `localhost` on port `9200` on default. - -You can find and edit the default configuration for the Pool in the `application.properties`, `application-auth.properties` and `application-saas.properties` -files in the `resources` folder. - -The REST API documentation can be accessed at `http://localhost:8080/api/swagger-ui`. - -### Profiles - -The default configuration of the application is determined by the `application.properties` file. -Here you can find core application configuration such as Swagger documentation, BPN generation and Actuator. -Furthermore, here you can find the configuration for the connection to the Spring datasource (currently, developed against PostgreSQL) and Opensearch. - -You can also run the project with Spring profiles to enable additional components on top of the default configuration. -Currently, the BPDM Pool offers the profiles `auth` and `saas`. -In order to run the application with a specific profile you can use the appropriate maven flag `Dspring.profiles.active`. - -For example, the command `mvn clean spring-boot:run -Dspring.profiles.active=auth` starts the application with additional `auth` configuration enabled. -You can also run several profiles at once, of course: `mvn clean spring-boot:run -Dspring.profiles.active=auth,saas`. - -The following sections detail the configuration properties for each profile. - -### Auth - -`application-auth.properties` enables authorization of endpoints and configures the connection to a Keycloak instance on which the authorization relies on. -The application expects the Keycloak to run on `localhost` on port `8180`. -However, as with the Spring datasource and Opensearch connections, the connection to the Keycloak can be freely configured. -The application uses the configured auth server URL to validate incoming tokens. - -For authorization purposes the application checks incoming token's permissions: - -* add_company_data: For endpoints creating or updating business partner records including triggering imports from SaaS/exports to Opensearch -* view_company_data: For read-only endpoints of business partner data - -The BPDM Pool looks for these permissions in the client/resource and not on the realm level. - -This profile also enables/disables the login form in the auto-generated Swagger documentation. -The Swagger login uses the client specified in the property `springdoc.swagger-ui.oauth.client-id`. - -### SaaS - -The file `application-saas.properties` enables and configures the connection to a remote SaaS for the sharing process from which the application can import -business partner records. -Depending on whether this component is enabled, the application offers an endpoint to import records from SaaS. -If enabled the application requires the environment variable `BPDM_SAAS_KEY` to contain an API key with necessary privileges for accessing the specified -storage. -Further, you need to provide a hostname (`BPDM_SAAS_HOST`), storage ID (`BPDM_SAAS_STORAGE`) and datasource ID `BPDM_SAAS_DATASOURCE` to specify from where the records -should be imported by the application. - -### Helm Deployment - -This repository contains Helm files for deploying the BPDM Pool to a Kubernetes environment. -See the [BPDM Pool Helm README](https://github.com/eclipse-tractusx/bpdm/blob/main/charts/bpdm/charts/bpdm-pool/README.md) for details. - -## BPDM Gate - -BPDM is a SpringBoot Kotlin software project managed by Maven and can be run with the following command: `mvn clean spring-boot:run` - -### Prerequisites - -* Maven -* JDK17 -* Connection to an SaaS for the sharing process -* Connection to BPDM Pool API -* Keycloak 17.0.0 (with enabled `auth` or `pool-auth` profile) - -When running, the BPDM Gate requires a remote SaaS storage and datasource to exchange data with. The application expects the environment variables `BPDM_SAAS_HOST`, `BPDM_SAAS_KEY`, `BPDM_SAAS_STORAGE` and `BPDM_SAAS_DATASOURCE` to contain the hostname to connect to, the API key and the identifiers for the storage and datasource respectively. - -The Gate also requires a connection to a BPDM Pool instance which is expected at `localhost` with port `8080` on default configuration. - -You can find and edit the default configuration for the Gate in the `application.properties`, `application-auth.properties` -and `application-pool-auth.properties` files in the `resources` folder. - -The REST API documentation can be accessed at `http://localhost:8081/api/swagger-ui`. - -### Profiles - -The default configuration of the application is determined by the `application.properties` file. -Here you can find core application configuration such as Swagger documentation, SaaS and BPDM Pool connection. - -You can also run the project with Spring profiles to enable additional components on top of the default configuration. -Currently, the BPDM Gate offers the profiles `auth` and `auth-pool`. -In order to run the application with a specific profile you can use the appropriate maven flag `Dspring.profiles.active`. - -For example, the command `mvn clean spring-boot:run -Dspring.profiles.active=auth` starts the application with additional `auth` configuration enabled. -You can also run several profiles at once, of course: `mvn clean spring-boot:run -Dspring.profiles.active=auth,auth-pool`. - -The following sections detail the configuration properties for each profile. - -### Auth - -`application-auth.properties` enables authorization of endpoints and configures the connection to a Keycloak instance on which the authorization relies on. -The application expects the Keycloak to run on `localhost` on port `8180` and needs a client secret has to be submitted via environment -variable `BPDM_KEYCLOAK_SECRET`. -But keep in mind that the connection to the Keycloak can be freely configured. -The application uses the configured auth server URL to validate incoming tokens. - -For authorization purposes the application checks incoming token's permissions: - -* change_company_data: For endpoints adding or updating business partner data -* view_company_data: For endpoints reading the original unrefined business partner data -* view_shared_data: For endpoints reading the business partner data which has been cleaned and refined through the sharing process - -The BPDM Pool looks for these permissions in the client/resource and not on the realm level. - -This profile also enables/disables the login form in the auto-generated Swagger documentation. -The Swagger login uses the client specified in the property `springdoc.swagger-ui.oauth.client-id`. - -### Pool-Auth - -On default configuration, the BPDM Gate expects the API of the BPDM Pool to be accessible without authorization requirements. -In case the Pool instance to connect to has authorization activated, you need to activate this profile. -The file `application-pool-auth.properties` configures the oAuth2 client for connecting to a secured BPDM Pool. -Per default, the client will try to acquire a token via client credentials flow and expects the environment variable `BPDM_KEYCLOAK_SECRET` to contain the -secret for the client. - -### Helm Deployment - -This repository contains Helm files for deploying the BPDM Gate to a Kubernetes environment. -See the [BPDM Gate Helm README](https://github.com/eclipse-tractusx/bpdm/blob/main/charts/bpdm/charts/bpdm-gate/README.md) for details. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/DCM Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-3.1.0/kits/DCM Kit/page_adoption-view.md deleted file mode 100644 index ddf79b27506..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/DCM Kit/page_adoption-view.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -id: adoption-view -title: Adoption View -description: 'A first impression' -sidebar_position: 2 ---- - -![DCM kit banner](@site/static/img/DCMKitLogoIcon-min.png) - -## Vision & Mission - -The Catena-X-Standards for Demand- and Capacity-Management enable participants of the automotive supply chain to become more resilient and to increase the degree of collaboration aimed at avoiding or solving production bottlenecks as well as surplus situations in a tactical horizon of 1-2 years. - -Thereby the standards empower participants to share data in a secure and sovereign way while ensuring the interoperability of the different applications involved in the process. - -## Status Quo - -**Today's challenge for automotive companies** - -Resilience has become imperative within Supply Chain Management, especially over the past years. With the growing complexity of supply chains and a rising number of global and local crises, small and medium enterprises (SMEs) as well as large enterprises (LEs) are facing an increased risk of serious disruptions in their supply chains, bullwhip effects and in the worst case even temporary production shutdowns with a high effort and costs of replanning. - -Inside the volatile and highly complex surroundings of the automotive industry nowadays, mostly tailor-made, proprietary and often fully manual IT solutions support the demand and capacity management processes along the value chain. On the one side there is no common understanding of these processes among the participants. On the other side, different data formats as well as application programming interfaces are used, which is increasing the complexity in the data exchange and which is leading to transfer problems, inconsistencies, or even loss of data. - -## Business Value - -**Why DCM KIT?** - -The purpose and focus of Demand and Capacity Management (DCM) KIT is twofold: -- Define a common understanding of the DCM process thus paving the way for more proactive and efficient collaboration. -- Establish process and application interoperability with the help of common semantics and unified interfaces for data exchange while ensuring the data sovereignty of data providers. - -Implementing the DCM standards will add the following core capabilities to business applications: -- Provisioning and consumption of material demands data in a sovereign manner. -- Provisioning and consumption of capacity data in a sovereign manner. -- Discovery of bottlenecks and surplus capacity situations by employing a unified calculation logic. - -## Standards - -The DCM standard comprises three main elements: -- **Core Business logic** – to focus on a **common understanding** of the **DCM processes** among the participants. **Version 1.0.0** (Release 3.1) [CX-0046 DCM Process & Core Business Logic](https://catena-x.net/de/standard-library) -- **Data model** – to align the structure of the shared data and enable the adoption of the core business logic without misinterpretation. **Version 1.0.0** (Release 3.1) [CX-0047 DCM Data Model Material Demand & Capacity Group](https://catena-x.net/de/standard-library) -- **APIs** – to make sure that data are transmitted and consumed properly as well as are identically interpreted across companies. **Version 1.0.0** (Release 3.1) [CX-0048 DCM API Material Demand & Capacity Group](https://catena-x.net/de/standard-library) - -**POWER of STANDARD** - -Standards create trust. Customer and Supplier can form new partnerships confidently. Knowing that integration in the network will be dramatically simplified. Standardization can help reduce costs by eliminating redundancies and streamlining processes. By adopting a common set of practices and technologies, businesses can avoid the need to develop their own proprietary systems, which can be expensive and time-consuming. - -**DATA SOVEREIGNTY in FOCUS** - -DCM KIT keeps up with Catena X commitment to data sovereignty. This KIT has the goal to always comply with the data sovereignty principle implemented by the Eclipse Dataspace Connector. That enables all participants in the supply chain to always stay in full control of their own data. - -This is how sharing data is fun. - -**INTEROPERABILITY at its BEST** - -Application and Service Provider can reduce investments to integrate DCM data models/API specification from DCM KIT. - -The Kit enables the offering of value-add services and innovation based on process description of the core business logic and how a collaborative approach is a win-win-situation for customer and supplier. - -**COLLABORATION is KEY** - -The DCM KIT enables better and faster issue resolution. We believe that collaboration is the key to creating and maintaining strong partnerships between customers and suppliers and, at the same time, enhancing problem solving to reach a more balanced and efficient supply and demand management. - -Of course, by realizing efficiency through improved collaboration all involved partners will gain competitive advantage over those that do not collaborate. - -## Semantic Models - -| Semantic Model | Link to GitHub Repository | -| ------------- | ------------- | -| WeekBasedCapacityGroup | https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.week_based_capacity_group | -| WeekBasedMaterialDemand | https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.week_based_material_demand | - -## 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 Mercedes Benz Group -- SPDX-FileCopyrightText: 2023,2023 BASF SE -- SPDX-FileCopyrightText: 2023,2023 SupplyOn AG -- SPDX-FileCopyrightText: 2023,2023 Henkel AG & Co.KGaA -- SPDX-FileCopyrightText: 2023,2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/DCM Kit/page_changelog.md b/docs-kits_versioned_docs/version-3.1.0/kits/DCM Kit/page_changelog.md deleted file mode 100644 index 0aed244c836..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/DCM Kit/page_changelog.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: changelog -title: Changelog -description: 'What has changed recently?' -sidebar_position: 1 ---- - -![DCM kit banner](@site/static/img/DCMKitLogoIcon-min.png) - -# DCM KIT - -All notable changes to this Kit will be documented in this file. - -## [0.1.0] - 2023-03-01 - -### Added -- Adoption View -- Development View - -### Changed -n/a - -### Removed -n/a \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/DCM Kit/page_development-view.md b/docs-kits_versioned_docs/version-3.1.0/kits/DCM Kit/page_development-view.md deleted file mode 100644 index f1eb941de40..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/DCM Kit/page_development-view.md +++ /dev/null @@ -1,534 +0,0 @@ ---- -id: development-view -title: Development View -description: 'What do I have to implement?' -sidebar_position: 3 ---- - -![DCM kit banner](@site/static/img/DCMKitLogoIcon-min.png) - -## DCM Development View - -This page describes the most important parts for the software implementation of the DCM standards. For the full technical specification, please refer to the standards [CX-0047 DCM Data Model Material Demand & Capacity Group](https://catena-x.net/de/standard-library) and [CX-0048 DCM API Material Demand & Capacity Group](https://catena-x.net/de/standard-library). - -## Introduction - -This document describes the `WeekBasedMaterialDemand` and `WeekBasedCapacityGroup` semantic models and the -API definitions used in the DCM Catena-X network. - -The `WeekBasedMaterialDemand` object will be send by customers to their suppliers in order to -communicate how many parts they need in which period of time. The customers of materials therefore -need to be able to create `WeekBasedMaterialDemand` objects and the suppliers need to be able to -interpret them. As most suppliers have their own suppliers, who produce materials for them, most -suppliers are therefore acting as customers as well and need to be able to also create -`WeekBasedMaterialDemand` objects on for sending them to their suppliers. - -The `WeekBasedCapacityGroup` object is sent by the suppliers to their customers to communicate which -materials are bundled together, representing a common bottleneck. And what the capacity for these -materials is, considering their common bottleneck.This information is represented as weekly buckets -within the WeekBasedCapacityGroup. Therefore, all companies, that supply materials to other -companies, need to be able to create `WeekBasedCapacityGroup` objects in a consistent and -standardized structure and send them to their customers. The customers need to be able to receive -and interpret the `WeekBasedCapacityGroup` information. - -## ASPECT MODEL "WeekBasedMaterialDemand" - -The material demand information MUST be sent from the customer to the supplier according to the [CX-0048 DCM API Material Demand & Capacity Group](https://catena-x.net/de/standard-library) standard. The data format described here MUST be followed for the exchange of the `WeekBasedMaterialDemand` information. - -The `WeekBasedMaterialDemand` data model MUST be implemented by all participants who wish to -participate in the Catena-X DCM network as a customer or supplier. - -Companies, who participate in the Catena-X Network as a supplier, MUST be able to receive material -demand information and MUST be able to send capacity group information. - -Companies, who participate in the Catena-X Network as a customer, MUST be able to send material -demand information and MUST be able to receive capacity group information. - -Companies who participate in the Catena-X Network with both roles therefore MUST be able to receive -and send both, material demand as well as capacity group information. It is recommended that -companies implement both standards. - -Every data provider of `WeekBasedMaterialDemand` data MUST provide the data conformant to the -semantic model specified in this document. - -The unique identifier of the semantic model specified in this document MUST be used by the data -provider to define the semantics of the data being transferred. - -Every certified business application relying on `WeekBasedMaterialDemand` data MUST be able to -consume data conformant to the semantic model specified in this document. - -Data consumers and data provider MUST comply with the license of the semantic model. - -In the Catena-X data space `WeekBasedMaterialDemand` data MUST be requested and exchanged via -Eclipse Dataspace Connector (EDC) conformant to [CX-0018](https://catena-x.net/de/standard-library) and [CX-0002](https://catena-x.net/de/standard-library). - -The characteristics BPNL and BPNS MUST be used according to the standard [CX-0010](https://catena-x.net/de/standard-library). - -### Sample Data - -```json -{ - "unitOfMeasure": "GRM", - "materialDescriptionCustomer": "Spark Plug", - "materialDemandId": "0157ba42-d2a8-4e28-8565-7b07830c1110", - "materialNumberSupplier": "MNR-8101-ID146955.001", - "supplier": "BPNL6666666666YY", - "changedAt": "2023-03-10T12:27:11.320Z", - "demandSeries": [ - { - "expectedSupplierLocation": "BPNS8888888888XX", - "demands": [ - { - "demand": 1, - "calendarWeek": "2022-08-01" - } - ], - "customerLocation": "BPNS8888888888XX", - "demandCategory": { - "demandCategoryCode": "0001" - } - } - ], - "materialNumberCustomer": "MNR-7307-AU340474.002", - "customer": "BPNL8888888888XX" -} -``` - -The semantic model has the unique identifier -```text - urn:bamm:io.catenax.week_based_material_demand:1.0.0 -``` -This identifier MUST be used by the data provider to define the semantics of the data being -transferred. - -The rdf turtle file, an instance of the Semantic Aspect Meta Model, is the master for generating -additional file formats and serializations. - -```text - https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.week_based_material_demand/1.0.0/WeekBasedMaterialDemand.ttl -``` - -The open source command line tool of the Eclipse Semantic Modeling Framework is used for generation -of other file formats like for example a JSON Schema, aasx for Asset Administration Shell Submodel -Template or a HTML documentation. - -## ASPECT MODEL "WeekBasedCapacityGroup" - -The capacity group information MUST be sent from the supplier to the customer according to the -[CX-0048](https://catena-x.net/de/standard-library) standard. The data format described here MUST be followed for the exchange of the capacity group information. - -The capacity group data model MUST be implemented by all participants who wish to participate in the -Catena-X DCM network as a customer or supplier. - -Companies, who participate in the Catena-X Network as a supplier, MUST be able to receive material -demand information and MUST be able to send capacity group information. - -Companies, who participate in the Catena-X Network as a customer, MUST be able to send material -demand information and MUST be able to receive capacity group information. - -Companies who participate in the Catena-X Network with both roles therefore MUST be able to receive -and send both, material demand as well as capacity group information. It is recommended that -companies implement both standards. - -Every data provider of `WeekBasedCapacityGroup` data MUST provide the data conformant to the -semantic model specified in this document. - -The unique identifier of the semantic model specified in this document MUST be used by the data -provider to define the semantics of the data being transferred. - -Every certified business application relying on `WeekBasedCapacityGroup` data MUST be able to -consume data conformant to the semantic model specified in this document. - -Data consumers and data provider MUST comply with the license of the semantic model. - -In the Catena-X data space `WeekBasedCapacityGroup` data MUST be requested and exchanged via Eclipse -Dataspace Connector (EDC) conformant to [CX-0018](https://catena-x.net/de/standard-library) and [CX-0002](https://catena-x.net/de/standard-library). - -The characteristics BPNL and BPNS MUST be used according to the standard [CX-0010](https://catena-x.net/de/standard-library). - -### Sample Data - -```json -{ - "unitOfMeasure": "GRM", - "linkedDemandSeries": [ - { - "materialNumberCustomer": "MNR-7307-AU340474.002", - "materialNumberSupplier": "MNR-8101-ID146955.001", - "customerLocation": "BPNS8888888888XX", - "demandCategory": { - "demandCategoryCode": "0001" - } - } - ], - "supplier": "BPNL6666666666YY", - "name": "Spark Plugs on drilling machine for car model XYZ", - "supplierLocations": "BPNS8888888888XX", - "capacities": [ - { - "calendarWeek": "2022-08-01", - "actualCapacity": 1, - "maximumCapacity": 2 - } - ], - "changedAt": "2023-03-10T12:27:11.320Z", - "capacityGroupId": "0157ba42-d2a8-4e28-8565-7b07830c1110", - "customer": "BPNL8888888888XX" -} -``` - -The semantic model has the unique identifier -```text - urn:bamm:io.catenax.week_based_capacity_group:1.0.0 -``` -This identifier MUST be used by the data provider to define the semantics of the data being -transferred. - -The rdf turtle file, an instance of the Semantic Aspect Meta Model, is the master for generating -additional file formats and serializations. -```text - https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.week_based_capacity_group/1.0.0/WeekBasedCapacityGroup.ttl -``` -The open source command line tool of the Eclipse Semantic Modeling Framework is used for generation -of other file formats like for example a JSON Schema, aasx for Asset Administration Shell Submodel -Template or a HTML documentation. - -## Data Exchange - -### General Overview - -The `WeekBasedMaterialDemand` as well as the `WeekBasedCapacityGroup` is a JSON -string which is sent through EDC. The JSON string is standardized in this document and contains -either `WeekBasedMaterialDemand` or `WeekBasedCapacityGroup` information. - -The standard only describes the sending and receiving of `WeekBasedMaterialDemand` and -`WeekBasedCapacityGroup` through EDC. Both objects are created and handled by applications of the -companies involved, but these applications are not part of the standard. - -### WeekBasedMaterialDemand API - -To support the exchange of `WeekBasedMaterialDemand` data, a business application MUST define a -single endpoint supporting the HTTP POST request method as described in [RFC9110](https://datatracker.ietf.org/doc/html/rfc9110.html). -The structure of the endpoint MAY be freely chosen. The address of the endpoint MUST be provided -as part of the EDC Data Asset defined in this document. - -The WeekBasedMaterialDemand data MUST be sent from the customer to the supplier using an HTTP POST -request. The data format described here MUST be followed for the exchange of the material demand -information. - -Multiple `WeekBasedMaterialDemand` aspects MAY be sent in one transfer as a JSON list. If only one -`WeekBasedMaterialDemand` aspect is transmitted, it MUST still be sent as a list with one entry. - -The serialized JSON MUST NOT be larger than 15 MiB in size. - -The `WeekBasedMaterialDemand` endpoint MUST be implemented by all participants who wish to -participate in the Catena-X DCM network as a supplier. Customers MUST be able to send material -demand objects to their suppliers. - -The data payload itself MUST be a valid JSON file. - -All attributes marked as mandatory in the standard [CX-0047](https://catena-x.net/de/standard-library) MUST be included in the dataset. Attributes marked as 'Optional' MAY be included in the data set. - -The usage of the attributes in the data model MUST follow the attribute descriptions in the definitions -in [CX-0046](https://catena-x.net/de/standard-library). While some attributes are technically a -string, not any string is valid. For example, expectedSupplierLocations MUST be formatted as a BPNS. - -The calenderWeek MUST be set to a Monday of the week for that specific demand. The date format MUST -be in accordance with ISO8601 and MUST be in the format YYYY-MM-DD (for example 2023-02-13). - -The attributes 'demandCategory' and 'unitOfMeasure' MUST be set to one of the defined values as -defined in the standard [CX-0047](https://catena-x.net/de/standard-library). - - > **Definition from [CX-0046](https://catena-x.net/de/standard-library)** (Standardized there, non-normative -quote here) _"The customer owns and MUST publish its own demand with its supplier for the future -horizon and it is highly RECOMMENDED to avoid any gaps as far as possible and to share demand data -at least till month 9, to ensure DCM participants to have also sufficient demand data to work with._ -_If more demand data is available (i.e. demand related to a horizon that spans beyond month 9), the -customer MAY ideally provide them until month 24. If a customer has even more demand data available -(i.e. demand related to a horizon that spans beyond month 24), he MAY also provide this to his -supplier._ _The data series MAY start already from week n+2._ _Although the data series MAY start -already from week n+2 and can be elaborated from a technical perspective, the DCM process have a -clear focus on the tactical mid- to long-term horizon (typically considered from month 4 to 24) to -enable a more resilient supply chain."_ - -In addition to the definitions from [CX-0046](https://catena-x.net/de/standard-library) quoted above, the following rules have to be followed: - -The data series in the `WeekBasedMaterialDemand` SHOULD start already from week _n+2_. - -The demand for the current week (_n=0_) and the next week (_n=1_) MAY be included in the dataset. -The `WeekBasedMaterialDemand` MUST include at least one week other than the current or the next week -(meaning it may not be empty). Every week MUST NOT be included multiple times in the same -`WeekBasedMaterialDemand`. - -If the demand for one of the weeks changes, the whole dataset MUST be sent to the supplier; sending -the changes only (delta update / incremental update) is not possible. By this procedure, -inconsistent or incomplete data sets are avoided. One data transfer MUST contain at least one -`WeekBasedMaterialDemand` data set. - -For the combination of the attributes supplier, customer and materialNumberCustomer in the object -`WeekBasedMaterialDemand`, there MUST NOT be more than one `WeekBasedMaterialDemand` object in -existence. This means that the customer needs to collect all demands for all factories and send them -aggregated as one `WeekBasedMaterialDemand` to the supplier. - -If the demand in a certain week has the value `0`, it MUST be explicitly included as such in the -`WeekBasedMaterialDemand`, meaning the week cannot be left out (as there is a difference between -null and 0). Weeks with an unknown demand (value `null`) SHOULD be left out. - -#### UUID generation and handling - -The UUIDv4 MUST be generated according to [RFC4122](https://www.rfc-editor.org/rfc/rfc4122). - -For technical purposes the UUID MUST be treated as unique. In order to reduce the probability of -collision as well as to eliminate certain attack vectors it MUST be treated as unique within the -supplier-customer relationship. It SHOULD NOT be treated as globally unique for the reasons stated -above. - -For the combination of attributes: supplier, customer and materialNumberCustomer in the object -`WeekBasedMaterialDemand`, there MUST be exactly one unique UUID. - -#### EDC Data Asset Structure - -The HTTP POST endpoint introduced MUST NOT be called from a supply chain partner directly. Rather, it MUST be called via an EDC communication. -Therefore, the endpoint MUST be offered as an EDC Data Asset. The latter MUST have a property -`asset:prop:dcm` with value `weekbasedmaterialdemand-endpoint`. This property SHOULD be used to -identify the asset when searching the assets catalog of a supplier. Because the asset reflects the -contractual relationship between a supplier and its customers, only one asset with the -aforementioned property MUST be visible to the customer at any time to avoid ambiguity. - -An example EDC Data Asset definition with a corresponding access / usage policy and contract -definition are shown below. - -> Note: Expressions in double curly braces {{}} must be substituted with a corresponding value. - -```json -// Asset definition -{ - "asset": { - "properties": { - "asset:prop:id": "1", - "asset:prop:dcm": "weekbasedmaterialdemand-endpoint", - "asset:prop:description": "Endpoint for provisioning of week based material demands" - } - }, - "dataAddress": { - "properties": { - "type": "HttpData", - "baseUrl": "{{ **URL-WEEKBASEDMATERIALDEMAND-ENDPOINT** }}" - } - } -} -``` - -```json -// Access and Usage Policy definition -{ - "id": "1", - "policy": { - "prohibitions": [ - ], - "obligations": [ - ], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "USE" - }, - "constraints": [ - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BusinessPartnerNumber" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "{{ **CUSTOMER-BPN** }}" - }, - "operator": "EQ" - } - ] - } - ] - } -} -``` - -```json -// Contract definition -{ - "id": "1", - "criteria": [ - { - "operandLeft": "asset:prop:id", - "operator": "=", - "operandRight": "1" - } - ], - "accessPolicyId": "1", - "contractPolicyId": "1" -} -``` - -#### Error Handling and payload validation - -For error handling and payload validation instructions please refer to the [CX-0048](https://catena-x.net/de/standard-library) standard. - -### WeekBasedCapacityGroup API - -To support the exchange of `WeekBasedCapacityGroup` data, a business application MUST define a -single endpoint supporting the HTTP POST request method as described in [RFC9110](https://datatracker.ietf.org/doc/html/rfc9110.html). The structure of the endpoint MAY be freely chosen. The address of the endpoint MUST be provided as part of the EDC Data Asset defined in this document. - -The `WeekBasedCapacityGroup` data MUST be sent from the supplier to the customer using an HTTP POST -request. The data format described here MUST be followed for the exchange of the capacity group -information. - -Multiple `WeekBasedCapacityGroup` aspects MAY be sent in one transfer as a JSON list. If only one -`WeekBasedCapacityGroup` aspect is transmitted, it MUST still be sent as a list with one entry. - -The serialized JSON MUST NOT be larger than 15 MiB in size. - -The WeekBasedCapacityGroup endpoint MUST be implemented by all participants who wish to participate -in the Catena-X DCM network as a customer. Suppliers MUST be able to send `WeekBasedCapacityGroup` -objects to their customers. - -The data payload itself MUST be a valid JSON file. - -All attributes marked as mandatory in the standard [CX-0047](https://catena-x.net/de/standard-library) MUST be -included in the dataset. Attribute marked as 'Optional' CAN be included in the data set. - -The usage of the attributes in the data model MUST follow the attribute descriptions in the standard -[CX-0047](https://catena-x.net/de/standard-library) and the definitions in [CX-0046](#41-normative-references). For example, an exact definition of the different capacities is provided there and needs to be observed. - -While some attributes are technically a string, not any string is valid. For example, supplier MUST -be formatted as a BPNL. - -The calenderWeek MUST be set to a Monday of the week for that specific `WeekBasedCapacityGroup`. The -date format MUST be in accordance with ISO8601 and MUST be in the -format YYYY-MM-DD (for example 2023-02-13). - -The data payload itself MUST be a valid JSON file. - -The attributes 'demandCategory' and 'unitOfMeasure' MUST be set to one of the defined values as -defined in the standard [CX-0047](https://catena-x.net/de/standard-library). - -The capacities for the current week (_n=0_) and the next week (_n=1_) MAY be included in the -dataset. The `WeekBasedCapacityGroup` MUST include at least one week other than the current or the -next week (meaning it may not be empty). Every week MUST NOT be included multiple times in the same -`WeekBasedCapacityGroup`. - -If the capacity for one of the weeks changes, the whole dataset MUST be sent to the customer, -sending the changes only (delta update / incremental update) is NOT possible. By this procedure, -inconsistent or incomplete data sets are avoided. One data transfer MUST contain at least one -`WeekBasedCapacityGroup` data set. - -Additional business-process related rules are specified in the 'process template', these MUST be -followed as well. For example, the 'process template' defines a capacity and how it is to be -interpreted or that a demand must be consistent with other exchanged information such as call-offs. -All `WeekBasedCapacityGroup` objects MUST only use a mutually agreed unit of measure (as defined in -the standard [CX-0046](https://catena-x.net/de/standard-library)). - -The property linkedDemandSeries is used to indicate to which `WeekBasedMaterialDemand` object a -`WeekBasedCapacityGroup` object refers to. More specifically, the linkedDemandSeries refers to a -demand for a specific demandCategory / customerLocation / materialNumberCustomer combination. - -One specific combination of demandCategory / customerLocation / materialNumberCustomer MAY be -referred to in multiple `WeekBasedCapacityGroup` objects. Therefore, one materialNumberCustomer MAY -be contained in linkedDemandSeries of several different `WeekBasedCapacityGroup` objects. - -The order of the entries listed in the linkedDemandSeries of a `WeekBasedCapacityGroup` is arbitrary -and MUST be treated as such. - -#### UUID generation and handling - -The UUIDv4 MUST be generated according to [RFC4122](https://www.rfc-editor.org/rfc/rfc4122). - -For technical purposes the UUID MUST be treated as unique. In order to reduce the probability of -collision as well as to eliminate certain attack vectors it MUST be treated as unique within the -supplier-customer relationship. It SHOULD NOT be treated as globally unique for the reasons stated -above. - -#### EDC Data Asset Structure - -The HTTP POST endpoint introduced MUST NOT be called from a supply chain partner directly. Rather, it MUST be called via an EDC communication. Therefore, the endpoint MUST be offered as an EDC Data Asset. The latter MUST have a property " **asset:prop:dcm**" with value " **weekbasedcapacitygroup-endpoint**". This property SHOULD be used to identify the asset when searching the assets catalog of a customer. Because the asset reflects -the contractual relationship between a customer and its suppliers, only one asset with the -aforementioned property MUST be visible to the supplier at any time to avoid ambiguity. - -An example EDC Data Asset definition with a corresponding access / usage policy and contract -definition are shown below. - -> Note: Expressions in double curly braces {{}} must be substituted with a corresponding value. - -```json -// Asset definition -{ - "asset": { - "properties": { - "asset:prop:id": "1", - "asset:prop:dcm": "weekbasedcapacitygroup-endpoint", - "asset:prop:description": "Endpoint for provisioning of week based capacity groups" - } - }, - "dataAddress": { - "properties": { - "type": "HttpData", - "baseUrl": "{{URL-WEEKBASEDCAPACITYGROUP-ENDPOINT}}" - } - } -} -``` - -```json -// Access and Usage Policy definition -{ - "id": "1", - "policy": { - "prohibitions": [ - ], - "obligations": [ - ], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "USE" - }, - "constraints": [ - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BusinessPartnerNumber" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "{{SUPPLIER-BPN}}" - }, - "operator": "EQ" - } - ] - } - ] - } -} -``` - -```json -// Contract definition -{ - "id": "1", - "criteria": [ - { - "operandLeft": "asset:prop:id", - "operator": "=", - "operandRight": "1" - } - ], - "accessPolicyId": "1", - "contractPolicyId": "1" -} -``` - -#### Error Handling and payload validation - -For error handling and payload validation instructions please refer to the [CX-0048](https://catena-x.net/de/standard-library) standard. \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Documentation/admin_guide.md b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Documentation/admin_guide.md deleted file mode 100644 index 870c52e0cf2..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Documentation/admin_guide.md +++ /dev/null @@ -1,721 +0,0 @@ ---- -id: irs_admin_guide -title: Administration Guide -description: 'Administration Guide' -sidebar_position: 3 ---- - -![Datachain kit banner](@site/static/img/DataChainKitIcon.png) - -### 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. - -![adminguide_000](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/adminguide/adminguide_000.png) - -## Installation - -The IRS Helm repository can be found here: - - -Use the latest release of the "irs-helm" chart. -It contains all required dependencies. - -If you also want to set up your own EDC consumer, use the "irs-edc-consumer" chart. - -Supply the required configuration properties (see chapter [Configuration](configuration.adoc#_configuration)) in a values.yaml file or override the settings directly. - -### Deployment using Helm - -Add the IRS Helm repository: - -$ helm repo add irs - -Then install the Helm chart into your cluster: - -$ helm install -f your-values.yaml irs-app irs/irs-helm - -### Deployment using ArgoCD - -Create a new Helm chart and use the IRS as a dependency. - -```yaml -dependencies: - - name: irs-helm - repository: https://eclipse-tractusx.github.io/item-relationship-service - version: 3.x.x - - name: irs-edc-consumer # optional - repository: https://eclipse-tractusx.github.io/item-relationship-service - version: 1.x.x - -``` - -Then provide your configuration as the values.yaml of that chart. - -Create a new application in ArgoCD and point it to your repository / Helm chart folder. - -## Configuration - -Take the following template and adjust the configuration parameters (<placeholders> mark the relevant spots). -You can define the URLs as well as most of the secrets yourself. - -The Keycloak, DAPS and Vault configuration / secrets depend on your setup and might need to be provided externally. - -## Spring Configuration - -The IRS application is configured using the Spring configuration mechanism. The main configuration file is the ``application.yaml``. - -```yaml -server: - port: 8080 # The port the main application API listens on - trustedPort: ${SERVER_TRUSTED_PORT:} # The port used for the unsecured, internal API - if empty, the main port is used - -spring: - application: - name: item-relationship-service - security: - oauth2: - client: - registration: - keycloak: - authorization-grant-type: client_credentials - client-id: ${KEYCLOAK_OAUTH2_CLIENT_ID} # OAuth2 client ID used to authenticate with the IAM - client-secret: ${KEYCLOAK_OAUTH2_CLIENT_SECRET} # OAuth2 client secret used to authenticate with the IAM - provider: - keycloak: - token-uri: ${KEYCLOAK_OAUTH2_CLIENT_TOKEN_URI:https://default} # OAuth2 endpoint to request tokens using the client credentials - resourceserver: - jwt: - jwk-set-uri: ${KEYCLOAK_OAUTH2_JWK_SET_URI:https://default} # OAuth2 endpoint to request the JWK set - -management: # Spring management API config, see https://spring.io/guides/gs/centralized-configuration/ - endpoints: - web: - exposure: - include: health, threaddump, loggers, prometheus, info, metrics - endpoint: - health: - probes: - enabled: true - group: - readiness: - include: readinessState, diskSpace - show-details: always - health: - livenessstate: - enabled: true - readinessstate: - enabled: true - metrics: - distribution: - percentiles-histogram: - http: true - tags: - application: ${spring.application.name} - server: - port: 4004 - -logging: - pattern: - console: "%d %-5level %logger : %msg%n" - level: - root: WARN - org.springframework: INFO - org.eclipse.tractusx.irs: INFO - -springdoc: # API docs configuration - api-docs: - path: /api/api-docs - swagger-ui: - path: /api/swagger-ui - writer-with-order-by-keys: true - -irs: # Application config - apiUrl: "${IRS_API_URL:http://localhost:8080}" # Public URL of the application, used in Swagger UI - job: - callback: - timeout: - read: PT90S # HTTP read timeout for the Job API callback - connect: PT90S # HTTP connect timeout for the Job API callback - cleanup: # Determines how often the JobStore is being cleaned up. Different schedulers for completed and failed jobs. - scheduler: - # ┌───────────── second (0-59) - # │ ┌───────────── minute (0 - 59) - # │ │ ┌───────────── hour (0 - 23) - # │ │ │ ┌───────────── day of the month (1 - 31) - # │ │ │ │ ┌───────────── month (1 - 12) (or JAN-DEC) - # │ │ │ │ │ ┌───────────── day of the week (0 - 7) - # │ │ │ │ │ │ (or MON-SUN -- 0 or 7 is Sunday) - # │ │ │ │ │ │ - completed: 0 0 * * * * # every hour - failed: 0 0 * * * * # every hour - jobstore: - ttl: # Determines how long jobs are stored in the respective state. After the TTL has expired, the job will be removed by the cleanup scheduler. - failed: P7D # ISO 8601 Duration - completed: P7D # ISO 8601 Duration - cron: - expression: "*/10 * * * * ?" # Determines how often the number of stored jobs is updated in the metrics API. - -blobstore: - endpoint: "${MINIO_URL}" # S3 compatible API endpoint (e.g. Minio) - accessKey: "${MINIO_ACCESS_KEY}" # S3 access key - secretKey: "${MINIO_SECRET_KEY}" # S3 secret key - bucketName: irsbucket # the name of the S3 bucket to be created / used by the IRS - -resilience4j: - retry: # REST client retry configuration - configs: - default: - maxAttempts: 3 # How often failed REST requests will be retried - waitDuration: 10s # How long to wait between each retry - enableExponentialBackoff: true # Whether subsequent retries will delay exponentially or not - exponentialBackoffMultiplier: 2 # Multiplier for the exponential delay - ignore-exceptions: # Do not retry on the listed exceptions - - org.springframework.web.client.HttpClientErrorException.NotFound - instances: - registry: - baseConfig: default - - -edc: - controlplane: - request-ttl: ${EDC_CONTROLPLANE_REQUEST_TTL:PT10M} # How long to wait for an async EDC negotiation request to finish, ISO 8601 Duration - endpoint: - data: ${EDC_CONTROLPLANE_ENDPOINT_DATA:} # URL of the EDC consumer controlplane data endpoint - provider-suffix: ${EDC_CONTROLPLANE_PROVIDER_SUFFIX:/api/v1/ids/data} # Suffix to add to data requests to the EDC provider controlplane - catalog-limit: ${EDC_CONTROLPLANE_CATALOG_LIMIT:1000} # Max number of items to fetch from the EDC provider catalog - catalog-page-size: ${EDC_CONTROLPLANE_CATALOG_PAGE_SIZE:50} # Number of items to fetch at one page from the EDC provider catalog when using pagination - api-key: - header: ${EDC_API_KEY_HEADER:} # API header key to use in communication with the EDC consumer controlplane - secret: ${EDC_API_KEY_SECRET:} # API header secret to use in communication with the EDC consumer controlplane - datareference: - storage: - duration: PT1H # Time after which stored data references will be cleaned up, ISO 8601 Duration - - submodel: - request-ttl: ${EDC_SUBMODEL_REQUEST_TTL:PT10M} # How long to wait for an async EDC submodel retrieval to finish, ISO 8601 Duration - path: ${EDC_SUBMODEL_PATH:/submodel} # The path to append to the submodel data reference endpoint - urn-prefix: ${EDC_SUBMODEL_URN_PREFIX:/urn} # A prefix used to identify URNs correctly in the submodel endpoint address - timeout: - read: PT90S # HTTP read timeout for the submodel client - connect: PT90S # HTTP connect timeout for the submodel client - - catalog: - cache: - enabled: true # Set to false to disable caching - ttl: P1D # Time after which a cached Item is no longer valid and the real catalog is called instead - maxCachedItems: 64000 # Maximum amount of cached catalog items - -digitalTwinRegistry: - descriptorEndpoint: ${DIGITALTWINREGISTRY_DESCRIPTOR_URL:} # The endpoint to retrieve AAS descriptors from the DTR, must contain the placeholder {aasIdentifier} - shellLookupEndpoint: ${DIGITALTWINREGISTRY_SHELL_LOOKUP_URL:} # The endpoint to lookup shells from the DTR, must contain the placeholder {assetIds} - oAuthClientId: keycloak # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client - timeout: - read: PT90S # HTTP read timeout for the digital twin registry client - connect: PT90S # HTTP connect timeout for the digital twin registry client - -semanticshub: - # The endpoint to retrieve the json schema of a model from the semantic hub. If specified, must contain the placeholder {urn}. - modelJsonSchemaEndpoint: "${SEMANTICSHUB_URL:}" - url: "" - - # Path to directory on filesystem where semantic models can be loaded from. - # The filenames inside the directory must match the Base64 encoded URNs of the models. - localModelDirectory: "" - cleanup: - # ┌───────────── second (0-59) - # │ ┌───────────── minute (0 - 59) - # │ │ ┌───────────── hour (0 - 23) - # │ │ │ ┌───────────── day of the month (1 - 31) - # │ │ │ │ ┌───────────── month (1 - 12) (or JAN-DEC) - # │ │ │ │ │ ┌───────────── day of the week (0 - 7) - # │ │ │ │ │ │ (or MON-SUN -- 0 or 7 is Sunday) - # │ │ │ │ │ │ - scheduler: 0 0 23 * * * # How often to clear the semantic model cache - defaultUrns: "${SEMANTICSHUB_DEFAULT_URNS:urn:bamm:io.catenax.serial_part_typization:1.0.0#SerialPartTypization}" # IDs of models to cache at IRS startup - oAuthClientId: keycloak # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client - timeout: - read: PT90S # HTTP read timeout for the semantic hub client - connect: PT90S # HTTP connect timeout for the semantic hub client - pageSize: "${SEMANTICSHUB_PAGE_SIZE:100}" - -bpdm: - bpnEndpoint: "${BPDM_URL:}" # Endpoint to resolve BPNs, must contain the placeholders {partnerId} and {idType} - oAuthClientId: keycloak # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client - timeout: - read: PT90S # HTTP read timeout for the bpdm client - connect: PT90S # HTTP connect timeout for the bpdm client - -apiAllowedBpn: ${API_ALLOWED_BPN:BPNL00000003CRHK} -``` - -### Helm configuration IRS (values.yaml) - -```yaml - labelSelector: - matchExpressions: - - key: app.kubernetes.io/name - operator: DoesNotExist - topologyKey: kubernetes.io/hostname - -# Following Catena-X Helm Best Practices @url: https://catenax-ng.github.io/docs/kubernetes-basics/helm -# @url: https://github.com/helm/charts/blob/master/stable/nginx-ingress/values.yaml#L210 -livenessProbe: - failureThreshold: 6 - initialDelaySeconds: 30 - periodSeconds: 10 - successThreshold: 1 - timeoutSeconds: 1 -readinessProbe: - failureThreshold: 3 - initialDelaySeconds: 30 - periodSeconds: 10 - successThreshold: 1 - timeoutSeconds: 1 - -##################### -# IRS Configuration # -##################### -irsUrl: # "https://" -ingress: - enabled: false - -digitalTwinRegistry: - url: # "https://" - descriptorEndpoint: >- - {{ tpl (.Values.digitalTwinRegistry.url | default "") . }}/registry/shell-descriptors/{aasIdentifier} - shellLookupEndpoint: >- - {{ tpl (.Values.digitalTwinRegistry.url | default "") . }}/lookup/shells?assetIds={assetIds} -semanticshub: - url: # https:// - pageSize: "100" # Number of aspect models to retrieve per page - modelJsonSchemaEndpoint: >- - {{- if .Values.semanticshub.url }} - {{- tpl (.Values.semanticshub.url | default "" ) . }}/{urn}/json-schema - {{- end }} - defaultUrns: >- - # urn:bamm:io.catenax.serial_part_typization:1.0.0#SerialPartTypization - # ,urn:bamm:com.catenax.assembly_part_relationship:1.0.0#AssemblyPartRelationship - localModels: -# Map of Base64 encoded strings of semantic models. The key must be the Base64 encoded full URN of the model. -# Example for urn:bamm:io.catenax.serial_part_typization:1.1.1#SerialPartTypization: -# dXJuOmJhbW06aW8uY2F0ZW5heC5zZXJpYWxfcGFydF90eXBpemF0aW9uOjEuMS4xI1NlcmlhbFBhcnRUeXBpemF0aW9u: ewoJIiRzY2hlbWEiOiAiaHR0cDovL2pzb24tc2NoZW1hLm9yZy9kcmFmdC0wNC9zY2hlbWEiLAoJInR5cGUiOiAib2JqZWN0IiwKCSJjb21wb25lbnRzIjogewoJCSJzY2hlbWFzIjogewoJCQkidXJuX2JhbW1faW8uY2F0ZW5heC5zZXJpYWxfcGFydF90eXBpemF0aW9uXzEuMS4xX0NhdGVuYVhJZFRyYWl0IjogewoJCQkJInR5cGUiOiAic3RyaW5nIiwKCQkJCSJwYXR0ZXJuIjogIiheWzAtOWEtZkEtRl17OH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17MTJ9JCl8KF51cm46dXVpZDpbMC05YS1mQS1GXXs4fS1bMC05YS1mQS1GXXs0fS1bMC05YS1mQS1GXXs0fS1bMC05YS1mQS1GXXs0fS1bMC05YS1mQS1GXXsxMn0kKSIKCQkJfSwKCQkJInVybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9LZXlDaGFyYWN0ZXJpc3RpYyI6IHsKCQkJCSJ0eXBlIjogInN0cmluZyIKCQkJfSwKCQkJInVybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9WYWx1ZUNoYXJhY3RlcmlzdGljIjogewoJCQkJInR5cGUiOiAic3RyaW5nIgoJCQl9LAoJCQkidXJuX2JhbW1faW8uY2F0ZW5heC5zZXJpYWxfcGFydF90eXBpemF0aW9uXzEuMS4xX0tleVZhbHVlTGlzdCI6IHsKCQkJCSJ0eXBlIjogIm9iamVjdCIsCgkJCQkicHJvcGVydGllcyI6IHsKCQkJCQkia2V5IjogewoJCQkJCQkiJHJlZiI6ICIjL2NvbXBvbmVudHMvc2NoZW1hcy91cm5fYmFtbV9pby5jYXRlbmF4LnNlcmlhbF9wYXJ0X3R5cGl6YXRpb25fMS4xLjFfS2V5Q2hhcmFjdGVyaXN0aWMiCgkJCQkJfSwKCQkJCQkidmFsdWUiOiB7CgkJCQkJCSIkcmVmIjogIiMvY29tcG9uZW50cy9zY2hlbWFzL3Vybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9WYWx1ZUNoYXJhY3RlcmlzdGljIgoJCQkJCX0KCQkJCX0sCgkJCQkicmVxdWlyZWQiOiBbCgkJCQkJImtleSIsCgkJCQkJInZhbHVlIgoJCQkJXQoJCQl9LAoJCQkidXJuX2JhbW1faW8uY2F0ZW5heC5zZXJpYWxfcGFydF90eXBpemF0aW9uXzEuMS4xX0xvY2FsSWRlbnRpZmllckNoYXJhY3RlcmlzdGljIjogewoJCQkJInR5cGUiOiAiYXJyYXkiLAoJCQkJIml0ZW1zIjogewoJCQkJCSIkcmVmIjogIiMvY29tcG9uZW50cy9zY2hlbWFzL3Vybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9LZXlWYWx1ZUxpc3QiCgkJCQl9LAoJCQkJInVuaXF1ZUl0ZW1zIjogdHJ1ZQoJCQl9LAoJCQkidXJuX2JhbW1faW8ub3Blbm1hbnVmYWN0dXJpbmdfY2hhcmFjdGVyaXN0aWNfMi4wLjBfVGltZXN0YW1wIjogewoJCQkJInR5cGUiOiAic3RyaW5nIiwKCQkJCSJwYXR0ZXJuIjogIi0/KFsxLTldWzAtOV17Myx9fDBbMC05XXszfSktKDBbMS05XXwxWzAtMl0pLSgwWzEtOV18WzEyXVswLTldfDNbMDFdKVQoKFswMV1bMC05XXwyWzAtM10pOlswLTVdWzAtOV06WzAtNV1bMC05XShcXC5bMC05XSspP3woMjQ6MDA6MDAoXFwuMCspPykpKFp8KFxcK3wtKSgoMFswLTldfDFbMC0zXSk6WzAtNV1bMC05XXwxNDowMCkpPyIKCQkJfSwKCQkJInVybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9Qcm9kdWN0aW9uQ291bnRyeUNvZGVUcmFpdCI6IHsKCQkJCSJ0eXBlIjogInN0cmluZyIsCgkJCQkicGF0dGVybiI6ICJeW0EtWl1bQS1aXVtBLVpdJCIKCQkJfSwKCQkJInVybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9NYW51ZmFjdHVyaW5nQ2hhcmFjdGVyaXN0aWMiOiB7CgkJCQkidHlwZSI6ICJvYmplY3QiLAoJCQkJInByb3BlcnRpZXMiOiB7CgkJCQkJImRhdGUiOiB7CgkJCQkJCSIkcmVmIjogIiMvY29tcG9uZW50cy9zY2hlbWFzL3Vybl9iYW1tX2lvLm9wZW5tYW51ZmFjdHVyaW5nX2NoYXJhY3RlcmlzdGljXzIuMC4wX1RpbWVzdGFtcCIKCQkJCQl9LAoJCQkJCSJjb3VudHJ5IjogewoJCQkJCQkiJHJlZiI6ICIjL2NvbXBvbmVudHMvc2NoZW1hcy91cm5fYmFtbV9pby5jYXRlbmF4LnNlcmlhbF9wYXJ0X3R5cGl6YXRpb25fMS4xLjFfUHJvZHVjdGlvbkNvdW50cnlDb2RlVHJhaXQiCgkJCQkJfQoJCQkJfSwKCQkJCSJyZXF1aXJlZCI6IFsKCQkJCQkiZGF0ZSIKCQkJCV0KCQkJfSwKCQkJInVybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9QYXJ0SWRDaGFyYWN0ZXJpc3RpYyI6IHsKCQkJCSJ0eXBlIjogInN0cmluZyIKCQkJfSwKCQkJInVybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9QYXJ0TmFtZUNoYXJhY3RlcmlzdGljIjogewoJCQkJInR5cGUiOiAic3RyaW5nIgoJCQl9LAoJCQkidXJuX2JhbW1faW8uY2F0ZW5heC5zZXJpYWxfcGFydF90eXBpemF0aW9uXzEuMS4xX0NsYXNzaWZpY2F0aW9uQ2hhcmFjdGVyaXN0aWMiOiB7CgkJCQkidHlwZSI6ICJzdHJpbmciLAoJCQkJImVudW0iOiBbCgkJCQkJInByb2R1Y3QiLAoJCQkJCSJyYXcgbWF0ZXJpYWwiLAoJCQkJCSJzb2Z0d2FyZSIsCgkJCQkJImFzc2VtYmx5IiwKCQkJCQkidG9vbCIsCgkJCQkJImNvbXBvbmVudCIKCQkJCV0KCQkJfSwKCQkJInVybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9QYXJ0VHlwZUluZm9ybWF0aW9uQ2hhcmFjdGVyaXN0aWMiOiB7CgkJCQkidHlwZSI6ICJvYmplY3QiLAoJCQkJInByb3BlcnRpZXMiOiB7CgkJCQkJIm1hbnVmYWN0dXJlclBhcnRJZCI6IHsKCQkJCQkJIiRyZWYiOiAiIy9jb21wb25lbnRzL3NjaGVtYXMvdXJuX2JhbW1faW8uY2F0ZW5heC5zZXJpYWxfcGFydF90eXBpemF0aW9uXzEuMS4xX1BhcnRJZENoYXJhY3RlcmlzdGljIgoJCQkJCX0sCgkJCQkJImN1c3RvbWVyUGFydElkIjogewoJCQkJCQkiJHJlZiI6ICIjL2NvbXBvbmVudHMvc2NoZW1hcy91cm5fYmFtbV9pby5jYXRlbmF4LnNlcmlhbF9wYXJ0X3R5cGl6YXRpb25fMS4xLjFfUGFydElkQ2hhcmFjdGVyaXN0aWMiCgkJCQkJfSwKCQkJCQkibmFtZUF0TWFudWZhY3R1cmVyIjogewoJCQkJCQkiJHJlZiI6ICIjL2NvbXBvbmVudHMvc2NoZW1hcy91cm5fYmFtbV9pby5jYXRlbmF4LnNlcmlhbF9wYXJ0X3R5cGl6YXRpb25fMS4xLjFfUGFydE5hbWVDaGFyYWN0ZXJpc3RpYyIKCQkJCQl9LAoJCQkJCSJuYW1lQXRDdXN0b21lciI6IHsKCQkJCQkJIiRyZWYiOiAiIy9jb21wb25lbnRzL3NjaGVtYXMvdXJuX2JhbW1faW8uY2F0ZW5heC5zZXJpYWxfcGFydF90eXBpemF0aW9uXzEuMS4xX1BhcnROYW1lQ2hhcmFjdGVyaXN0aWMiCgkJCQkJfSwKCQkJCQkiY2xhc3NpZmljYXRpb24iOiB7CgkJCQkJCSIkcmVmIjogIiMvY29tcG9uZW50cy9zY2hlbWFzL3Vybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9DbGFzc2lmaWNhdGlvbkNoYXJhY3RlcmlzdGljIgoJCQkJCX0KCQkJCX0sCgkJCQkicmVxdWlyZWQiOiBbCgkJCQkJIm1hbnVmYWN0dXJlclBhcnRJZCIsCgkJCQkJIm5hbWVBdE1hbnVmYWN0dXJlciIsCgkJCQkJImNsYXNzaWZpY2F0aW9uIgoJCQkJXQoJCQl9CgkJfQoJfSwKCSJwcm9wZXJ0aWVzIjogewoJCSJjYXRlbmFYSWQiOiB7CgkJCSIkcmVmIjogIiMvY29tcG9uZW50cy9zY2hlbWFzL3Vybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9DYXRlbmFYSWRUcmFpdCIKCQl9LAoJCSJsb2NhbElkZW50aWZpZXJzIjogewoJCQkiJHJlZiI6ICIjL2NvbXBvbmVudHMvc2NoZW1hcy91cm5fYmFtbV9pby5jYXRlbmF4LnNlcmlhbF9wYXJ0X3R5cGl6YXRpb25fMS4xLjFfTG9jYWxJZGVudGlmaWVyQ2hhcmFjdGVyaXN0aWMiCgkJfSwKCQkibWFudWZhY3R1cmluZ0luZm9ybWF0aW9uIjogewoJCQkiJHJlZiI6ICIjL2NvbXBvbmVudHMvc2NoZW1hcy91cm5fYmFtbV9pby5jYXRlbmF4LnNlcmlhbF9wYXJ0X3R5cGl6YXRpb25fMS4xLjFfTWFudWZhY3R1cmluZ0NoYXJhY3RlcmlzdGljIgoJCX0sCgkJInBhcnRUeXBlSW5mb3JtYXRpb24iOiB7CgkJCSIkcmVmIjogIiMvY29tcG9uZW50cy9zY2hlbWFzL3Vybl9iYW1tX2lvLmNhdGVuYXguc2VyaWFsX3BhcnRfdHlwaXphdGlvbl8xLjEuMV9QYXJ0VHlwZUluZm9ybWF0aW9uQ2hhcmFjdGVyaXN0aWMiCgkJfQoJfSwKCSJyZXF1aXJlZCI6IFsKCQkiY2F0ZW5hWElkIiwKCQkibG9jYWxJZGVudGlmaWVycyIsCgkJIm1hbnVmYWN0dXJpbmdJbmZvcm1hdGlvbiIsCgkJInBhcnRUeXBlSW5mb3JtYXRpb24iCgldCn0= -bpdm: - url: # https:// - bpnEndpoint: >- - {{ tpl (.Values.bpdm.url | default "") . }}/api/catena/legal-entities/{partnerId}?idType={idType} -minioUser: "minio" # -minioPassword: # -minioUrl: "http://{{ .Release.Name }}-minio:9000" -keycloak: - oauth2: - clientId: # - clientSecret: # - clientTokenUri: # - jwkSetUri: # -edc: - controlplane: - endpoint: - data: "" # - request: - ttl: PT10M # Requests to controlplane will time out after this duration (see https://en.wikipedia.org/wiki/ISO_8601#Durations) - provider: - suffix: /api/v1/ids/data - catalog: - limit: 1000 # Max number of catalog items to retrieve from the controlplane - pagesize: 50 # Number of catalog items to retrieve on one page for pagination - apikey: - header: "X-Api-Key" # Name of the EDC api key header field - secret: "" # - submodel: - request: - ttl: PT10M # Requests to dataplane will time out after this duration (see https://en.wikipedia.org/wiki/ISO_8601#Durations) - path: /submodel - urnprefix: /urn - catalog: - cache: - enabled: true # Set to false to disable caching - ttl: P1D # Time after which a cached Item is no longer valid and the real catalog is called instead - maxCachedItems: 64000 # Maximum amount of cached catalog items - -config: - # If true, the config provided below will completely replace the configmap. - # In this case, you need to provide all required config values defined above yourself! - # If false, the custom config will just be appended to the configmap. - override: false - # Provide your custom configuration here (overrides IRS Spring application.yaml) - content: - - -env: [] # You can provide your own environment variables for the IRS here. -# - name: JAVA_TOOL_OPTIONS -# value: -Dhttps.proxyHost=1.2.3.4 - - -####################### -# Minio Configuration # -####################### -minio: - enabled: true - mode: standalone - persistence: - size: 1Gi - resources: - limits: - cpu: 1 - memory: 4Gi - requests: - cpu: 0.25 - memory: 4Gi - rootUser: "minio" # - rootPassword: "minioPass" # - - environment: - MINIO_PROMETHEUS_JOB_ID: minio-actuator - MINIO_PROMETHEUS_URL: http://prometheus:9090 - - -############################ -# Prometheus Configuration # -############################ -prometheus: - enabled: false # â‘ - rbac: - create: false - alertmanager: - enabled: false - prometheus-node-exporter: - enabled: false - kubeStateMetrics: - enabled: false - prometheus-pushgateway: - enabled: false - configmapReload: - prometheus: - enabled: false - - extraScrapeConfigs: | - - job_name: 'spring-actuator' - metrics_path: '/actuator/prometheus' - scrape_interval: 5s - static_configs: - - targets: [ '{{ .Release.Name }}-irs-helm:4004' ] - - - job_name: 'minio-actuator' - metrics_path: /minio/v2/metrics/cluster - static_configs: - - targets: [ '{{ .Release.Name }}-minio:9000' ] - - -######################### -# Grafana Configuration # -######################### -grafana: - enabled: false # â‘ - rbac: - create: false - persistence: - enabled: false - - user: # -``` - -1. Use this to enable or disable the monitoring components - -#### Values explained - -##### irs-url - -The hostname where the IRS will be made available. - -##### digital-twin-registry-url - -The URL of the Digital Twin Registry. The IRS uses this service to fetch AAS shells. - -##### semantics-hub-url - -The URL of the SemanticsHub. The IRS uses this service to fetch aspect schemas for payload validation. - -##### bpdm-url - -The URL of the BPDM service. The IRS uses this service to fetch business partner information based on BPNs. - -##### keycloak-token-uri - -The URL of the Keycloak token API. Used by the IRS for token creation to authenticate with other services. - -##### keycloak-jwkset-uri - -The URL of the Keycloak JWK Set. Used by the IRS to validate tokens when the IRS API is called. - -##### grafana-url - -The hostname where Grafana will be made available. - -##### edc-controlplane-endpoint-data - -The EDC consumer controlplane endpoint URL for data management, including the protocol. -If left empty, this defaults to the internal endpoint of the controlplane provided by the irs-edc-consumer Helm chart. - -#### Semantic Model Provisioning - -The IRS can retrieve semantic models in two ways: - -1. via the Semantic Hub, if you provide the URL -2. via local schema files - -If you activate both features, IRS will first try to resolve the models via the Hub and use the -local models as a fallback. - -If you want to use local schema files, you need to provide them directly in the `values.yaml` file. Use the param `semanticsHub.localModels` to specify a map of all the local schemas. -The **key** of each entry is the `Base64` encoded URN of the model. The **value** is the `Base64` encoded content of the schema file itself. The entries will then be mounted into the IRS container and used on demand. For reference, see the example comment in the default `values.yaml`. - -### EDC consumer configuration - -If you want to provide your own EDC consumer, add the following entries to your values.yaml: - -```yaml -############################## -# EDC Postgres Configuration # -############################## -postgresql: - auth: - username: edc - database: edc - postgresPassword: - password: - -################################## -# EDC Controlplane Configuration # -################################## -edc-controlplane: - ingresses: - - enabled: true - hostname: "" - annotations: - nginx.ingress.kubernetes.io/ssl-passthrough: "false" - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - nginx.ingress.kubernetes.io/force-ssl-redirect: "true" - endpoints: - - protocol - className: "" - tls: - - hosts: - - "" - secretName: tls-secret - certManager: - issuer: "" - clusterIssuer: "" - - edc: - receiver: - callback: - url: "http://{{ .Release.Name }}-irs-helm:8181/internal/endpoint-data-reference" # IRS EDC callback URL, e.g. http://app-irs-helm:8181/internal/endpoint-data-reference - postgresql: - user: edc - password: - transfer: - proxy: - token: - verifier: - publickey: - alias: - signer: - privatekey: - alias: - api: - auth: - key: "" - controlplane: - url: "https://" - dataplane: - url: "https://" - configuration: - properties: |- - edc.oauth.client.id= - edc.oauth.private.key.alias= - edc.oauth.provider.jwks.url= - edc.oauth.certificate.alias= - edc.oauth.token.url= - edc.vault.hashicorp.url= - edc.vault.hashicorp.token= - edc.vault.hashicorp.api.secret.path= - edc.data.encryption.keys.alias= - edc.data.encryption.algorithm=NONE - -############################### -# EDC Dataplane Configuration # -############################### -edc-dataplane: - edc: - api: - auth: - key: "" - ## Ingress declaration to expose the network service. - ingresses: - - enabled: true - hostname: "" - annotations: - nginx.ingress.kubernetes.io/ssl-passthrough: "false" - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - nginx.ingress.kubernetes.io/force-ssl-redirect: "true" - endpoints: - - public - className: "nginx" - tls: - - hosts: - - "" - secretName: tls-secret - certManager: - issuer: "" - clusterIssuer: "" - - configuration: - properties: |- - edc.oauth.client.id= - edc.oauth.private.key.alias= - edc.oauth.provider.audience=idsc:IDS_CONNECTORS_ALL - edc.oauth.provider.jwks.url= - edc.oauth.certificate.alias= - edc.oauth.token.url= - edc.vault.hashicorp.url= - edc.vault.hashicorp.token= - edc.vault.hashicorp.api.secret.path= -``` - -#### Values explained - -EDC requires a DAPS instance to function correctly. For more information on this, please refer to the [DAPS](https://github.com/catenax-ng/product-DAPS) or the [EDC](https://github.com/catenax-ng/product-edc) documentation. - -##### controlplane-url - -The hostname where the EDC consumer controlplane will be made available. - -##### dataplane-url - -The hostname where the EDC consumer dataplane will be made available. - -##### vault-url - -The base URL of the Vault instance. -EDC requires a running instance of HashiCorp Vault to store the DAPS certificate and private key. - -##### vault-secret-store-path - -The path to the secret store in Vault where the DAPS certificate and key can be found. - -Example: /v1/team-name - -##### daps-certificate-name - -The name of the DAPS certificate in the Vault. - -Example: irs-daps-certificate - -##### daps-privatekey-name - -The name of the DAPS private key in the Vault. - -Example: irs-daps-private-key - -##### daps-client-id - -The DAPS client ID. - -##### daps-jwks-url - -The URL of the DAPS JWK Set. - -Example: - -##### daps-token-url - -The URL of the DAPS token API. - -Example: - -### Secrets - -This is a list of all secrets used in the deployment. - -**⚠️ WARNING**\ -Keep the values for these settings safe and do not publish them! - -#### postgres-admin-password - -Database password for the **postgres** user. To be defined by you. - -#### postgres-password - -Database password for the application user (default username: **edc**). To be defined by you. - -#### keycloak-client-id - -Client ID for Keycloak. Request this from your Keycloak operator. - -#### keycloak-client-secret - -Client secret for Keycloak. Request this from your Keycloak operator. - -#### minio-username - -Login username for Minio. To be defined by you. - -#### minio-password - -Login password for Minio. To be defined by you. - -#### edc-api-key - -An API key for the EDC API. To be defined by you. - -#### vault-token - -The access token for the HashiCorp Vault API. - -#### grafana-username - -Login username for Grafana. To be defined by you. - -#### grafana-password - -Login password for Grafana. To be defined by you. - -## Troubleshooting - -### Proxy support - -If you are using an HTTP(S) proxy for outgoing connections, you need to configure the IRS to use it. - -```bash -JAVA_TOOL_OPTIONS=-Dhttps.proxyHost=X.X.X.X -Dhttps.proxyPort=XXXX -``` - -You might need to specify both `http` and `https` options, dependending on your configuration. - -If your proxy is requiring authentication, you can use the `.proxyUser` and `.proxyPassword` properties in addition. - -### Troubleshooting FAQ - -#### Minio - -##### Error: "The specified bucket does not exist" - -IRS tries to read data from or write to the Minio storage, but no bucket exists. This can happen if Minio is running without a persistent volume and restarts, thus losing all data. -It can also happen if the persistent volume claim is deleted / recreated. - -**Proposed solution steps:** - -1. Make sure Minio is configured and running correctly. -2. Restart the IRS - this will recreate the missing bucket automatically. - -#### Different Job model versions maintenance - -Currently, the IRS only supports one version of the Job model at a time. This means that if Job model is changed, old models stored in minio will no longer be supported and returned from IRS endpoints. The IRS application will work as usual, old versions of Job can stay in the minio and don’t need to be removed - the IRS will simply ignore them. If you want to clear the minio from old models - the only way to achieve that is to delete them all and register a new Jobs. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Documentation/arc42.md b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Documentation/arc42.md deleted file mode 100644 index da38b1af9e6..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Documentation/arc42.md +++ /dev/null @@ -1,883 +0,0 @@ ---- -id: irs_arc42 -title: Architecture documentation (arc42) - -description: 'Architecture documentation (arc42)' -sidebar_position: 3 ---- - - -![Datachain kit banner](@site/static/img/DataChainKitIcon.png) - -### Data Chain KIT - -## Introduction and goals - -This chapter gives you an overview about the goals of the service, -in which context the service runs and which stakeholders are involved. - -## Requirements overview - -### What is the Item Relationship Service? - -The IRS is a: - -* Functional federated component -* API endpoint to retrieve the tree structures in a recursive way, which data assets are distributed throughout the Catena-X network -* Reference implementation -* Data chain provider - -### Substantial Features - -* provide a top-down BoM asBuilt tree structure along the submodel "AssemblyPartRelationship" -* usage of EDC consumer for communicating with the Catena-X network -* functionality of IRS provider will be handled by providers submodel servers -* federated IRS service -* 'asBuild' BoM of serialized components -* provides endpoints for submodel-descriptors - -## Quality goals - -**❗ IMPORTANT**\ -The following table entries define overall IRS quality goals. The order of the topics do not resolve in a priority of the quality goals. - -| Quality goal | Motivation and description | -| --- | --- | -| running reference application | The IRS is built to traverse a distributed data chain across the automotive Industry. The goal for the IRS release 1 scope is to build a running solution to test the functionality of building a BoM as built of serialized components. | -| multiple async job orchestration | The IRS is built to access multiple endpoints parallel. Since the for the Endpoint it is not clear yet how long a request will take to respond. The Service is built to handle multiple asynchronous requests. | -| cloud agnostic solution | The IRS is built as reference architecture and able to run on different cloud solutions. It uses helm charts, terraform and a abstracts the storage, so that it can easily be integrated on different systems. | -| base security measures | The IRS is built with a base set of security features. | -| application reliability | The IRS architecture is set up so that the costumers can rely on reliable data chains | - -## Architecture constraints - -### Technical Constraints - -| Name | Description | -| --- | --- | -| Cloud Agnostic Architecture approach | IRS provides a reference application/implementation which is deployable on any cloud ecosystem. There is no vendor lock to any cloud vendor. | -| Spring Boot and the Spring framework is used as underlying framework for Java development. | Spring Boot and Framework is used to build an easy and production-grade based application which could be deployed without any further infrastructure components. Orchestrating application components and integrating with other libraries/frameworks. | -| Lombok | Lombok for generating boilerplate code. Keeping code concise increases quality and maintainability. | -| Kubernetes is used for Container Orchestration | Kubernetes as container orchestration system used for software deployment, scaling and management of the IRS application. This supports our software infrastructure and ensures efficient management and scalability of the IRS reference application. | -| Docker Container are used to provide a microservice oriented architecture | Deployment made on reliable production ready images. Avoiding repetitive, mundane configuration tasks for container orchestration. | -| Docker Compose is used to define and tune multi container application based on docker container technologies. | Docker container to develop independently of the underlying OS. | - -### Organizational Constraints - -| Name | Description | Comment | -| --- | --- | --- | -| CX-Services | Provide IRS as a C-X Shared Data Service. | | -| App Marketplace & API Connection | IRS Application has to be accessible for the user in the App Marketplace. | App Marketplace & API Connection | -| Federal Ministry for Economic Affairs and Energy (BMWi) promotion | The Federal Ministry for Economic Affairs and Energy (BMWi) promotes the project and provides funds for the project. | | -| Technology Readiness Level (TRL) for products developed within the CX Consortia | As IRS is a reference implementation, the Technology Readiness Level (TRL) must not be above TRL 8. | | -| Operational Readiness for Release 1 has to be fulfilled | Minimum requirements for release 1 has to be archived. Later on, the Operational Readiness for Release has to be fulfilled accordingly to the requirements of the C-X consortia. | | - -### Political constraints - -| Name | Description | -| --- | --- | -| Open Source | FOSS licenses approved by the eclipse foundation has to be used. It could represent the initial set that the CX community agrees on to regulate the content contribution under FOSS licenses. | -| Apache License 2.0 | Apache License 2.0 is one of the approved licenses which should be used to respect and guarantee Intellectual property (IP). | -| Java OpenJDK Version JDK >= 11 | IRS provides an open source application standard. OpenJDK is used, which is licensed under GNU General Public License (GNU GPL) Version 2. | - -### Development conventions - -| Name | Description | -| --- | --- | -| Architecture documentation | Architectural documentation of IRS reference application/implementation according to ARC42 template. | -| Coding guidelines | We follow the Google Java Style Guide. That is ensured by using the unified code formatter in the team and enforcing the style via Maven and Checkstyle / PMD. | -| Executable Bundle provided over the App Marketplace | As IRS is available in the App Marketplace, the application should be provided in one executable bundle. | -| Module structure | The entire build is driven from a Maven file, itself run from a single Dockerfile. | -| Code Analysis, Linting and Code Coverage | Consistent style increases readability and maintainability of the code base. Hence, we use analyzers to enforce consistency and style rules. We enforce the code style and rules in the CI to avoid merging code that does not comply with standards. | - -#### Code analysis, linting and code coverage - -| Tool | Scope | Rule | Configuration (via files / annotations) | -| --- | --- | --- | --- | -| Tidy | Enforce Maven POM Code Convention | Fail build on untidy pom.xml | N/A | -| SpotBugs | Static analysis to look for bugs in Java code. Successor of popular FindBugs tool | Fail build on violations | ci/spotbugs-excludes.xml @SuppressFBWarnings(...) | -| FindSecBugs | SpotBugs plugin adding security bugs coverage | Fail build on violations | N/A | -| Checkstyle | Enforce coding standard | Fail build on violations | ci/checkstyle-suppressions.xml @SuppressWarnings("checkstyle:XXX") | -| PMD | Source code analyzer to finds common programming flaws | Fail build on violations | ci/pmd-rules.xml @SuppressWarnings("PMD.XXX") | -| JaCoCo | Test coverage | Fail build on coverage < 80% | pom.xml @ExcludeFromCodeCoverageGeneratedReport | -| Veracode | - Scan source code for vulnerabilities (SAST) - Scan dependencies for known vulnerabilities (SCA) - Check used licenses (FOSS Licenses) | | | -| Dependabot | Automated dependency updates built into GitHub. Provided pull requests on dependency updates. | Any dependency update generates a pull request automatically. | .github/dependabot.yml | -| CodeQl | Discover vulnerabilities across a codebase. | | .github/workflows/codeql.yml | - -## System scope and context - -The IRS acts as a middleware between consumers and manufacturers. This section describes the environment of IRS. Who are its users, and with which other systems does it interact with. - -## Business context - -![arc42_000](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_000.png) - -### Consumer - -The IRS API is being consumed by the dismantler dashboard and other parties which are part of the Catena-X network. They need to provide valid credentials issued by the Catena-X IAM. Additionally, they must provide a base global asset identifier to retrieve information for as well as configuration details for the view on that information. - -### Catena-X network - -The IRS retrieves data from the Catena-X network (using the necessary infrastructure, see Technical Context), aggregates it and provides it back to the consumers. This connection is mandatory. If the Catena-X services are unavailable, the IRS cannot perform any work. - -As of now, the IRS uses its own IAM credentials to gather the required data. This might be changed to use the consumer credentials in the future. - -## Technical context - -![arc42_001](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_001.png) - -### Component overview - -#### IRS-API - -We provide a REST API that can be consumed by any system registered in the Catena-X Keycloak, e.g. the Dismantler Dashboard. The development of such a consumer service is not part of the IRS application. Each system that acts as a client to the Restful application IRS can be used instead, if it supports any REST call of the designed REST endpoints in the REST Controller of the IRS application. For communication, the transport protocol HTTP(S) should be established. - -In order to consume the Restful application IRS, the security aspect should be taken in consideration. IRS is a Spring Boot based application and is secured with the OpenID connector provider Keycloak and the OAuth2. This means for the consumers (users) that they need to authenticate themselves in order to be authorized to get access to the IRS. They generate a bearer token that they get from Keycloak and attach it to the HTTP header parameter Authorization. Certainly, both a consumer and the IRS should use the same configured Keycloak Realm. - -#### Registry API - -The IRS acts as a consumer of the component Asset Administration Shell Registry. The IRS contains a Restful client (REST template) that build a REST call to the mentioned Digital Twin Registry API based on its known URL (the AAS registry URL is configured in the IRS Restful API). The request contains the given "globalAssetId" by the consumer. Like described in the above section, the security aspect is required in order to achieve a REST call against the AAS Registry. As a response, the IRS gets the corresponding asset administration shell descriptor. The last one contains a list of submodel descriptors which can be filtered by the aspect type entered by the consumer. An aspect type like AssemblyPartRelationship, SerialPartTypization etc. And as mentioned above, the transport protocol HTTP(S) is used for the REST call communication. - -#### EDC API - -The integrated EDC client in the IRS is responsible for creating restful requests to the component EDC. The IRS application builds from the retrieved AAS Descriptor (see previous section) the corresponding submodel endpoint URLs, negotiates an EDC contract and sends via the submodel REST client requests to the EDC. The EDC responds with the corresponding submodel data. - -## Solution strategy - -### Introduction - -| Quality goal | Matching approaches in the solution | -| --- | --- | -| application reliability | - only data source is the Catena-X network, data is fetched directly from the data owner - IRS can be hosted decentralized by every participant by being an open source reference implementation | -| base security measures | - API protection using OAuth2.0/OIDC - automatic static and dynamic code analysis tools as part of the pipeline | -| cloud agnostic solution | - IRS is provided as a Docker image - Helm charts assist in deploying the application in any Kubernetes environment | -| multiple async job orchestration | - Separate job executor decouples data requests from the job status API - Multiple jobs with multiple transfer requests each can be handled in parallel, depending on the deployment resources | -| running reference application | - Working application can be used as reference by anyone due to open source publishing | - -### Technology - -The IRS is developed using Java and the Spring Boot framework. This choice was made due to the technical knowledge of the team and the widespread support of the framework. - -Hosting the application is done using Docker and Kubernetes, which is widely used and vendor-independent regarding the hosting provider (e.g. AWS, Google Cloud, Azure, ...). - -Inter-service communication is done using HTTP REST. This is the standard method in the Catena-X landscape and makes the IRS API easy to use for any third party client. - -For persistence, blob storage was chosen as the payloads retrieved for each job vary for every aspect and the format can be unknown to the application, as it’s just being tunneled through to the client. - -### Structure - -The IRS consists of 4 main components: - -1. the REST API to view and control Jobs -2. the asynchronous job processing engine -3. the job and payload persistence -4. the AAS connector - -The REST API classes are separated from the application logic and can be replaced by a different interface easily. The actual entrypoint into the application logic are the *Service classes. - -The job processing engine handles execution of the data requests for each job. It uses the AAS connector to retrieve the data and stores it into the persistence. The actual implementation of the persistence is decoupled from the logical representation and can be replaced easily as well. - -## Building block view - -## Whitebox overall system - -The interfaces show how the components interact with each other and which interfaces the IRS is providing. - -### Component diagram - -![arc42_002](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_002.png) - -### Component description - -| Components | Description | -| --- | --- | -| IRSApiConsumer | Proxy for any consumer of the IRS api. | -| IRS | The IRS consumes relationship information across the CX-Network and builds the graph view. Within this Documentation, the focus lies on the IRS | -| AAS Proxy | The AAS Proxy is a System, which enables the consumer to simplify the communication with other CX Partners. | -| EDC Consumer | The EDC Consumer Component is there to fulfill the GAIA-X and IDSA-data sovereignty principles. The EDC Consumer consists out of a control plane and a data plane. | -| EDC Provider | The EDC Provider Component connects with EDC Consumer component and forms the end point for the actual exchange of data. It handles automatic contract negotiation and the subsequent exchange of data assets for connected applications. | -| Submodel Server | The Submodel Server offers endpoints for requesting the Submodel aspects. | -| IAM/DAPS | DAPS as central Identity Provider | - -## Level 1 - -### Component diagram - -![arc42_003](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_003.png) - -### Component description - -| Components | Description | -| --- | --- | -| **IRS** | The IRS builds a digital representation of a product (digital twin) and the relationships of items the product consists of in a hierarchical structure. The result is an item graph in which each node represents a digital item of the product - this graph is called "Item Graph". | -| **IRS API** | The **IRS API** is the Interface over which the Data Consumer is communicating. | -| **IrsController** | The **IrsController** provides an REST Interface for retrieving IRS processed data and job details of the current item graph retrieval process. | -| **IrsItemGraphQueryService** | The **IrsItemGraphQueryService** implements the REST Interface of the IrsController. | -| **JobOrchestrator** | The **JobOrchestrator** is a component which manages (start, end, cancel, resume) the jobs which execute the item graph retrieval process. | -| **RecursiveJobHandler** | The **RecursiveJobHandler** handles the job execution recursively until a given abort criteria is reached or the complete item graph is build. | -| **TransferProcessManager** | The TransferProcessManager handles the outgoing requests to the AASProxy. 1. Initiation of the job and preparation of the stream of **DataRequests** 2. **RecursiveJobHandler** requesting for AAS via the Digital Twin registry. 3. Analyzing the structure of the AAS response by collecting the AssemblyPartRelationship Aspects 4. Requesting for SubmodelEndpoints for given AssemblyPartRelationship children 5. Recursively iteration over step 2-4 until an abort criterion is reached. 6. Assembles the complete item graph | -| **BlobStore** | The BlobStore is the database where the relationships and tombstones are stored for a requested item. | -| **JobStore** | The JobStore is the database where the jobs with the information about the requested item are stored. | -| **AASProxy** | The AASProxy is the interface to the EDC Network. It provides an interface for the Asset Administration Shells and for the Submodels. | - -## Level 2 - -### IRS controller - -The IRS REST controller to provide a RESTful web service. - -#### Component diagram - -![arc42_004](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_004.png) - -#### Component description - -| Components | Description | -| --- | --- | -| IrsController | Application REST controller. | -| IrsItemGraphQueryService | Service for retrieving item graph. | -| JobOrchestrator | Orchestrator service for recursive MultiTransferJobs that potentially comprise multiple transfers. | -| JobStore | Spring configuration for job-related beans. | -| BlobstorePersistence | Interface for storing data blobs. | - -### RecursiveJobHandler - -The **RecursiveJobHandler** component provide the logic to build jobs with recursive logic to retrieve items over the complete C-X network and assembles the partial results into a single item graph result. - -#### Component diagram - -![arc42_005](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_005.png) - -#### Component description - -| Components | Description | -| --- | --- | -| AASRecursiveJobHandler | Recursive job handler for AAS data | -| TreeRecursiveLogic | Retrieves item graphs from potentially multiple calls to IRS API behind multiple EDC Providers, and assembles their outputs into one overall item graph. | -| ItemTreesAssembler | Assembles multiple partial item graphs into one overall item graph. | -| BlobPersistence | Interface for storing data blobs. | - -### TransferProcessManagment - -The TransferProcessManager creates executions and provides them to the executor service. Each execution contains HTTP requests to the asset administration shell registry and to the submodel interface. - -#### Component diagram - -![arc42_006](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_006.png) - -#### Component description - -| Components | Description | -| --- | --- | -| TransferProcessManager | The TransferProcessManager manages the requests to the EDC and DigitalTwinRegistry. | -| DigitalTwinRegistryFacade | The DigitalTwinRegistryFacade calls the DigitalTwinRegistry to retrieve data form the AAS registry and transforms the response to internal data models. | -| SubmodelFacade | The SubmodelFacade calls the EDC to retrieve data from the submodel server and transforms the response to internal data models. | -| BlobStore | The BlobStore is the database where the relationships and tombstones are stored for a requested item. | -| DigitalTwinRegistry | The DigitalTwinRegistry is the central database of registered assets. | -| ExecutorService | The ExecutorService enables the simultaneous execution of requests of transfer processes. | - -## IRS API - -### References - -The Swagger documentation can be found in the local deployment of the reference application. More information can be found in the GitHub repository: - -Since we cannot rely on synchronous responses regarding the requests of submodel endpoints, we designed the IRS in a way that it will handle the job management of requesting all needed endpoints in order to build a BoM tree. - -### IRS interaction diagram - -![arc42_007](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_007.png) - -## Runtime view - -This section covers the main processes of the IRS and explains how data is transfered and processed when a job is executed. - -## Overall - -This section describes the overall flow of the IRS - -![arc42_008](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_008.png) - -### Submodel - -This section describes how the IRS fetches submodel payload. - -![arc42_009](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_009.png) - -### Job orchestration flow - -This section describes the job orchestration in IRS. - -![arc42_010](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_010.png) - -## Scenario 1: Create job - -This section describes what happens when user creates a new job. - -![arc42_011](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_011.png) - -### Overview - -If a job is registered via the IRS API, it will be persisted (with its parameters) in the JobStore, where it can be retrieved by further calls and processes. -Then, the starting item ID is extracted, and a new transfer process is handed to the ExecutorService, which will process it asynchronously (see Scenario 2: Job Execution). - -In the meantime, the JobOrchestrator returns a response to the API caller, which contains the UUID of the new job. -This UUID can then be used by the caller to retrieve information about the job via the API. -The input provided by the caller determines how the job will operate (starting point, recursion depth, aspect filter, ...). - -## Scenario 2: Job execution - -This section describes how a job is asynchronously executed inside the IRS. - -![arc42_012](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_012.png) - -### Overview - -After a job has been created (see Scenario 1: Create Job), the first transfer containing the root item ID is passed to the ExecutorService. The transfer is then started asynchronously and retrieves the necessary information from the Catena-X network, first by fetching the AAS information from the DigitalTwin registry and then calling the SubmodelProviders for the submodel payload. - -At least the aspect AssemblyPartRelationship is required for the tree to be built. If the customer that started the job provided more aspects to be fetched, they will be retrieved here too. -The result of each transfer is stored in the BlobStore. - -After the transfer process has finished, any subsequent child IDs will be extracted and new transfer processes will be scheduled for those via the ExecutorService. This cycle repeats until all leafs were reached, the specified max depth has been reached, or the job was canceled externally. - -As soon as all transfers are finished, the results will be combined and stored in the BlobStore again. The job itself will be marked as completed. - -## Scenario 3: Request for JobResponse - -![arc42_013](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_013.png) - -### Overview - -When a user requests job details, the IRS looks up the jobId in the persistent job store. If the job exists, it will proceed to fetch the job details and prepare a response object. -Only if the job is in state "COMPLETED" or if the caller has set the parameter "includePartialResults" to true, the IRS will fetch the payload data for the job (relationships, AAS shells and submodels, if applicable) and attach it to the response object. - -This will then be passed to the caller. - -## Scenario 4: Cancel job execution - -![arc42_014](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_014.png) - -### Overview - -When a user wants to cancel a job execution, the IRS will lookup that job in the persistent job store and transition it to the CANCELED state, if it exists. If a job is canceled, no further requests to the Catena-X network will be performed. - -Afterwards, the IRS will return the updated job details of the canceled job to the user. - -## Deployment view - -The deployment view shows the IRS application on ArgoCD, which is a continuous delivery tool for Kubernetes. Kubernetes manifests are specified using Helm charts. Helm is a package manager for Kubernetes. IRS is developed in a cloud-agnostic manner, so the application could be installed in any cloud infrastructure (on-premises, hybrid, or public cloud infrastructure). - -![arc42_015](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_015.png) - -### Operator - -Manual preparation is required to initially set up the ArgoCD apps and the credentials in the HashiCorp Vault. This is done by the IRS system operator. - -### ArgoCD - -Argo CD is a declarative, GitOps continuous delivery tool for Kubernetes. See - -### Vault - -HashiCorp Vault stores credentials, which are picked up by ArgoCD to deploy them to the application. - -**⚠️ WARNING**\ -Every secret information needed at runtime must be stored here and must never be part of the IRS Helm charts - -### GitHub - -GitHub contains the application source code as well as the Helm charts used for deployment. -The IRS Helm charts can be found here: - -### GitHub Container Registry (GHCR) - -When the IRS is built by GitHub Action workflows, the final image is pushed to the GHCR, where it can be picked up for deployment. - -### Kubernetes - -The kubernetes cluster manages the underlying hardware that is used to run the applications defined in the Helm charts. - -### Local deployment - -For information on how to run the application locally, please check the README documentation in GitHub: - -### View Levels - -## Level 0 - Cluster overview - -### Isolated environment - -The isolated environment contains the IRS as well as all surrounding services. - -![arc42_016](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_016.png) - -### Development environment - -The development environment contains the IRS as well as the essential surrounding services, excluding the external IAM. - -![arc42_017](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_017.png) - -### Integrated environment - -The integrated environment contains the IRS and is integrated with the rest of the Catena-X network. - -![arc42_018](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_018.png) - -## Level 1 - IRS application - -This section focuses only on the IRS itself, detached from its neighbors. It shows the resources deployed in Kubernetes for the IRS. - -![arc42_019](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_019.png) - -### Pod - -This is the actual IRS Docker image which runs as a container. The ports are only available internally and can be opened up with the Service. - -### Secrets - -The secret information (e.g. connection credentials) is stored here and provided to the Pod at runtime. - -### Service - -The service resource opens up selected ports of the Pod so that other applications in the same cluster can access it or to be used by the Ingress. - -### Ingress - -The ingress uses a reverse proxy to provide specified Service ports to the internet under a specified URL. This make the IRS API publicly available. - -## Cross-cutting concepts - -## Domain concepts - -### Domain entity model - -![arc42_020](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_020.png) - -### Domain model - -![arc42_021](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_021.png) - -### API Model - -For detailed information about the API model, please refer to the [API specification](https://eclipse-tractusx.github.io/item-relationship-service/docs/api-specification/api-specification.html). - -### JobStatus - -A job can be in one of the following states: - -| State | Description | -| --- | --- | -| UNSAVED | The job was created, but not yet stored by the system. | -| INITIAL | The job was stored by the system and is now queued for processing. | -| IN_PROGRESS | The job is currently being processed. | -| TRANSFERS_FINISHED | All transfers for the job have been finished, and it is now being finalized. | -| COMPLETED | The job has completed. See the job response for details on the data. | -| ERROR | The job could not be processed correctly by the IRS due to a technical problem. | - -![arc42_022](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_022.png) - -### Job Store Datamodel - -![arc42_023](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_023.png) - -### Job Response Datamodel - -![arc42_024](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_024.png) - -```json -{ - "job": { - "jobID": "e5347c88-a921-11ec-b909-0242ac120002", - "globalAssetId": "6c311d29-5753-46d4-b32c-19b918ea93b0", - "jobStatus": "Finished", - "createdOn": "2022-02-03T14:48:54.709Z", - "startedOn" : "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "jobFinished": "2022-02-03T14:48:54.709Z", - "requestURL": "https://api.server.test/api/../", - "owner": "", - "summary": { - "asyncFetchedItems": { - "queued": 0, - "running": 0, - "complete": 0, - "failed": 0 - }}, - "queryParameter": { - "bomLifecycle" : "asBuilt", - "aspect" : ["SerialPartTypization", "Contact"], - "depth": 4, - "direction": "downward" - }, - "exception": { - "exception": "IrsTimeoutException", - "errorDetail": "Timeout while requesting Digital Registry.", - "exceptionDate" : "2022-02-03T14:48:54.709Z", - "statusCode" : "404" - } - }, - "relationships": [ - { - "catenaXId": "d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447", - "childItem": { - "quantity": { - "quantityNumber": 1, - "measurementUnit": { - "datatypeURI": "urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece", - "lexicalValue": "piece" - } - }, - "lifecycleContext": "asBuilt", - "assembledOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "a45a2246-f6e1-42da-b47d-5c3b58ed62e9" - } - } - ], - "shells": [ - { - "description": [ - { - "language": "en", - "text": "The shell for a vehicle" - } - ], - "globalAssetId": { - "value": [ - "a45a2246-f6e1-42da-b47d-5c3b58ed62e9" - ] - }, - "idShort": "future concept x", - "identification": "882fc530-b69b-4707-95f6-5dbc5e9baaa8", - "specificAssetIds": [ - { - "key": "engineserialid", - "value": "12309481209312" - } - ], - "submodelDescriptors": [ - { - "description": [ - { - "language": "en", - "text": "Provides base vehicle information" - } - ], - "idShort": "vehicle base details", - "identification": "4a738a24-b7d8-4989-9cd6-387772f40565", - "semanticId": { - "value": [ - "urn:bamm:com.catenax.vehicle:0.1.1" - ] - }, - "endpoints": [ - { - "interface": "HTTP", - "protocolInformation": { - "endpointAddress": "https://catena-x.net/vehicle/basedetails/", - "endpointProtocol": "HTTPS", - "endpointProtocolVersion": "1.0" - } - } - ] - }, - { - "description": [ - { - "language": "en", - "text": "Provides base vehicle information" - } - ], - "idShort": "vehicle part details", - "identification": "dae4d249-6d66-4818-b576-bf52f3b9ae90", - "semanticId": { - "value": [ - "urn:bamm:com.catenax.vehicle:0.1.1#PartDetails" - ] - }, - "endpoints": [ - { - "interface": "HTTP", - "protocolInformation": { - "endpointAddress": "https://catena-x.net/vehicle/partdetails/", - "endpointProtocol": "HTTPS", - "endpointProtocolVersion": "1.0" - } - } - ] - } - ] - } - ] - } -@endjson -``` - -## Safety and security concepts - -### Authentication / Authorization - -#### IRS API - -The IRS is secured using OAuth2.0 / Open ID Connect. Every request to the IRS API requires a valid bearer token. -JWT token should also contain two fields: - -* 'view irs' role inside resource_access claim, -* bpn claim which is equal to the configuration value from 'API_ALLOWED_BPN' property - -#### IRS as DTR client - -The IRS acts as a client for the Digital Twin Registry (DTR), which is also secured using OAuth2.0 / Open ID Connect. The IRS uses client credentials to authenticate requests to the DTR. Due to this, the IRS account needs to have access to every item in the DTR, unrelated to the permissions of the account calling the IRS API. - -#### IRS as EDC client - -The IRS accesses the Catena-X network via the EDC consumer connector. This component requires authentication via a DAPS certificate, which was provided to the IRS via the network authority. - -The DAPS certificate identifies the IRS and is used to acquire access permissions for the data transferred via EDC. - -### Credentials - -Credentials must never be stored in Git! - -## Architecture and design patterns - -### Dependency inversion - -For the IRS, we utilize the dependency inversion mechanisms provided by Spring Boot as much as possible. - -The principle says: - -High-level modules should not import anything from low-level modules. Both should depend on abstractions (e.g., interfaces). -Abstractions should not depend on details. Details (concrete implementations) should depend on abstractions. - -Adhering to this, we define clear interfaces between the different domains (e.g. job orchestration and AAS communication) in the IRS and let dependencies be injected by the framework. This improves testability of the classes as well. - -### Hexagonal architecture - -The hexagonal architecture divides a system into several loosely-coupled interchangeable components, such as the application core, the database, the user interface, test scripts and interfaces with other systems. This approach is an alternative to the traditional layered architecture. - -For the IRS, this means decoupling the application logic from components like the BLOB store, the REST API controllers or the AAS client connection. With an interface between the parts (so-called port), it is easy to switch to other implementations, e.g. if you want to change the persistence implementation. No changes to the application logic will be necessary. - -![arc42_025](https://eclipse-tractusx.github.io/item-relationship-service/docs/assets/arc42/arc42_025.png) - -## "Under-the-hood" concepts - -### Persistency - -The IRS stores two types of data in a persistent way: - -* Job metadata -* Job payloads, e.g. AAS shells or submodel data - -All of this is data is stored in an object store. The currently used implementation is Minio (Amazon S3 compatible). -This reduces the complexity in storing and retrieving data. There also is no predefined model for the data, every document can be stored as it is. -The downside of this approach is lack of query functionality, as we can only search through the keys of the entries but not based on the value data. -In the future, another approach or an additional way to to index the data might be required. - -To let the data survive system restarts, Minio needs to use a persistent volume for the data storage. A default configuration for this is provided in the Helm charts. - -### Transaction handling - -There currently is no transaction management in the IRS. - -### Session handling - -There is no session handling in the IRS, access is solely based on bearer tokens, the API is stateless. - -### Communication and integration - -All interfaces to other systems are using RESTful calls over HTTP(S). Where central authentication is required, a common Keycloak instance is used. - -For outgoing calls, the Spring RestTemplate mechanism is used and separate RestTemplates are created for the different ways of authentication. - -For incoming calls, we utilize the Spring REST Controller mechanism, annotating the interfaces accordingly and also documenting the endpoints using OpenAPI annotations. - -### Exception and error handling - -There are two types of potential errors in the IRS: - -#### Technical errors - -Technical errors occur when there is a problem with the application itself, its configuration or directly connected infrastructure, e.g. the Minio persistence. Usually, the application cannot solve these problems by itself and requires some external support (manual work or automated recovery mechanisms, e.g. Kubernetes liveness probes). - -These errors are printed mainly to the application log and are relevant for the healthchecks. - -#### Functional errors - -Functional errors occur when there is a problem with the data that is being processed or external systems are unavailable and data cannot be sent / fetched as required for the process. While the system might not be able to provide the required function at that moment, it may work with a different dataset or as soon as the external systems recover. - -These errors are reported in the Job response and do not directly affect application health. - -#### Rules for exception handling - -##### Throw or log, don't do both - -When catching an exception, either log the exception and handle the problem or rethrow it, so it can be handled at a higher level of the code. By doing both, an exception might be written to the log multiple times, which can be confusing. - -##### Write own base exceptions for (internal) interfaces - -By defining a common (checked) base exception for an interface, the caller is forced to handle potential errors, but can keep the logic simple. On the other hand, you still have the possibility to derive various, meaningful exceptions for different error cases, which can then be thrown via the API. - -Of course, when using only RuntimeExceptions, this is not necessary - but those can be overlooked quite easily, so be careful there. - -##### Central fallback exception handler - -There will always be some exception that cannot be handled inside of the code correctly - or it may just have been unforeseen. A central fallback exception handler is required so all problems are visible in the log and the API always returns meaningful responses. In some cases, this is as simple as a HTTP 500. - -##### Dont expose too much exception details over API - -It’s good to inform the user, why their request did not work, but only if they can do something about it (HTTP 4xx). So in case of application problems, you should not expose details of the problem to the caller. This way, we avoid opening potential attack vectors. - -### Parallelization and threading - -The heart of the IRS is the parallel execution of planned jobs. As almost each job requires multiple calls to various endpoints, those are done in parallel as well to reduce the total execution time for each job. - -Tasks execution is orchestrated by the JobOrchestrator class. It utilizes a cental ExecutorService, which manages the number of threads and schedules new Task as they come in. - -### Plausibility checks and validation - -Data validation happens at two points: - -* IRS API: the data sent by the client is validated to match the model defined in the IRS. If the validation fails, the IRS sends a HTTP 400 response and indicates the problem to the caller. -* Submodel payload: each time a submodel payload is requested from via EDC, the data is validated against the model defined in the SemanticHub for the matching aspect type. - -### Caching - -The IRS caches data provided externally to avoid unnecessary requests and reduce execution time. - -Caching is implemented for the following services: - -#### BPDM - -Whenever a BPN is resolved via BPDM, the partner name is cached on IRS side, as this data does not change. - -#### Semantics Hub - -Whenever a semantic model schema is requested from the Semantic Hub, it is stored locally until the cache is evicted (configurable). The IRS can preload configured schema models on startup to reduce on demand call times. - -Additionally, models can be deployed with the system as a backup to the real Semantic Hub service. - -## Development concepts - -### Build, test, deploy - -The IRS is built using Maven and utilizes all the standard concepts of it. Test execution is part of the build process and a minimum test coverage of 80% is enforced. - -The project setup contains a multi-module Maven build. Commonly used classes (like the IRS data model) should be extracted into a separate submodule and reused across the project. However, this is not a "one-size-fits-all" solution. New submodules should be created with care and require a review by the team. - -The Maven build alone only leads up to the JAR artifact of the IRS. Do create Docker images, the Docker build feature is used. This copies all resources into a builder image, builds the software and creates a final Docker image at the end that can then be deployed. - -Although the Docker image can be deployed in various ways, the standard solution are the provided Helm charts, which describe the required components as well. - -### Code generation - -There are two methods of code generation in the IRS: - -#### Lombok - -The Lombok library is heavily used to generate boilerplate code (like Constructors, Getters, Setters, Builders...). -This way, code can be written faster and this boilerplate code is excluded from test coverage, which keeps the test base lean. - -#### Swagger / OpenAPI - -The API uses OpenAPI annotations to describe the endpoints with all necessary information. The annotations are then used to automatically generate the OpenAPI specification file, which can be viewed in the Swagger UI that is deployed with the application. - -The generated OpenAPI specification file is automatically compared to a fixed, stored version of it to avoid unwanted changes of the API. - -### Migration - -There currently is no data migration mechanism for the IRS. -In case the model of the persisted data (Jobs) changes, data is dropped and Jobs will need to be recreated. - -### Configurability - -The IRS utilizes the configuration mechanism provided by Spring Boot. Configuration properties can be defined in the file `src/main/resources/application.yml` - -For local testing purposes, there is an additional configuration file called `application-local.yml`. Values can be overriden there to support the local dev environment. - -Other profiles should be avoided. Instead, any value that might need to change in a runtime environment must be overridable using environment variables. The operator must have total control over the configuration of the IRS. - -## Operational concepts - -### Administration - -#### Configuration - -The IRS can be configured using two mechanisms: - -##### application.yml - -If you build the IRS yourself, you can modify the application.yml config that is shipped with the IRS. This file contains all possible config entries for the application. -Once the Docker image has been built, these values can only be overwritten using the Spring external config mechanism (see e.g. by mounting a config file in the right path or using environment variables. - -##### Helm Chart - -The most relevant config properties are exposed as environment variables and must be set in the Helm chart so the application can run at all. Check the IRS Helm chart in Git for all available variables. - -### Disaster-Recovery - -#### Ephemeral components - -All components in the IRS deployment not listed in the persistent components section below are considered ephemeral and are easily replaced in a disaster scenario. -All deployment components are described using Helm charts, which can be used to restore the deployment with the Docker images. -Should the Docker images go missing, they can be restored by executing the build pipelines for the corresponding version tag of the component. - -#### Persistent components - -These components utilize data persistence, which needs to be backed up separately by the operator. - -* **Minio persistent volume**: Contains the stored Job information. In case of data loss, Jobs can be started again to retrieve the data from the network. -* **Prometheus persistent volume**: Contains the monitoring data of the IRS. In case of data loss, no analysis can be done for past timeframes. -* **Vault secrets**: In case of data loss, the credentials stored in the Vault need to be recreated manually. See the deployment view for an overview. - -### Scaling - -If the number of consumers raises, the IRS can be scaled up by using more resources for the Deployment Pod. Those resources can be used to utilize more parallel threads to handle Job execution. - -### Clustering - -The IRS can run in clustered mode, as each running job is only present in one pod at a time. -Note: as soon as a resume feature is implemented, this needs to be addressed here. - -### Logging - -Logs are being written directly to stdout and are picked up by the cluster management. - -### Monitoring - -The application can be monitored using Prometheus and Grafana. Both systems are defined in the Helm charts with a default setup. -A number of Grafana dashboards are deployed automatically, to display data about: - -* Pod / JVM resources -* API metrics -* Functional information about IRS Jobs - -## Quality requirements - -The quality scenarios in this section depict the fundamental quality goals as well as other required quality properties. They allow the evaluation of decision alternatives. - -* **Quality attribute**: A characteristic of software, or a generic term applying to quality factors, quality subfactors, or metric values. -* **Quality factor**: A management-oriented attribute of software that contributes to its quality. -* **Quality subfactor**: A decomposition of a quality factor or quality subfactor to its technical components. -* **Metric value**: A metric output or an element that is from the range of a metric. -* **Software quality metric**: A function whose inputs are software data and whose output is a single numerical value that can be interpreted as the degree to which software possesses a given attribute that affects its quality. - -**Source**: IEEE standard 1061 "Standard for a Software Quality Metrics Methodology" - -### List of requirements - -This section will be filled soon. - -## Glossary - -| Term | Description | -| --- | --- | -| AAS | Asset Administration Shell (Industry 4.0) | -| Aspect servers (submodel endpoints) | Companies participating in the interorganizational data exchange provides their data over aspect servers. The so called "submodel-descriptors" in the AAS shells are pointing to these AspectServers which provide the data-assets of the participating these companies in Catena-X. | -| BoM | Bill of Materials | -| Edge | see Traversal Aspect | -| IRS | Item Relationship Service | -| Item Graph | The result returned via the IRS. This corresponds to a tree structure in which each node represents a part of a virtual asset. | -| MTPDC | Formerly known Service Name: Multi Tier Parts Data Chain | -| PRS | Formerly known Service Name: Parts Relationship Name | -| Traversal Aspect | aka Edge: Aspect which the IRS uses for traversal through the data chain. Identified by a parent-child or a child-parent relationship. Samples: SingleLevelBomAsPlanned, AssemblyPartRelationship and SingleLevelUsageAsBuilt | diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/cancel-batch-order.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/cancel-batch-order.api.mdx deleted file mode 100644 index 690c82f726f..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/cancel-batch-order.api.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: cancel-batch-order -title: "Cancel a batch order for a given orderId." -description: "Cancel a batch order for a given orderId." -sidebar_label: "Cancel a batch order for a given orderId." -hide_title: true -hide_table_of_contents: true -api: {"description":"Cancel a batch order for a given orderId.","operationId":"cancelBatchOrder","parameters":[{"description":"Id of the order.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"orderId","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"batchChecksum":1,"batches":[{"batchId":"f253718e-a270-4367-901b-9d50d9bd8462","batchNumber":1,"batchProcessingState":"PARTIAL","batchUrl":"https://../irs/orders/f253718e-a270-4367-901b-9d50d9bd8462/batches/f253718e-a270-4367-901b-9d50d9bd8462","jobsInBatchChecksum":1}],"orderId":"f253718e-a270-4367-901b-9d50d9bd8462","state":"COMPLETED"}}},"schema":{"type":"object","additionalProperties":false,"description":"BatchOrderAck Payload Response.","properties":{"batchChecksum":{"type":"integer","format":"int32","description":"Expected number of batches in order."},"batches":{"type":"array","description":"Array of batches.","items":{"type":"object","additionalProperties":false,"description":"Batch model.","properties":{"batchId":{"type":"string","format":"uuid","description":"Id of the batch.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"batchNumber":{"type":"integer","format":"int32","description":"Sequential number begins with first (1.) batch."},"batchProcessingState":{"type":"string","description":"The state of the batch.","enum":["INITIALIZED","COMPLETED","PROCESSING","PARTIAL","ERROR"]},"batchTotal":{"type":"integer","format":"int32","description":"The total number of batches."},"completedOn":{"type":"string","format":"date-time"},"jobs":{"type":"array","description":"Array of jobs.","items":{"type":"object","additionalProperties":false,"properties":{"completedOn":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]}}},"maxItems":2147483647},"jobsInBatchChecksum":{"type":"integer","format":"int32","description":"Expected number of jobs in batch."},"orderId":{"type":"string","format":"uuid","description":"Id of the order.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"startedOn":{"type":"string","format":"date-time"},"totalJobs":{"type":"integer","format":"int32","description":"Total amount of jobs inside the order."}}},"maxItems":2147483647},"orderId":{"type":"string","format":"uuid","description":"Id of the order.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"state":{"type":"string","description":"The state of the order.","enum":["INITIALIZED","COMPLETED","PROCESSING","PARTIAL","ERROR"]}}}}},"description":"Cancel a batch order for a given orderId."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return Batch Order failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Batch Order with the requested orderId not found."}},"security":[{"oAuth2":["profile email"]}],"tags":["Item Relationship Service"],"method":"put","path":"/irs/orders/{orderId}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Cancel a batch order for a given orderId.","description":{"content":"Cancel a batch order for a given orderId.","type":"text/plain"},"url":{"path":["irs","orders",":orderId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the order.","type":"text/plain"},"type":"any","value":"","key":"orderId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Cancel a batch order for a given orderId. - - - -Cancel a batch order for a given orderId. - -
Path Parameters
- -Cancel a batch order for a given orderId. - -
Schema
    batches object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Array of batches. - -
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    jobs object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Array of jobs. - -
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
- -Return Batch Order failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- -Batch Order with the requested orderId not found. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/cancel-job-by-job-id.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/cancel-job-by-job-id.api.mdx deleted file mode 100644 index 61208afcc46..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/cancel-job-by-job-id.api.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: cancel-job-by-job-id -title: "Cancel job for requested jobId." -description: "Cancel job for requested jobId." -sidebar_label: "Cancel job for requested jobId." -hide_title: true -hide_table_of_contents: true -api: {"description":"Cancel job for requested jobId.","operationId":"cancelJobByJobId","parameters":[{"description":"Id of the job.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"completedOn":"2022-02-03T14:48:54.709Z","globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","id":"6c311d29-5753-46d4-b32c-19b918ea93b0","lastModifiedOn":"2022-02-03T14:48:54.709Z","startedOn":"2022-02-03T14:48:54.709Z","state":"CANCELED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Executable unit with meta information and item graph result.","properties":{"completedOn":{"type":"string","format":"date-time"},"createdOn":{"type":"string","format":"date-time"},"exception":{"type":"object","additionalProperties":false,"description":"Job error details.","properties":{"errorDetail":{"type":"string","description":"Detailed exception information.","maxLength":4000},"exception":{"type":"string","description":"Exception name.","maxLength":100},"exceptionDate":{"type":"string","format":"date-time","description":"Datetime error occurs."}}},"globalAssetId":{"type":"string","description":"Part global unique id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"id":{"type":"string","format":"uuid","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"lastModifiedOn":{"type":"string","format":"date-time"},"owner":{"type":"string","description":"The IRS api consumer."},"parameter":{"type":"object","additionalProperties":false,"description":"Job parameter of job processing.","properties":{"aspects":{"type":"string"},"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"callbackUrl":{"type":"string"},"collectAspects":{"type":"boolean"},"depth":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0},"direction":{"type":"string","description":"Item graph traversal direction.","enum":["upward","downward"]},"lookupBPNs":{"type":"boolean"}}},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]},"summary":{"type":"object","additionalProperties":false,"description":"Summary of the job with statistics of the job processing.","properties":{"asyncFetchedItems":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}},"bpnLookups":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}}}}},"required":["globalAssetId","id","state"]}}},"description":"Job with requested jobId canceled."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Cancel job failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Job for requested jobId not found."}},"security":[{"oAuth2":["profile email"]}],"tags":["Item Relationship Service"],"method":"put","path":"/irs/jobs/{id}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Cancel job for requested jobId.","description":{"content":"Cancel job for requested jobId.","type":"text/plain"},"url":{"path":["irs","jobs",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the job.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Cancel job for requested jobId. - - - -Cancel job for requested jobId. - -
Path Parameters
- -Job with requested jobId canceled. - -
Schema
    exception object
    - -Job error details. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>= 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    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
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-all-aspect-models.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-all-aspect-models.api.mdx deleted file mode 100644 index ef29eea466c..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-all-aspect-models.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-all-aspect-models -title: "Get all available aspect models from semantic hub or local models." -description: "Get all available aspect models from semantic hub or local models." -sidebar_label: "Get all available aspect models from semantic hub or local models." -hide_title: true -hide_table_of_contents: true -api: {"description":"Get all available aspect models from semantic hub or local models.","operationId":"getAllAspectModels","responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"lastUpdated":"2023-02-13T08:18:11.990659500Z","models":[{"urn":"urn:bamm:io.catenax.assembly_part_relationship:1.1.1#AssemblyPartRelationship","name":"AssemblyPartRelationship","status":"RELEASED","type":"BAMM","version":"1.1.1"},{"urn":"urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization","name":"SerialPartTypization","status":"RELEASED","type":"BAMM","version":"1.1.0"}]}}},"schema":{"type":"object","additionalProperties":false,"properties":{"lastUpdated":{"type":"string"},"models":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"urn":{"type":"string"},"version":{"type":"string"}}}}}}}},"description":"Returns all available aspect models."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":["profile email"]}],"tags":["Aspect Models"],"method":"get","path":"/irs/aspectmodels","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Get all available aspect models from semantic hub or local models.","description":{"content":"Get all available aspect models from semantic hub or local models.","type":"text/plain"},"url":{"path":["irs","aspectmodels"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get all available aspect models from semantic hub or local models. - - - -Get all available aspect models from semantic hub or local models. - -
- -Returns all available aspect models. - -
Schema
    models object[]
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-batch-order.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-batch-order.api.mdx deleted file mode 100644 index dce10243886..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-batch-order.api.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: get-batch-order -title: "Get a batch order for a given orderId." -description: "Get a batch order for a given orderId." -sidebar_label: "Get a batch order for a given orderId." -hide_title: true -hide_table_of_contents: true -api: {"description":"Get a batch order for a given orderId.","operationId":"getBatchOrder","parameters":[{"description":"Id of the order.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"orderId","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"batchChecksum":1,"batches":[{"batchId":"f253718e-a270-4367-901b-9d50d9bd8462","batchNumber":1,"batchProcessingState":"PARTIAL","batchUrl":"https://../irs/orders/f253718e-a270-4367-901b-9d50d9bd8462/batches/f253718e-a270-4367-901b-9d50d9bd8462","jobsInBatchChecksum":1}],"orderId":"f253718e-a270-4367-901b-9d50d9bd8462","state":"COMPLETED"}}},"schema":{"type":"object","additionalProperties":false,"description":"BatchOrderAck Payload Response.","properties":{"batchChecksum":{"type":"integer","format":"int32","description":"Expected number of batches in order."},"batches":{"type":"array","description":"Array of batches.","items":{"type":"object","additionalProperties":false,"description":"Batch model.","properties":{"batchId":{"type":"string","format":"uuid","description":"Id of the batch.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"batchNumber":{"type":"integer","format":"int32","description":"Sequential number begins with first (1.) batch."},"batchProcessingState":{"type":"string","description":"The state of the batch.","enum":["INITIALIZED","COMPLETED","PROCESSING","PARTIAL","ERROR"]},"batchTotal":{"type":"integer","format":"int32","description":"The total number of batches."},"completedOn":{"type":"string","format":"date-time"},"jobs":{"type":"array","description":"Array of jobs.","items":{"type":"object","additionalProperties":false,"properties":{"completedOn":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]}}},"maxItems":2147483647},"jobsInBatchChecksum":{"type":"integer","format":"int32","description":"Expected number of jobs in batch."},"orderId":{"type":"string","format":"uuid","description":"Id of the order.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"startedOn":{"type":"string","format":"date-time"},"totalJobs":{"type":"integer","format":"int32","description":"Total amount of jobs inside the order."}}},"maxItems":2147483647},"orderId":{"type":"string","format":"uuid","description":"Id of the order.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"state":{"type":"string","description":"The state of the order.","enum":["INITIALIZED","COMPLETED","PROCESSING","PARTIAL","ERROR"]}}}}},"description":"Get a batch order for a given orderId."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return Batch Order failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Batch Order with the requested orderId not found."}},"security":[{"oAuth2":["profile email"]}],"tags":["Item Relationship Service"],"method":"get","path":"/irs/orders/{orderId}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Get a batch order for a given orderId.","description":{"content":"Get a batch order for a given orderId.","type":"text/plain"},"url":{"path":["irs","orders",":orderId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the order.","type":"text/plain"},"type":"any","value":"","key":"orderId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get a batch order for a given orderId. - - - -Get a batch order for a given orderId. - -
Path Parameters
- -Get a batch order for a given orderId. - -
Schema
    batches object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Array of batches. - -
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    jobs object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Array of jobs. - -
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
- -Return Batch Order failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- -Batch Order with the requested orderId not found. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-batch.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-batch.api.mdx deleted file mode 100644 index 0b56af79336..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-batch.api.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: get-batch -title: "Get a batch with a given batchId for a given orderId." -description: "Get a batch with a given batchId for a given orderId." -sidebar_label: "Get a batch with a given batchId for a given orderId." -hide_title: true -hide_table_of_contents: true -api: {"description":"Get a batch with a given batchId for a given orderId.","operationId":"getBatch","parameters":[{"description":"Id of the order.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"orderId","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}},{"description":"Id of the batch.","example":"4bce40b8-64c7-41bf-9ca3-e9432c7fef98","in":"path","name":"batchId","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"batchId":"f253718e-a270-4367-901b-9d50d9bd8462","batchNumber":1,"batchProcessingState":"COMPLETED","batchTotal":1,"completedOn":"2022-02-03T14:48:54.709Z","jobs":[{"completedOn":"2022-02-03T14:48:54.709Z","id":"6c311d29-5753-46d4-b32c-19b918ea93b0","startedOn":"2022-02-03T14:48:54.709Z","state":"COMPLETED"}],"jobsInBatchChecksum":1,"orderId":"f253718e-a270-4367-901b-9d50d9bd8462","startedOn":"2022-02-03T14:48:54.709Z","totalJobs":1}}},"schema":{"type":"object","additionalProperties":false,"description":"Batch model.","properties":{"batchId":{"type":"string","format":"uuid","description":"Id of the batch.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"batchNumber":{"type":"integer","format":"int32","description":"Sequential number begins with first (1.) batch."},"batchProcessingState":{"type":"string","description":"The state of the batch.","enum":["INITIALIZED","COMPLETED","PROCESSING","PARTIAL","ERROR"]},"batchTotal":{"type":"integer","format":"int32","description":"The total number of batches."},"completedOn":{"type":"string","format":"date-time"},"jobs":{"type":"array","description":"Array of jobs.","items":{"type":"object","additionalProperties":false,"properties":{"completedOn":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]}}},"maxItems":2147483647},"jobsInBatchChecksum":{"type":"integer","format":"int32","description":"Expected number of jobs in batch."},"orderId":{"type":"string","format":"uuid","description":"Id of the order.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"startedOn":{"type":"string","format":"date-time"},"totalJobs":{"type":"integer","format":"int32","description":"Total amount of jobs inside the order."}}}}},"description":"Get a batch with a given batchId for a given orderId."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return batch failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Batch with the requested orderId and batchId not found."}},"security":[{"oAuth2":["profile email"]}],"tags":["Item Relationship Service"],"method":"get","path":"/irs/orders/{orderId}/batches/{batchId}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Get a batch with a given batchId for a given orderId.","description":{"content":"Get a batch with a given batchId for a given orderId.","type":"text/plain"},"url":{"path":["irs","orders",":orderId","batches",":batchId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the order.","type":"text/plain"},"type":"any","value":"","key":"orderId"},{"disabled":false,"description":{"content":"(Required) Id of the batch.","type":"text/plain"},"type":"any","value":"","key":"batchId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get a batch with a given batchId for a given orderId. - - - -Get a batch with a given batchId for a given orderId. - -
Path Parameters
- -Get a batch with a given batchId for a given orderId. - -
Schema
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    jobs object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Array of jobs. - -
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
- -Return batch failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- -Batch with the requested orderId and batchId not found. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-bpn-investigation.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-bpn-investigation.api.mdx deleted file mode 100644 index 04a84ee20fb..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-bpn-investigation.api.mdx +++ /dev/null @@ -1,142 +0,0 @@ ---- -id: get-bpn-investigation -title: "Return job with additional supplyChainImpacted information." -description: "Return job with additional supplyChainImpacted information." -sidebar_label: "Return job with additional supplyChainImpacted information." -hide_title: true -hide_table_of_contents: true -api: {"description":"Return job with additional supplyChainImpacted information.","operationId":"getBPNInvestigation","parameters":[{"description":"Id of the job.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"bpns":[{"manufacturerId":"BPNL00000003AYRE","manufacturerName":"OEM A"}],"job":{"completedOn":"2022-02-03T14:48:54.709Z","createdOn":"2022-02-03T14:48:54.709Z","exception":{"errorDetail":"Timeout while requesting Digital Registry","exception":"IrsTimeoutException","exceptionDate":"2022-02-03T14:48:54.709Z"},"globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","id":"e5347c88-a921-11ec-b909-0242ac120002","lastModifiedOn":"2022-02-03T14:48:54.709Z","owner":"","parameter":{"aspects":["SerialPartTypization","AddressAspect"],"bomLifecycle":"asBuilt","collectAspects":false,"depth":1,"direction":"downward","lookupBPNs":false},"startedOn":"2022-02-03T14:48:54.709Z","state":"COMPLETED","summary":{"asyncFetchedItems":{"completed":0,"failed":0,"running":0}}},"relationships":[{"catenaXId":"urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447","linkedItem":{"assembledOn":"2022-02-03T14:48:54.709Z","childCatenaXId":"urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9","lastModifiedOn":"2022-02-03T14:48:54.709Z","lifecycleContext":"asBuilt","quantity":{"measurementUnit":{"datatypeURI":"urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece","lexicalValue":"piece"},"quantityNumber":1}}}],"shells":[{"description":[{"language":"en","text":"The shell for a vehicle"}],"globalAssetId":{"value":["urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9"]},"idShort":"future concept x","identification":"882fc530-b69b-4707-95f6-5dbc5e9baaa8","specificAssetIds":[{"key":"engineserialid","value":"12309481209312"}],"submodelDescriptors":[{"description":[{"language":"en","text":"Provides base vehicle information"}],"endpoints":[{"interface":"HTTP","protocolInformation":{"endpointAddress":"https://catena-x.net/vehicle/basedetails/","endpointProtocol":"HTTPS","endpointProtocolVersion":"1.0"}}],"idShort":"vehicle base details","identification":"4a738a24-b7d8-4989-9cd6-387772f40565","semanticId":{"value":["urn:bamm:com.catenax.vehicle:0.1.1"]}},{"description":[{"language":"en","text":"Provides base vehicle information"}],"endpoints":[{"interface":"HTTP","protocolInformation":{"endpointAddress":"https://catena-x.net/vehicle/partdetails/","endpointProtocol":"HTTPS","endpointProtocolVersion":"1.0"}}],"idShort":"vehicle part details","identification":"dae4d249-6d66-4818-b576-bf52f3b9ae90","semanticId":{"value":["urn:bamm:com.catenax.vehicle:0.1.1#PartDetails"]}}]}],"submodels":[{"aspectType":"urn:bamm:io.catenax.assembly_part_relationship:1.0.0","identification":"urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff","payload":{"catenaXId":"urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447","childParts":[{"createdOn":"2022-02-03T14:48:54.709Z","childCatenaXId":"urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447","lastModifiedOn":"2022-02-03T14:48:54.709Z","lifecycleContext":"AsBuilt","quantity":{"measurementUnit":{"datatypeURI":"urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece","lexicalValue":"piece"},"quantityNumber":1}}]}}],"tombstones":[{"catenaXId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","endpointURL":"https://catena-x.net/vehicle/partdetails/","processingError":{"errorDetail":"Details to reason of Failure","lastAttempt":"2022-02-03T14:48:54.709Z","processStep":"SchemaValidation","retryCounter":0}}]}}},"schema":{"type":"object","additionalProperties":false,"description":"Container for a job with item graph.","properties":{"bpns":{"type":"array","description":"Collection of bpn mappings","items":{"type":"object","additionalProperties":false,"description":"Business partner id with name","properties":{"manufacturerId":{"type":"string"},"manufacturerName":{"type":"string"}}},"maxItems":2147483647,"uniqueItems":true},"job":{"type":"object","additionalProperties":false,"description":"Executable unit with meta information and item graph result.","properties":{"completedOn":{"type":"string","format":"date-time"},"createdOn":{"type":"string","format":"date-time"},"exception":{"type":"object","additionalProperties":false,"description":"Job error details.","properties":{"errorDetail":{"type":"string","description":"Detailed exception information.","maxLength":4000},"exception":{"type":"string","description":"Exception name.","maxLength":100},"exceptionDate":{"type":"string","format":"date-time","description":"Datetime error occurs."}}},"globalAssetId":{"type":"string","description":"Part global unique id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"id":{"type":"string","format":"uuid","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"lastModifiedOn":{"type":"string","format":"date-time"},"owner":{"type":"string","description":"The IRS api consumer."},"parameter":{"type":"object","additionalProperties":false,"description":"Job parameter of job processing.","properties":{"aspects":{"type":"string"},"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"callbackUrl":{"type":"string"},"collectAspects":{"type":"boolean"},"depth":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0},"direction":{"type":"string","description":"Item graph traversal direction.","enum":["upward","downward"]},"lookupBPNs":{"type":"boolean"}}},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]},"summary":{"type":"object","additionalProperties":false,"description":"Summary of the job with statistics of the job processing.","properties":{"asyncFetchedItems":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}},"bpnLookups":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}}}}},"required":["globalAssetId","id","state"]},"relationships":{"type":"array","description":"Relationships between parent and child items.","items":{"type":"object","additionalProperties":false,"description":"Relationships between parent and child items.","properties":{"aspectType":{"type":"string"},"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"linkedItem":{"type":"object","additionalProperties":false,"description":"Set of child parts the parent object is assembled by (one structural level down).","properties":{"assembledOn":{"type":"string","format":"date-time","description":"Datetime of assembly."},"childCatenaXId":{"type":"string","description":"CatenaX child global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"lastModifiedOn":{"type":"string","format":"date-time","description":"Last datetime item was modified."},"lifecycleContext":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"quantity":{"type":"object","additionalProperties":false,"description":"Quantity component.","properties":{"measurementUnit":{"type":"object","additionalProperties":false,"properties":{"datatypeURI":{"type":"string"},"lexicalValue":{"type":"string"}}},"quantityNumber":{"type":"number","format":"double","maximum":2147483647,"minimum":0}}}}}}},"maxItems":2147483647},"shells":{"type":"array","description":"AAS shells.","items":{"type":"object","additionalProperties":false,"description":"AAS shells.","properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string"},"text":{"type":"string"}}},"maxItems":2147483647},"globalAssetId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"idShort":{"type":"string"},"identification":{"type":"string"},"specificAssetIds":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"subjectId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"value":{"type":"string"}}},"maxItems":2147483647},"submodelDescriptors":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string"},"text":{"type":"string"}}},"maxItems":2147483647},"endpoints":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"interface":{"type":"string"},"protocolInformation":{"type":"object","additionalProperties":false,"properties":{"endpointAddress":{"type":"string"},"endpointProtocol":{"type":"string"},"endpointProtocolVersion":{"type":"string"},"subprotocol":{"type":"string"},"subprotocolBody":{"type":"string"},"subprotocolBodyEncoding":{"type":"string"}}}}},"maxItems":2147483647},"idShort":{"type":"string"},"identification":{"type":"string"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}}}},"maxItems":2147483647}}},"maxItems":2147483647},"submodels":{"type":"array","description":"Collection of requested Submodels","items":{"type":"object","additionalProperties":false,"description":"Submodel with identification of SubmodelDescriptor, aspect type and payload as String","properties":{"aspectType":{"type":"string"},"identification":{"type":"string"},"payload":{"type":"object","additionalProperties":{"type":"object"}}}},"maxItems":2147483647},"tombstones":{"type":"array","description":"Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL.","items":{"type":"object","additionalProperties":false,"description":"Tombstone with information about request failure","properties":{"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"endpointURL":{"type":"string"},"processingError":{"type":"object","additionalProperties":false,"properties":{"errorDetail":{"type":"string"},"lastAttempt":{"type":"string","format":"date-time"},"processStep":{"type":"string","enum":["SubmodelRequest","DigitalTwinRequest","SchemaValidation","SchemaRequest","BpdmRequest","BpdmValidation","UsagePolicyValidation"]},"retryCounter":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0}}}}},"maxItems":2147483647}}}}},"description":"Return job with item graph for the requested id."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return job failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Job with the requested jobId not found."}},"security":[{"oAuth2":["profile email"]}],"tags":["Environmental- and Social Standards"],"method":"get","path":"/ess/bpn/investigations/{id}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Return job with additional supplyChainImpacted information.","description":{"content":"Return job with additional supplyChainImpacted information.","type":"text/plain"},"url":{"path":["ess","bpn","investigations",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the job.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Return job with additional supplyChainImpacted information. - - - -Return job with additional supplyChainImpacted information. - -
Path Parameters
- -Return job with item graph for the requested id. - -
Schema
    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. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>= 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    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. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    linkedItem object
    - -Set of child parts the parent object is assembled by (one structural level down). - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    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
  • property name* object
    • tombstones object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    processingError object
- -Return job failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- -Job with the requested jobId not found. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-job-for-job-id.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-job-for-job-id.api.mdx deleted file mode 100644 index 39db9ce2f3d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-job-for-job-id.api.mdx +++ /dev/null @@ -1,238 +0,0 @@ ---- -id: get-job-for-job-id -title: "Return job with optional item graph result for requested id." -description: "Return job with optional item graph result for requested id." -sidebar_label: "Return job with optional item graph result for requested id." -hide_title: true -hide_table_of_contents: true -api: {"description":"Return job with optional item graph result for requested id.","operationId":"getJobForJobId","parameters":[{"description":"Id of the job.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}},{"description":" Return job with current processed item graph. Return job with item graph if job is in state , otherwise job.","in":"query","name":"returnUncompletedJob","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"bpns":[{"manufacturerId":"BPNL00000003AYRE","manufacturerName":"OEM A"}],"job":{"completedOn":"2022-02-03T14:48:54.709Z","createdOn":"2022-02-03T14:48:54.709Z","exception":{"errorDetail":"Timeout while requesting Digital Registry","exception":"IrsTimeoutException","exceptionDate":"2022-02-03T14:48:54.709Z"},"globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","id":"e5347c88-a921-11ec-b909-0242ac120002","lastModifiedOn":"2022-02-03T14:48:54.709Z","owner":"","parameter":{"aspects":["SerialPartTypization","AddressAspect"],"bomLifecycle":"asBuilt","collectAspects":false,"depth":1,"direction":"downward","lookupBPNs":false},"startedOn":"2022-02-03T14:48:54.709Z","state":"COMPLETED","summary":{"asyncFetchedItems":{"completed":0,"failed":0,"running":0}}},"relationships":[{"catenaXId":"urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447","linkedItem":{"assembledOn":"2022-02-03T14:48:54.709Z","childCatenaXId":"urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9","lastModifiedOn":"2022-02-03T14:48:54.709Z","lifecycleContext":"asBuilt","quantity":{"measurementUnit":{"datatypeURI":"urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece","lexicalValue":"piece"},"quantityNumber":1}}}],"shells":[{"description":[{"language":"en","text":"The shell for a vehicle"}],"globalAssetId":{"value":["urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9"]},"idShort":"future concept x","identification":"882fc530-b69b-4707-95f6-5dbc5e9baaa8","specificAssetIds":[{"key":"engineserialid","value":"12309481209312"}],"submodelDescriptors":[{"description":[{"language":"en","text":"Provides base vehicle information"}],"endpoints":[{"interface":"HTTP","protocolInformation":{"endpointAddress":"https://catena-x.net/vehicle/basedetails/","endpointProtocol":"HTTPS","endpointProtocolVersion":"1.0"}}],"idShort":"vehicle base details","identification":"4a738a24-b7d8-4989-9cd6-387772f40565","semanticId":{"value":["urn:bamm:com.catenax.vehicle:0.1.1"]}},{"description":[{"language":"en","text":"Provides base vehicle information"}],"endpoints":[{"interface":"HTTP","protocolInformation":{"endpointAddress":"https://catena-x.net/vehicle/partdetails/","endpointProtocol":"HTTPS","endpointProtocolVersion":"1.0"}}],"idShort":"vehicle part details","identification":"dae4d249-6d66-4818-b576-bf52f3b9ae90","semanticId":{"value":["urn:bamm:com.catenax.vehicle:0.1.1#PartDetails"]}}]}],"submodels":[{"aspectType":"urn:bamm:io.catenax.assembly_part_relationship:1.0.0","identification":"urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff","payload":{"catenaXId":"urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447","childParts":[{"createdOn":"2022-02-03T14:48:54.709Z","childCatenaXId":"urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447","lastModifiedOn":"2022-02-03T14:48:54.709Z","lifecycleContext":"AsBuilt","quantity":{"measurementUnit":{"datatypeURI":"urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece","lexicalValue":"piece"},"quantityNumber":1}}]}}],"tombstones":[{"catenaXId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","endpointURL":"https://catena-x.net/vehicle/partdetails/","processingError":{"errorDetail":"Details to reason of Failure","lastAttempt":"2022-02-03T14:48:54.709Z","processStep":"SchemaValidation","retryCounter":0}}]}}},"schema":{"type":"object","additionalProperties":false,"description":"Container for a job with item graph.","properties":{"bpns":{"type":"array","description":"Collection of bpn mappings","items":{"type":"object","additionalProperties":false,"description":"Business partner id with name","properties":{"manufacturerId":{"type":"string"},"manufacturerName":{"type":"string"}}},"maxItems":2147483647,"uniqueItems":true},"job":{"type":"object","additionalProperties":false,"description":"Executable unit with meta information and item graph result.","properties":{"completedOn":{"type":"string","format":"date-time"},"createdOn":{"type":"string","format":"date-time"},"exception":{"type":"object","additionalProperties":false,"description":"Job error details.","properties":{"errorDetail":{"type":"string","description":"Detailed exception information.","maxLength":4000},"exception":{"type":"string","description":"Exception name.","maxLength":100},"exceptionDate":{"type":"string","format":"date-time","description":"Datetime error occurs."}}},"globalAssetId":{"type":"string","description":"Part global unique id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"id":{"type":"string","format":"uuid","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"lastModifiedOn":{"type":"string","format":"date-time"},"owner":{"type":"string","description":"The IRS api consumer."},"parameter":{"type":"object","additionalProperties":false,"description":"Job parameter of job processing.","properties":{"aspects":{"type":"string"},"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"callbackUrl":{"type":"string"},"collectAspects":{"type":"boolean"},"depth":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0},"direction":{"type":"string","description":"Item graph traversal direction.","enum":["upward","downward"]},"lookupBPNs":{"type":"boolean"}}},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]},"summary":{"type":"object","additionalProperties":false,"description":"Summary of the job with statistics of the job processing.","properties":{"asyncFetchedItems":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}},"bpnLookups":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}}}}},"required":["globalAssetId","id","state"]},"relationships":{"type":"array","description":"Relationships between parent and child items.","items":{"type":"object","additionalProperties":false,"description":"Relationships between parent and child items.","properties":{"aspectType":{"type":"string"},"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"linkedItem":{"type":"object","additionalProperties":false,"description":"Set of child parts the parent object is assembled by (one structural level down).","properties":{"assembledOn":{"type":"string","format":"date-time","description":"Datetime of assembly."},"childCatenaXId":{"type":"string","description":"CatenaX child global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"lastModifiedOn":{"type":"string","format":"date-time","description":"Last datetime item was modified."},"lifecycleContext":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"quantity":{"type":"object","additionalProperties":false,"description":"Quantity component.","properties":{"measurementUnit":{"type":"object","additionalProperties":false,"properties":{"datatypeURI":{"type":"string"},"lexicalValue":{"type":"string"}}},"quantityNumber":{"type":"number","format":"double","maximum":2147483647,"minimum":0}}}}}}},"maxItems":2147483647},"shells":{"type":"array","description":"AAS shells.","items":{"type":"object","additionalProperties":false,"description":"AAS shells.","properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string"},"text":{"type":"string"}}},"maxItems":2147483647},"globalAssetId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"idShort":{"type":"string"},"identification":{"type":"string"},"specificAssetIds":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"subjectId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"value":{"type":"string"}}},"maxItems":2147483647},"submodelDescriptors":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string"},"text":{"type":"string"}}},"maxItems":2147483647},"endpoints":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"interface":{"type":"string"},"protocolInformation":{"type":"object","additionalProperties":false,"properties":{"endpointAddress":{"type":"string"},"endpointProtocol":{"type":"string"},"endpointProtocolVersion":{"type":"string"},"subprotocol":{"type":"string"},"subprotocolBody":{"type":"string"},"subprotocolBodyEncoding":{"type":"string"}}}}},"maxItems":2147483647},"idShort":{"type":"string"},"identification":{"type":"string"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}}}},"maxItems":2147483647}}},"maxItems":2147483647},"submodels":{"type":"array","description":"Collection of requested Submodels","items":{"type":"object","additionalProperties":false,"description":"Submodel with identification of SubmodelDescriptor, aspect type and payload as String","properties":{"aspectType":{"type":"string"},"identification":{"type":"string"},"payload":{"type":"object","additionalProperties":{"type":"object"}}}},"maxItems":2147483647},"tombstones":{"type":"array","description":"Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL.","items":{"type":"object","additionalProperties":false,"description":"Tombstone with information about request failure","properties":{"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"endpointURL":{"type":"string"},"processingError":{"type":"object","additionalProperties":false,"properties":{"errorDetail":{"type":"string"},"lastAttempt":{"type":"string","format":"date-time"},"processStep":{"type":"string","enum":["SubmodelRequest","DigitalTwinRequest","SchemaValidation","SchemaRequest","BpdmRequest","BpdmValidation","UsagePolicyValidation"]},"retryCounter":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0}}}}},"maxItems":2147483647}}}}},"description":"Return job with item graph for the requested id."},"206":{"content":{"application/json":{"examples":{"complete":{"value":{"bpns":[],"job":{"completedOn":"2022-02-03T14:48:54.709Z","createdOn":"2022-02-03T14:48:54.709Z","exception":{"errorDetail":"Timeout while requesting Digital Registry","exception":"IrsTimeoutException","exceptionDate":"2022-02-03T14:48:54.709Z"},"globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","id":"e5347c88-a921-11ec-b909-0242ac120002","lastModifiedOn":"2022-02-03T14:48:54.709Z","owner":"","parameter":{"aspects":["SerialPartTypization","AddressAspect"],"bomLifecycle":"asBuilt","collectAspects":false,"depth":1,"direction":"downward","lookupBPNs":false},"startedOn":"2022-02-03T14:48:54.709Z","state":"RUNNING","summary":{"asyncFetchedItems":{"completed":0,"failed":0,"running":0}}},"relationships":[],"submodels":[],"tombstones":[]}}},"schema":{"type":"object","additionalProperties":false,"description":"Container for a job with item graph.","properties":{"bpns":{"type":"array","description":"Collection of bpn mappings","items":{"type":"object","additionalProperties":false,"description":"Business partner id with name","properties":{"manufacturerId":{"type":"string"},"manufacturerName":{"type":"string"}}},"maxItems":2147483647,"uniqueItems":true},"job":{"type":"object","additionalProperties":false,"description":"Executable unit with meta information and item graph result.","properties":{"completedOn":{"type":"string","format":"date-time"},"createdOn":{"type":"string","format":"date-time"},"exception":{"type":"object","additionalProperties":false,"description":"Job error details.","properties":{"errorDetail":{"type":"string","description":"Detailed exception information.","maxLength":4000},"exception":{"type":"string","description":"Exception name.","maxLength":100},"exceptionDate":{"type":"string","format":"date-time","description":"Datetime error occurs."}}},"globalAssetId":{"type":"string","description":"Part global unique id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"id":{"type":"string","format":"uuid","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"lastModifiedOn":{"type":"string","format":"date-time"},"owner":{"type":"string","description":"The IRS api consumer."},"parameter":{"type":"object","additionalProperties":false,"description":"Job parameter of job processing.","properties":{"aspects":{"type":"string"},"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"callbackUrl":{"type":"string"},"collectAspects":{"type":"boolean"},"depth":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0},"direction":{"type":"string","description":"Item graph traversal direction.","enum":["upward","downward"]},"lookupBPNs":{"type":"boolean"}}},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]},"summary":{"type":"object","additionalProperties":false,"description":"Summary of the job with statistics of the job processing.","properties":{"asyncFetchedItems":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}},"bpnLookups":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}}}}},"required":["globalAssetId","id","state"]},"relationships":{"type":"array","description":"Relationships between parent and child items.","items":{"type":"object","additionalProperties":false,"description":"Relationships between parent and child items.","properties":{"aspectType":{"type":"string"},"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"linkedItem":{"type":"object","additionalProperties":false,"description":"Set of child parts the parent object is assembled by (one structural level down).","properties":{"assembledOn":{"type":"string","format":"date-time","description":"Datetime of assembly."},"childCatenaXId":{"type":"string","description":"CatenaX child global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"lastModifiedOn":{"type":"string","format":"date-time","description":"Last datetime item was modified."},"lifecycleContext":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"quantity":{"type":"object","additionalProperties":false,"description":"Quantity component.","properties":{"measurementUnit":{"type":"object","additionalProperties":false,"properties":{"datatypeURI":{"type":"string"},"lexicalValue":{"type":"string"}}},"quantityNumber":{"type":"number","format":"double","maximum":2147483647,"minimum":0}}}}}}},"maxItems":2147483647},"shells":{"type":"array","description":"AAS shells.","items":{"type":"object","additionalProperties":false,"description":"AAS shells.","properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string"},"text":{"type":"string"}}},"maxItems":2147483647},"globalAssetId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"idShort":{"type":"string"},"identification":{"type":"string"},"specificAssetIds":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"subjectId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}},"value":{"type":"string"}}},"maxItems":2147483647},"submodelDescriptors":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string"},"text":{"type":"string"}}},"maxItems":2147483647},"endpoints":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"interface":{"type":"string"},"protocolInformation":{"type":"object","additionalProperties":false,"properties":{"endpointAddress":{"type":"string"},"endpointProtocol":{"type":"string"},"endpointProtocolVersion":{"type":"string"},"subprotocol":{"type":"string"},"subprotocolBody":{"type":"string"},"subprotocolBodyEncoding":{"type":"string"}}}}},"maxItems":2147483647},"idShort":{"type":"string"},"identification":{"type":"string"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"array","items":{"type":"string"},"maxItems":2147483647}}}}},"maxItems":2147483647}}},"maxItems":2147483647},"submodels":{"type":"array","description":"Collection of requested Submodels","items":{"type":"object","additionalProperties":false,"description":"Submodel with identification of SubmodelDescriptor, aspect type and payload as String","properties":{"aspectType":{"type":"string"},"identification":{"type":"string"},"payload":{"type":"object","additionalProperties":{"type":"object"}}}},"maxItems":2147483647},"tombstones":{"type":"array","description":"Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL.","items":{"type":"object","additionalProperties":false,"description":"Tombstone with information about request failure","properties":{"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"endpointURL":{"type":"string"},"processingError":{"type":"object","additionalProperties":false,"properties":{"errorDetail":{"type":"string"},"lastAttempt":{"type":"string","format":"date-time"},"processStep":{"type":"string","enum":["SubmodelRequest","DigitalTwinRequest","SchemaValidation","SchemaRequest","BpdmRequest","BpdmValidation","UsagePolicyValidation"]},"retryCounter":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0}}}}},"maxItems":2147483647}}}}},"description":"Return job with current processed item graph for the requested id."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return job failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Job with the requested jobId not found."}},"security":[{"oAuth2":["profile email"]}],"tags":["Item Relationship Service"],"method":"get","path":"/irs/jobs/{id}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Return job with optional item graph result for requested id.","description":{"content":"Return job with optional item graph result for requested id.","type":"text/plain"},"url":{"path":["irs","jobs",":id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":" Return job with current processed item graph. Return job with item graph if job is in state , otherwise job.","type":"text/plain"},"key":"returnUncompletedJob","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the job.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Return job with optional item graph result for requested id. - - - -Return job with optional item graph result for requested id. - -
Path Parameters
Query Parameters
    Return job with current processed item graph. Return job with item graph if job is in state , otherwise job.","in":"query","name":"returnUncompletedJob","required":false,"schema":{"type":"boolean","default":true}}}>
- -Return job with item graph for the requested id. - -
Schema
    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. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>= 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    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. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    linkedItem object
    - -Set of child parts the parent object is assembled by (one structural level down). - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    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
  • property name* object
    • tombstones object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    processingError object
- -Return job with current processed item graph for the requested id. - -
Schema
    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. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>= 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    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. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    linkedItem object
    - -Set of child parts the parent object is assembled by (one structural level down). - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    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
  • property name* object
    • tombstones object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    processingError object
- -Return job failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- -Job with the requested jobId not found. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-jobs-by-job-states.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-jobs-by-job-states.api.mdx deleted file mode 100644 index 0232e3c6e3f..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/get-jobs-by-job-states.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-jobs-by-job-states -title: "Returns paginated jobs with state and execution times." -description: "Returns paginated jobs with state and execution times." -sidebar_label: "Returns paginated jobs with state and execution times." -hide_title: true -hide_table_of_contents: true -api: {"description":"Returns paginated jobs with state and execution times.","operationId":"getJobsByJobStates","parameters":[{"description":"Requested job states.","explode":false,"in":"query","name":"states","required":false,"schema":{"type":"array","items":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]},"maxItems":2147483647}},{"description":"Zero-based page index (0..N)","in":"query","name":"page","schema":{"type":"integer","default":0}},{"description":"The size of the page to be returned","in":"query","name":"size","schema":{"type":"integer","default":20}},{"description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","in":"query","name":"sort","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"content":[{"completedOn":"2022-02-03T14:48:54.709Z","id":"6c311d29-5753-46d4-b32c-19b918ea93b0","startedOn":"2022-02-03T14:48:54.709Z","state":"COMPLETED"}],"pageCount":1,"pageNumber":0,"pageSize":10,"totalElements":1}}},"schema":{"type":"object","additionalProperties":false,"properties":{"content":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"completedOn":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]}}}},"pageCount":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"}}}}},"description":"Paginated list of jobs with state and execution times for requested job states."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return jobs for requested job states failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":["profile email"]}],"tags":["Item Relationship Service"],"method":"get","path":"/irs/jobs","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Returns paginated jobs with state and execution times.","description":{"content":"Returns paginated jobs with state and execution times.","type":"text/plain"},"url":{"path":["irs","jobs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Requested job states.","type":"text/plain"},"key":"states","value":""},{"disabled":false,"description":{"content":"Zero-based page index (0..N)","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"The size of the page to be returned","type":"text/plain"},"key":"size","value":""},{"disabled":false,"description":{"content":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","type":"text/plain"},"key":"sort","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns paginated jobs with state and execution times. - - - -Returns paginated jobs with state and execution times. - -
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
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx deleted file mode 100644 index 6c253a8234b..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: irs-api -title: "IRS API" -description: "The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners." -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: 2.0 - -# IRS API - - - -The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners. - -

Authentication

Security Scheme Type:oauth2
clientCredentials OAuth Flow:

Token URL: https://localhost

Scopes:
  • profile email:
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/receive-edc-notification.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/receive-edc-notification.api.mdx deleted file mode 100644 index f6c7fc32643..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/receive-edc-notification.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: receive-edc-notification -title: "Accepts notifications sent via EDC." -description: "Accepts notifications via EDC. Notifications are filtered by their type and processed accordingly." -sidebar_label: "Accepts notifications sent via EDC." -hide_title: true -hide_table_of_contents: true -api: {"description":"Accepts notifications via EDC. Notifications are filtered by their type and processed accordingly.","operationId":"receiveEdcNotification","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"content":{"type":"object","additionalProperties":{"type":"object"}},"header":{"type":"object","additionalProperties":false,"description":"EDC notification header information","properties":{"notificationId":{"type":"string"},"notificationType":{"type":"string"},"originalNotificationId":{"type":"string"},"recipientBpn":{"type":"string"},"replyAssetId":{"type":"string"},"replyAssetSubPath":{"type":"string"},"senderBpn":{"type":"string"},"senderEdc":{"type":"string"}},"required":["notificationId","notificationType","recipientBpn","senderBpn"]}},"required":["content","header"]}}},"required":true},"responses":{"200":{"description":"Notification received successfully."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Notification malformed."}},"tags":["Environmental- and Social Standards"],"method":"post","path":"/ess/notification/receive","servers":[{"url":"http://localhost:8080"}],"security":[{"oAuth2":["profile email"]}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"jsonRequestBodyExample":{"content":{},"header":{"notificationId":"string","notificationType":"string","originalNotificationId":"string","recipientBpn":"string","replyAssetId":"string","replyAssetSubPath":"string","senderBpn":"string","senderEdc":"string"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Accepts notifications sent via EDC.","description":{"content":"Accepts notifications via EDC. Notifications are filtered by their type and processed accordingly.","type":"text/plain"},"url":{"path":["ess","notification","receive"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Accepts notifications sent via EDC. - - - -Accepts notifications via EDC. Notifications are filtered by their type and processed accordingly. - -
Request Body required
    content object required
  • property name* object
    • header object required
    - -EDC notification header information - -
- -Notification received successfully. - -
- -Notification malformed. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/register-bpn-investigation.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/register-bpn-investigation.api.mdx deleted file mode 100644 index 677d992d508..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/register-bpn-investigation.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: register-bpn-investigation -title: "Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId." -description: "Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId." -sidebar_label: "Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId." -hide_title: true -hide_table_of_contents: true -api: {"description":"Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.","operationId":"registerBPNInvestigation","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"description":"The requested job definition.","properties":{"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"callbackUrl":{"type":"string","description":"Callback url to notify requestor when job processing is finished. There are two uri variable placeholders that can be used: jobId and jobState.","example":"https://hostname.com/callback?jobId={jobId}&jobState={jobState}"},"globalAssetId":{"type":"string","description":"Id of global asset.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"incidentBpns":{"type":"array","items":{"type":"string"},"maxItems":2147483647}},"required":["globalAssetId","incidentBpns"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"complete":{"value":{"id":"6c311d29-5753-46d4-b32c-19b918ea93b0"}}},"schema":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"uuid","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"}}}}},"description":"Returns id of registered job."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Job registration failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":["profile email"]}],"tags":["Environmental- and Social Standards"],"method":"post","path":"/ess/bpn/investigations","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"jsonRequestBodyExample":{"bomLifecycle":"asBuilt","callbackUrl":"https://hostname.com/callback?jobId={jobId}&jobState={jobState}","globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","incidentBpns":["string"]},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.","description":{"content":"Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.","type":"text/plain"},"url":{"path":["ess","bpn","investigations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId. - - - -Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId. - -
Request Body required
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
- -Returns id of registered job. - -
Schema
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
- -Job registration failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/register-job-for-global-asset-id.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/register-job-for-global-asset-id.api.mdx deleted file mode 100644 index b24de18dd6d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/register-job-for-global-asset-id.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: register-job-for-global-asset-id -title: "Register an IRS job to retrieve an item graph for given {globalAssetId}." -description: "Register an IRS job to retrieve an item graph for given {globalAssetId}." -sidebar_label: "Register an IRS job to retrieve an item graph for given {globalAssetId}." -hide_title: true -hide_table_of_contents: true -api: {"description":"Register an IRS job to retrieve an item graph for given {globalAssetId}.","operationId":"registerJobForGlobalAssetId","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"description":"The requested job definition.","properties":{"aspects":{"type":"array","items":{"type":"string"},"maxItems":2147483647},"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"callbackUrl":{"type":"string","description":"Callback url to notify requestor when job processing is finished. There are two uri variable placeholders that can be used: id and state.","example":"https://hostname.com/callback?id={id}&state={state}"},"collectAspects":{"type":"boolean","description":"Flag to specify whether aspects should be requested and collected. Default is false."},"depth":{"type":"integer","format":"int32","description":"Max depth of the item graph returned. If no depth is set item graph with max depth is returned.","maximum":100,"minimum":1},"direction":{"type":"string","default":"downward","description":"Item graph traversal direction.","enum":["upward","downward"]},"globalAssetId":{"type":"string","description":"Id of global asset.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"lookupBPNs":{"type":"boolean","description":"Flag to specify whether BPNs should be collected and resolved via the configured BPDM URL. Default is false."}},"required":["globalAssetId"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"complete":{"value":{"id":"6c311d29-5753-46d4-b32c-19b918ea93b0"}}},"schema":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"uuid","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"}}}}},"description":"Returns id of registered job."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Job registration failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":["profile email"]}],"tags":["Item Relationship Service"],"method":"post","path":"/irs/jobs","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"jsonRequestBodyExample":{"aspects":["string"],"bomLifecycle":"asBuilt","callbackUrl":"https://hostname.com/callback?id={id}&state={state}","collectAspects":true,"depth":0,"direction":"downward","globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","lookupBPNs":true},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Register an IRS job to retrieve an item graph for given {globalAssetId}.","description":{"content":"Register an IRS job to retrieve an item graph for given {globalAssetId}.","type":"text/plain"},"url":{"path":["irs","jobs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Register an IRS job to retrieve an item graph for given {globalAssetId}. - - - -Register an IRS job to retrieve an item graph for given {globalAssetId}. - -
Request Body required
    = 1` and `<= 100`"} defaultValue={undefined}>= 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
- -Returns id of registered job. - -
Schema
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
- -Job registration failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/register-order.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/register-order.api.mdx deleted file mode 100644 index d48f33af0ae..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/register-order.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: register-order -title: "Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches." -description: "Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches." -sidebar_label: "Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches." -hide_title: true -hide_table_of_contents: true -api: {"description":"Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches.","operationId":"registerOrder","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"description":"Request body for registering a new Batch Order.","properties":{"aspects":{"type":"array","items":{"type":"string"},"maxItems":2147483647},"batchSize":{"type":"integer","format":"int32","default":20,"description":"Size of the batch.","maximum":100,"minimum":10},"batchStrategy":{"type":"string","description":"The strategy how the batch is processed internally in IRS.","enum":["PRESERVE_BATCH_JOB_ORDER","PRESERVE_JOB_ORDER","PRESERVE_BATCH_ORDER"]},"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned"]},"callbackUrl":{"type":"string","description":"Callback url to notify requestor when job processing is finished. There are four uri variable placeholders that can be used: orderId, batchId, orderState and batchState.","example":"https://hostname.com/callback?orderId={orderId}&batchId={batchId}&orderState={orderState}&batchState={batchState}"},"collectAspects":{"type":"boolean","description":"Flag to specify whether aspects should be requested and collected. Default is false."},"depth":{"type":"integer","format":"int32","description":"Max depth of the item graph returned. If no depth is set item graph with max depth is returned.","maximum":100,"minimum":1},"direction":{"type":"string","default":"downward","description":"Item graph traversal direction.","enum":["upward","downward"]},"globalAssetIds":{"type":"array","items":{"type":"string"},"maxItems":2147483647},"jobTimeout":{"type":"integer","format":"int32","default":3600,"description":"Timeout in seconds for each job processing inside the complete order.","maximum":7200,"minimum":60},"lookupBPNs":{"type":"boolean","description":"Flag to specify whether BPNs should be collected and resolved via the configured BPDM URL. Default is false."},"timeout":{"type":"integer","format":"int32","default":43200,"description":"Timeout in seconds for the complete batch order processing.","maximum":86400,"minimum":60}},"required":["globalAssetIds"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"complete":{"value":{"id":"6c311d29-5753-46d4-b32c-19b918ea93b0"}}},"schema":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"uuid","description":"Id of the Batch Order."}}}}},"description":"Returns orderId of registered Batch order."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Batch Order registration failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":["profile email"]}],"tags":["Item Relationship Service"],"method":"post","path":"/irs/orders","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{"profile email":""},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"jsonRequestBodyExample":{"aspects":["string"],"batchSize":20,"batchStrategy":"PRESERVE_BATCH_JOB_ORDER","bomLifecycle":"asBuilt","callbackUrl":"https://hostname.com/callback?orderId={orderId}&batchId={batchId}&orderState={orderState}&batchState={batchState}","collectAspects":true,"depth":0,"direction":"downward","globalAssetIds":["string"],"jobTimeout":3600,"lookupBPNs":true,"timeout":43200},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.0"},"postman":{"name":"Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches.","description":{"content":"Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches.","type":"text/plain"},"url":{"path":["irs","orders"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches. - - - -Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches. - -
Request Body required
    = 10` and `<= 100`"} defaultValue={20}>= 1` and `<= 100`"} defaultValue={undefined}>= 60` and `<= 7200`"} defaultValue={3600}>= 60` and `<= 86400`"} defaultValue={43200}>
- -Returns orderId of registered Batch order. - -
Schema
- -Batch Order registration failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js deleted file mode 100644 index c072d04232a..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/irs-api"},{"type":"category","label":"Environmental- and Social Standards","link":{"type":"generated-index","title":"Environmental- and Social Standards","slug":"/category/kits/Data Chain Kit/Software Development View/Job Api/environmental-and-social-standards"},"items":[{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/register-bpn-investigation","label":"Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.","className":"api-method post"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-bpn-investigation","label":"Return job with additional supplyChainImpacted information.","className":"api-method get"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/receive-edc-notification","label":"Accepts notifications sent via EDC.","className":"api-method post"}]},{"type":"category","label":"Item Relationship Service","link":{"type":"generated-index","title":"Item Relationship Service","slug":"/category/kits/Data Chain Kit/Software Development View/Job Api/item-relationship-service"},"items":[{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-jobs-by-job-states","label":"Returns paginated jobs with state and execution times.","className":"api-method get"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/register-job-for-global-asset-id","label":"Register an IRS job to retrieve an item graph for given {globalAssetId}.","className":"api-method post"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-job-for-job-id","label":"Return job with optional item graph result for requested id.","className":"api-method get"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/cancel-job-by-job-id","label":"Cancel job for requested jobId.","className":"api-method put"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/register-order","label":"Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches.","className":"api-method post"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-batch-order","label":"Get a batch order for a given orderId.","className":"api-method get"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/cancel-batch-order","label":"Cancel a batch order for a given orderId.","className":"api-method put"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-batch","label":"Get a batch with a given batchId for a given orderId.","className":"api-method get"}]},{"type":"category","label":"Aspect Models","link":{"type":"generated-index","title":"Aspect Models","slug":"/category/kits/Data Chain Kit/Software Development View/Job Api/aspect-models"},"items":[{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-all-aspect-models","label":"Get all available aspect models from semantic hub or local models.","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/_category_.json b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/_category_.json deleted file mode 100644 index e5c5b7565a3..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Development View" -} diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/page_software-development-view.md deleted file mode 100644 index 8ac78963676..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Software Development View/page_software-development-view.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -id: Specification -title: Specification -sidebar_position: 2 ---- - -![Datachain kit banner](@site/static/img/DataChainKitIcon.png) - -### Data Chain KIT - -## IRS REST API - -The IRS Rest API provides an easy to use Interface for applications to access cross company data chains. - -## IRS REST API Standard - -The IRS REST API is standardized through the Catena-X e.V. and can be found here: - -- [> CX-0005 Item Relationship Service API](https://catena-x.net/de/standard-library) - -Comming Soon: - -- CX-0045 Data Chain Template diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Success Stories/page_ce_circularity_dashboard_story.md b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Success Stories/page_ce_circularity_dashboard_story.md deleted file mode 100644 index 704aa69a6d9..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Success Stories/page_ce_circularity_dashboard_story.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -id: Circularity Dashboard Sucess Story -title: Circularity Dashboard Sucess Story -description: 'Data Chain Kit' -sidebar_position: 1 ---- - -Due to the large number of producers and consumers, however, the implementation of the circular economy is challenging: Information on the individual lifecycles is mostly only available locally and therefore does not provide any meaningful assessment of reuse, recycling or remanufacturing. - -![success](@site/static/img/irs-circularity-dashboard-successstory.png) - -Therefore, the circularity dashboard, gives the user information about materials of the product and of all their composites. This is only possible, if participants of the supply chain, the direct manufactures of the composites of a vehicle are sharing information about the materials used. -The ability to access provided data in the Catena-X network could be done in two different ways. Way one is to handle each request separately, or use the IRS, which manages the retrieval of digital twins, checks and validates the results against the semantics and provides an easy-to-use API to interact with the decentral stored data. -In the SAP Industry Network for Automotive, circularity cockpit API specification and IRS implementation are serving as a reference. Thus, we were able to develop IRS functionality to best fit the SAP tech stack, which we decided to use for the circularity cockpit. -This enables us, to have a controlled access to distributed data in an interoperable setup to access data chains. To abstract the data consumption layer brings benefits in stability and resiliency to our application, because we could easily change to different providers or services of a IRS implementation. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Success Stories/page_trace-x_story.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Success Stories/page_trace-x_story.mdx deleted file mode 100644 index 7e07727a49e..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Success Stories/page_trace-x_story.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: Trace-X Sucess Story -title: Trace-X Sucess Story -description: 'Data Chain Kit' -sidebar_position: 1 ---- - -import Image from "@site/static/img/Group31.png" - - -
-

Trace-X

-
-

Trace-X empowers all companies from SMEs to large OEMs to participate in parts traceability with an Open-Source solution.

- -![Trace-X-Screenshot](@site/static/img/Trace-X/Trace-X_App-mypartsview.png) - -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. - -![success2](@site/static/img/IRS2.png) - -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 beneficial 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, Keycloak 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 -
-
- -![Trace-XScreenshot1](@site/static/img/Trace-X/01.png) -![Trace-XScreenshot2](@site/static/img/Trace-X/02.png) -![Trace-XScreenshot3](@site/static/img/Trace-X/03.png) -![Trace-XScreenshot4](@site/static/img/Trace-X/04.png) - diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Success Stories/success_stories.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Success Stories/success_stories.mdx deleted file mode 100644 index 5ddcd49d879..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/Success Stories/success_stories.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -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-3.1.0/kits/Data Chain Kit/arc/page_documentation.md b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/arc/page_documentation.md deleted file mode 100644 index 3502407f2fd..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/arc/page_documentation.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: documentation -title: Documentation -description: 'Data Chain Kit' -sidebar_position: 3 ---- - -![Datachain kit banner](@site/static/img/doc-datachain_header-minified.png) - -## 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-3.1.0/kits/Data Chain Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/page_adoption-view.md deleted file mode 100644 index e926d0c4e4d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/page_adoption-view.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: Adoption View -title: Adoption View -description: 'Data Chain Kit' -sidebar_position: 1 ---- - -![Datachain kit banner](@site/static/img/DataChainKitIcon.png) - -### Data Chain KIT - -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) - -## Why Data Chain KIT - -What is in for you to use the Data Chain Kit. On what is it built on. - -![Why use Datachain Kit](@site/static/img/why_data_chain-minified.png) - -* 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 - -Read our Successstories to get a climps on what the IRS Iterative is beeing used for. - -## IRS Iterative - -The IRS iterative iterates through the different digital twin aspects, which are representing a relationship. For Release 1 this is the AssemblyPartRelationship aspect, which connects serialized parts. This service can access the digital twins for which a EDC policy and and data contract exists. In this case the consumer needs a contract which each participant of the data chain. - -![IRS iterative diagram](@site/static/img/irs-minified.svg) - -The following general conditions apply: --access control through policies and contracts is done by the EDC --direct data exchange between supply-chain partners --Catena-X partners of the accessible value chain are known to the data-consumer diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/page_changelog.md b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/page_changelog.md deleted file mode 100644 index b0039ad8ad2..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/page_changelog.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: data chain kit changelog -title: Changelog -description: 'Data Chain Kit Changelog' -sidebar_position: 10 ---- - -![Datachain kit banner](@site/static/img/DataChainKitIcon.png) - -### Data Chain KIT - -All notable changes to this Kit will be documented in this file. - -## [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-3.1.0/kits/Data Chain Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/page_software-operation-view.md deleted file mode 100644 index 71ebe03e70e..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Data Chain Kit/page_software-operation-view.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -id: Operation View -title: Operation View -description: 'Data Chain Kit' -sidebar_position: 2 ---- - -![Datachain kit banner](@site/static/img/DataChainKitIcon.png) - -### Data Chain KIT - -## Local Deployment - -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 | -|----------------------------------------------------------------------------------|-------------------------------------|-------------------------------------------------------------------------| -|![arrow down](@site/static/img/arrow_down.png)| **[Install the prerequisites](#step-1-prerequisites)**| Install all necessary tools for this setup | -|![vector](@site/static/img/vector.png) | **[Check out the Code](#step-2-check-out-the-code)** | Get all necessary code to deploy the service and dependencies to the kuberneetes cluster| -|![check](@site/static/img/check.png) | **[Installing the Service](#step-3-installing-the-services)**|Start cluster and interact with 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 - -### 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**: - -![expected status](@site/static/img/minikube-dashboard-overview.png) - -#### 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.** - -![irs-login](@site/static/img/irs-login.png) - -## 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 - ![irs-new-job](@site/static/img/irs-new-job.png) -3. **click** 'Build Data Chain' to start a new IRS job -4. **click** 'Visualization' to see the result of the job - ![irs-job-list](@site/static/img/irs-job-list.png) - -### Step 2: Verify Results - -The following example shows a visual overview of all retrieved data assets and digital twins of a data chain. -![irs-login](@site/static/img/irs-vis-overview.png) -_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. - -![irs-login](@site/static/img/irs-vis-clickable.png) -_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-3.1.0/kits/Resiliency/MP_Kit.md b/docs-kits_versioned_docs/version-3.1.0/kits/Resiliency/MP_Kit.md deleted file mode 100644 index e0d527185b6..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Resiliency/MP_Kit.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: mp kit -title: MP Kit -sidebar_position: 6 ---- - - -## Increase production flexibility and leverage existing business potential for lot size one - -### Automate the orchestration of production resources and planning processes - - -The Modular Production (MP) Kit defines services, interfaces and data models based on industry standards with the goal to increase flexibility and reliability of industrial production. Furthermore services that provide information about production status and planning that is required by other use cases will be provided. - -Modular Production has the goal to support individual production (batch size 1) at the price of series production. In particular, this is to be achieved by automating the orchestration of production resources and planning of production processes as much as possible, thus significantly reducing effort and planning times. - -See [Status Quo](#status-quo) below for more details on Modular Production. - -The Modular Production Kit is continuously under development and future extensions and improvements will help you to adopt or extend functionality even faster. - - -#### Connect and access to shopfloor information for further value creation - -Due dates, machines used etc. for specific individual produced product are made available through standardized service to the Catena-X network honoring access and data sovereignty rules. - - -### Status Quo - -Higher-level, external influencing factors from the supply chain, such as delays in the logistics chain for supplier parts or short-term order changes, may invalidate a production plan that has already been drawn up. Today, such short-term changes in the general conditions of the production process can often only be taken into consideration indirectly and made through manual corrections. - -### Benefits for OEM, SME and Solution Provider - -A growth in efficiency in the sense of the OEE is achieved in that production can be reconfigured in the event of faults to continue operating as well as possible. The increased flexibility creates the space for new business models, such as the interposition of highly prioritized, lucrative orders. - -Further benefits and value can be generated through additional services or apps that connect to the shopfloor information service via the Catena-X platform. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Resiliency/MaaS.md b/docs-kits_versioned_docs/version-3.1.0/kits/Resiliency/MaaS.md deleted file mode 100644 index b0f46b5a791..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Resiliency/MaaS.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -id: maas -title: MaaS Kit -sidebar_position: 3 ---- - - -## Enable on-demand manufacturing in an interoperable, federated network of manufacturing networks by linking demand with capacities and capabilities - - -The Manufacturing-as-a-Service (MaaS) Kit defines the mechanisms and services needed for an interoperable, federated network of networks, where manufacturing demand meets manufacturing capacities and capabilities. - -See [Status Quo](#status-quo) below for more details on Manufacturing-as-a-Service. - -The MaaS Kit provides a comprehensive reference architecture with standardized interfaces and data models, including first implemented services to show the operating network of networks with a single-entry point into the world of on-demand manufacturing (ODM) independent of domain. The main focus is on facilitating the intermediation of manufacturing supply as a service and manufacturing demand. In addition, IT services enable the connectivity and process automation for being part of this digital marketplace. - -The MAAS Kit is continuously under development and future extensions and improvements will help you to adopt or extend functionality even faster. - - -### Minimize risk of operations - -The available reference architecture supports operators of networks and services to minimize risk while operating Manufacturing-as-a-Service applications. - -### Reduce development time - -The time to develop integrations of additional solutions or stakeholders (e.g. consumers or suppliers of on-demand manufacturing) to existing networks are drastically cut through well-defined, standardised interfaces and data models. - -### Low threshold entry to marketplace - -Existing examples of implemented services enable quick entry for consumers and suppliers of on-demand manufacturing to the marketplace that facilitates the intermediation of manufacturing supply as a service and manufacturing demand. - -### Cut leadtime for manufacturing transactions - -IT services to enable connectivity and process automation to further streamline the interaction between consumer and supplier of on-demand manufacturing. - - -## Status Quo - -Manufacturing-as-a-Service is the practice of connecting consumers and providers of on-demand manufacturing capabilities in a Catena-X context both directly and through integration of other on-demand platforms. The overall aim is to increase resilience against fluctuating demand through one single-entry point for different manufacturing domains. - -By requesting components over a graphical user interface, the MaaS portal, component buyers primarily have the value of finding alternative suppliers at short notice, that are definitely able to manufacture the required components. - -Manufacturers and ODM platforms primarily gain value in the MaaS portal by offering manufacturing capabilities as suppliers. In this way, suppliers can compensate for fluctuations in demand from their conventional customers by being able to get orders from an alternative sales channel without having to invest great effort in sales activities. -Both sides also benefit from the security and data sovereignty advantages of the Catena-X environment. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Resiliency/OSim_Kit.md b/docs-kits_versioned_docs/version-3.1.0/kits/Resiliency/OSim_Kit.md deleted file mode 100644 index 74c9a0bab80..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Resiliency/OSim_Kit.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: OSIM -title: OSim Kit -description: 'Online Simulation Kit' -sidebar_position: 4 ---- - - -## Gain increased supply chain transparency through collaborative simulation across all stakeholders - -### Combine simulations of plants internally with simulations of external logistics over multiple tiers - - -The online simulation (OSim) Kit defines the mechanisms and services needed to enable every Catena-X partner (producer as well as logisticians) to exchange, combine and re-use simulation models in an open, interoperable and Catena-X compliant way. - -Online simulation aims at linking production simulation with logistics simulation in order to identify delivery problems earlier and react in response to changing customer requirements or external disturbances/events. This contrasts with conventional planning and simulation tools primarily taking the plant level into account. See [Status Quo](#status-quo) below for more details on Online Simulation. - -The OSim Kit describes an open architecture for integrating partners of all kinds together with standardized interfaces and semantic models. - -The OSim Kit is continuously under development and future extensions and improvements will help you to adopt or extend functionality even faster. - - -### Integrate any simulation tool - -Thanks to its open architecture OSim is independent of the simulation tools that partners use. - -### Integrate any supply chain partner - -Even partners that are not using any simulation tool can contribute to the overall transparency through the well-defined information requirements. - - -### Status Quo - -The online simulation enables every Catena-X partner (producer as well as logisticians) considering simulation results of their partners to simulate own processes by sharing the simulation results on supply chain level in contrast to conventional planning and simulation tools, where the simulation was used on the plant level only. - -The simulation results of the Catena-X partners on the lower tier level and logistics, together with data of the company's own operations are fed into a simulation model as input. Considering both, plannable and unforeseeable influencing factors, this simulation model is iterated through as often as necessary until an optimal result has been found. Sharing of simulation results to the next tier level is the basis of the collaborative simulation approach on a short-term timescale, across the complete supply chain. - -A central application takes over the tasks of monitoring and controlling the transmission of the simulation results, regardless of the level of digitalization of the partners. In addition, this application takes over the control of the simulation tools used. - -#### Benefits for OEM, SME and Solution Provider - -- Scenario management can be used to identify that alternative material flow should be requested or to play out what-if scenarios with new material flows - -- Early detection and reaction to delivery problems - -- Early response to changing customer requirements - -- Take external disturbances/events into account early diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Resiliency/PURIS_Kit.md b/docs-kits_versioned_docs/version-3.1.0/kits/Resiliency/PURIS_Kit.md deleted file mode 100644 index 456f45189a2..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Resiliency/PURIS_Kit.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: PURIS -title: PURIS Kit -sidebar_position: 5 ---- - - -## Mitigate the bullwhip effect in your supply chain by identifying potential shortages earlier - -### Verify the demands and capacities of actual production plan from today up to a few weeks - - -The Predictive Unit Real-Time Information System (PURIS) KIT provides the capabilities to exchange the production related information within a given relationship between two business partners such as the already available stock of the supplier, the updating stock of the customer, the customer's demand and the supplier's fulfillment status of an order. The aim is to help mitigate potential and actual shortage scenarios. - -PURIS is the second of two components of the Demand and Capacity Management as approached by the Resiliency Kit: - -1. A planning component forecasting its demands and capacities for the next months up to multiple years. -2. An operationalization component verifying the demands and capacities of its actual production plan from today up to multiple weeks. - -See [Status Quo](#status-quo) below for more details on Demand and Capacity Management. - -The PURIS Kit is continuously under development and future extensions and improvements will help you to adopt or extend functionality even faster. - - -#### Connect once to interact with all your partners - -By leveraging the standardized APIs you avoid point-to-point integrations. - -#### Increase flexibility with easy access and exchange of up-to-date information - -Low effort to exchange the latest updated information with your partners through formalized approach. - -#### Leverage Catena-X built-in data sovereignty - -Decide the access and usage conditions for the exchanged data in a compliant way - -### Status Quo - -Within the Business Domain Resiliency, the Demand and Capacity Management (DCM) represents the planning and the PURIS represents the operationalization component. Considering a shorter time period in PURIS based on the production plan, results in more reliable information. - -Generally, the Demand and Capacity Management needs a close cooperation between a company and its partners with the supply chain. - -Within the value chain, each partner needs to plan his own production and relies on his customers' demand forecasts. The bullwhip effect describes the rising amplified deviation between orders to suppliers and sales to buyers along the value chain. The fluctuation rises from tier to tier. Using the latest production related information, you can mitigate the bullwhip effect for you and your partners within the value chain. - -- As a customer, you can verify the production related information of your partner so that you can identify potential shortages earlier with less effort and mitigate or resolve them spending less resources. -- As a supplier, you can increase your production efficiency, e.g. by optimizing your batch size based on your customers' latest demands. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Resiliency/resiliency.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Resiliency/resiliency.mdx deleted file mode 100644 index b4da1e3c01a..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Resiliency/resiliency.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: resiliency -title: Resiliency Domain -description: 'Business Domain Resiliency' -sidebar_position: 1 ---- -import KitsGalleryMDX from '@site/src/components/KitsGalleryMDX' -import {resiliencyItems} from '@site/utils/resiliencyItems.js' - -## Business Domain Resiliency - -### What's in? - -The Business Domain Resiliency contains five use cases of Catena-X: - -- Demand and Capacity Management (DCM) -- Predictive Unit Real-Time Information Service (PURIS) -- Manufacturing-as-a-Service (MaaS) -- Online Control and Simulation (OSim) -- Modular Production (MP) - -For each of these use cases a specific kit is prepared which are available here in the resiliency kit area. - -The kits in the resiliency kit area enables you, especially as a provider for software services, applications and solutions, to realize offerings in a Catena-X compliant way. The kits includes, among others, information about - -- vision & mission -- semantic models as prerequisite for standardized and interoperable data exchange -- defintion of software APIs as well as -- open source code - -of each use case. - -The Resiliency Kit area is continuously under development and future extensions and improvements will help you to adopt or extend functionality even faster. - -The strengthen of resiliency of the supply chain and related shopfloor processes is a main focus in our business domain. We look at the supply chain from the Tier-n supplier to the automotive OEM and of course backwards too. Our applications are based on a cooperative concept. This means that the applications executed on each tier level are based on information obtained from one tier level up or one level down. This exchanged information is (and will be in next month step by step) standardized for each of our use cases. By executing the application (or a Catena-X compatible application for the specific use case from a different software provider - maybe realized from your company) on each tier level the supply chain over spanning task can be solved. Some of our use cases have an effect on the shop floor. For example, changed customer demands can lead to adjustments in manufacturing or vice versa changed production capacities, captured by information and operation technology on the shopfloor, can have impact to the supply chain. The linked usage of our use case application will offer an extended business value for all partners in the supply chain. - -![Resiliency-Image](@site/static/img/Resiliency-Domain-Image.jpg) - -
-
- - diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Notification API/get-quality-notification.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Notification API/get-quality-notification.api.mdx deleted file mode 100644 index fe4d5c4550c..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Notification API/get-quality-notification.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: get-quality-notification -title: "getQualityNotification" -description: "Resolves a quality notification" -sidebar_label: "getQualityNotification" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Quality notification"],"description":"Resolves a quality notification","operationId":"getQualityNotification","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["notificationId","senderBPN","senderAddress","recipientBPN"],"properties":{"notificationId":{"type":"string","format":"uuid","example":"a7954026-3aff-4b6c-92bf-04671ef2fa46","description":"A UUIDv4 to uniquely identify a quality notification."},"senderBPN":{"type":"string","example":"BPNL00000003BW3S","description":"The business partner number (BPN) of the sender. Actually, this value is not used to resolve the quality notification. Rather, it is used to do a plausibility check."},"senderAddress":{"type":"string","format":"uri","example":"https://edc.company-xyz.io/BPNL00000003BW3S","description":"The Eclipse Dataspace Connector (EDC) URL of the sender. Actually, this value is not used to resolve the quality notification. Rather, it is used to do a plausibility check."},"recipientBPN":{"type":"string","example":"BPNL00000003BV4H","description":"The business partner number (BPN) of the receiver. Actually, this value is not used to resolve the quality notification. Rather, it is used to do a plausibility check."},"messageId":{"type":"string","format":"uuid","example":"c2801472-5f87-41a7-9a25-b0939c4e0dff","description":"A UUIDv4 to uniquely identify an individual quality notification message. If this parameter is provided, the message for this messageId is resolved. If this parameter is not provided, then the last available message is resolved."}}}}}},"responses":{"200":{"description":"Quality notification was resolved successfully","content":{"application/json":{"schema":{"type":"object","required":["notificationId","senderBPN","senderAddress","recipientBPN","severity","status","messageId"],"properties":{"notificationId":{"type":"string","format":"uuid","example":"a7954026-3aff-4b6c-92bf-04671ef2fa46","description":"A UUIDv4 to uniquely identify a quality notification."},"senderBPN":{"type":"string","example":"BPNL00000003BW3S","description":"The business partner number (BPN) of the sender."},"senderAddress":{"type":"string","format":"uri","example":"https://edc.company-xyz.io/BPNL00000003BW3S","description":"The Eclipse Dataspace Connector (EDC) URL of the sender."},"recipientBPN":{"type":"string","example":"BPNL00000003BV4H","description":"The business partner number (BPN) of the receiver."},"severity":{"type":"string","enum":["MINOR","MAJOR","CRITICAL","LIFE-THREATENING"],"example":"CRITICAL","description":"The severity of the quality notification describes its criticality."},"status":{"type":"string","enum":["CREATED","SENT","RECEIVED","ACKNOWLEDGED","ACCEPTED","DECLINED","CLOSED"],"example":"SENT","description":"The status of the quality notification."},"targetDate":{"type":"string","format":"date-time","example":"2022-07-28T14:41:13.214Z","description":"The date and time when a processing of the notification is expected by the sender."},"messageId":{"type":"string","format":"uuid","example":"c2801472-5f87-41a7-9a25-b0939c4e0dff","description":"A UUIDv4 to uniquely identify an individual quality notification message."}}}}}},"400":{"description":"Request body was malformed"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Could not resolve the quality notification, because a quality notification with that notificationId does not exist"},"405":{"description":"Method not allowed"}},"method":"post","path":"/qualitynotifications/resolve","servers":[{"url":"/"}],"jsonRequestBodyExample":{"notificationId":"a7954026-3aff-4b6c-92bf-04671ef2fa46","senderBPN":"BPNL00000003BW3S","senderAddress":"https://edc.company-xyz.io/BPNL00000003BW3S","recipientBPN":"BPNL00000003BV4H","messageId":"c2801472-5f87-41a7-9a25-b0939c4e0dff"},"info":{"title":"Notification API","description":"Notification API","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"1.1.0"},"postman":{"name":"get Quality Notification","description":{"content":"Resolves a quality notification","type":"text/plain"},"url":{"path":["qualitynotifications","resolve"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Traceability Kit/Software Development View/Notification API/notification-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getQualityNotification - - - -Resolves a quality notification - -
Request Body
- -Quality notification was resolved successfully - -
Schema
- -Request body was malformed - -
- -Not authorized - -
- -Forbidden - -
- -Could not resolve the quality notification, because a quality notification with that notificationId does not exist - -
- -Method not allowed - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Notification API/notification-api.info.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Notification API/notification-api.info.mdx deleted file mode 100644 index e5c5a6a50f4..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Notification API/notification-api.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: notification-api -title: "Notification API" -description: "Notification API" -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: 1.1.0 - -# Notification API - - - -Notification API - - - \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Notification API/receive-quality-notification.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Notification API/receive-quality-notification.api.mdx deleted file mode 100644 index f52262f0055..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Notification API/receive-quality-notification.api.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: receive-quality-notification -title: "receiveQualityNotification" -description: "Receives a new quality notification" -sidebar_label: "receiveQualityNotification" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Quality notification"],"description":"Receives a new quality notification","operationId":"receiveQualityNotification","requestBody":{"content":{"application/json":{"schema":{"required":["header","content"],"type":"object","properties":{"header":{"type":"object","required":["notificationId","senderBPN","senderAddress","recipientBPN","classification","severity","status","messageId"],"properties":{"notificationId":{"type":"string","format":"uuid","example":"a7954026-3aff-4b6c-92bf-04671ef2fa46","description":"A UUIDv4 to uniquely identify a quality notification."},"senderBPN":{"type":"string","example":"BPNL00000003BW3S","description":"The business partner number (BPN) of the sender."},"senderAddress":{"type":"string","format":"uri","example":"https://edc.company-xyz.io/BPNL00000003BW3S","description":"The Eclipse Dataspace Connector (EDC) URL of the sender."},"recipientBPN":{"type":"string","example":"BPNL00000003BV4H","description":"The business partner number (BPN) of the receiver."},"classification":{"type":"string","enum":["QM-Investigation","QM-Alert"],"example":"QM-Investigation","description":"The classification defines the type of quality notification."},"severity":{"type":"string","enum":["MINOR","MAJOR","CRITICAL","LIFE-THREATENING"],"example":"CRITICAL","description":"The severity of the quality notification describes its criticality."},"relatedNotificationId":{"type":"string","format":"uuid","example":"7895a39d-c4ef-4b75-b39f-cae8207a262f","description":"A UUIDv4 to uniquely identify a related quality notification."},"status":{"type":"string","enum":["CREATED","SENT","RECEIVED","ACKNOWLEDGED","ACCEPTED","DECLINED","CLOSED"],"example":"SENT","description":"The status of the quality notification."},"targetDate":{"type":"string","format":"date-time","example":"2022-07-28T14:41:13.214Z","description":"The date and time when a processing of the notification is expected by the sender."},"messageId":{"type":"string","format":"uuid","example":"c2801472-5f87-41a7-9a25-b0939c4e0dff","description":"A UUIDv4 to uniquely identify an individual quality notification message. In case of an initial sending of a notification the messageId has to be a newly generated UUIDv4."}}},"content":{"type":"object","required":["listOfAffectedItems"],"properties":{"information":{"type":"string","maxLength":1000,"example":"Gear boxes loose oil while driving."},"listOfAffectedItems":{"type":"array","items":{"type":"string"},"example":["urn:uuid:57e4e3c1-a6f0-46a0-90df-1fb17cbc157d","urn:uuid:e4da568b-8cf1-4f5f-a96a-cf26265b2c72"]}}}}}}}},"responses":{"201":{"description":"Quality notification was received successfully"},"400":{"description":"Request body was malformed"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"405":{"description":"Method not allowed"},"409":{"description":"Could not accept the send quality notification, because a quality notification with that notificationId already exists"},"422":{"description":"Could not accept the send quality notification even though it is syntactically correct. The quality notification is not accepted, because of semantic reasons (e.g., an affected item is not known by the receiver)."}},"method":"post","path":"/qualitynotifications/receive","servers":[{"url":"/"}],"jsonRequestBodyExample":{"header":{"notificationId":"a7954026-3aff-4b6c-92bf-04671ef2fa46","senderBPN":"BPNL00000003BW3S","senderAddress":"https://edc.company-xyz.io/BPNL00000003BW3S","recipientBPN":"BPNL00000003BV4H","classification":"QM-Investigation","severity":"CRITICAL","relatedNotificationId":"7895a39d-c4ef-4b75-b39f-cae8207a262f","status":"SENT","targetDate":"2022-07-28T14:41:13.214Z","messageId":"c2801472-5f87-41a7-9a25-b0939c4e0dff"},"content":{"information":"Gear boxes loose oil while driving.","listOfAffectedItems":["urn:uuid:57e4e3c1-a6f0-46a0-90df-1fb17cbc157d","urn:uuid:e4da568b-8cf1-4f5f-a96a-cf26265b2c72"]}},"info":{"title":"Notification API","description":"Notification API","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"1.1.0"},"postman":{"name":"receive Quality Notification","description":{"content":"Receives a new quality notification","type":"text/plain"},"url":{"path":["qualitynotifications","receive"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Traceability Kit/Software Development View/Notification API/notification-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## receiveQualityNotification - - - -Receives a new quality notification - -
Request Body
    header object required
    content object required
- -Quality notification was received successfully - -
- -Request body was malformed - -
- -Not authorized - -
- -Forbidden - -
- -Method not allowed - -
- -Could not accept the send quality notification, because a quality notification with that notificationId already exists - -
- -Could not accept the send quality notification even though it is syntactically correct. The quality notification is not accepted, because of semantic reasons (e.g., an affected item is not known by the receiver). - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Notification API/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Notification API/sidebar.js deleted file mode 100644 index 27414ca3715..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Notification API/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Traceability Kit/Software Development View/Notification API/notification-api"},{"type":"category","label":"Quality notification","link":{"type":"generated-index","title":"Quality notification","slug":"/category/kits/Traceability Kit/Software Development View/Notification API/quality-notification"},"items":[{"type":"doc","id":"kits/Traceability Kit/Software Development View/Notification API/receive-quality-notification","label":"receiveQualityNotification","className":"api-method post"},{"type":"doc","id":"kits/Traceability Kit/Software Development View/Notification API/update-quality-notification","label":"updateQualityNotification","className":"api-method post"},{"type":"doc","id":"kits/Traceability Kit/Software Development View/Notification API/get-quality-notification","label":"getQualityNotification","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Notification API/update-quality-notification.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Notification API/update-quality-notification.api.mdx deleted file mode 100644 index 6c1a5d53fe7..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Notification API/update-quality-notification.api.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: update-quality-notification -title: "updateQualityNotification" -description: "Updates a quality notification" -sidebar_label: "updateQualityNotification" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Quality notification"],"description":"Updates a quality notification","operationId":"updateQualityNotification","requestBody":{"content":{"application/json":{"schema":{"required":["header"],"type":"object","properties":{"header":{"type":"object","required":["notificationId","senderBPN","senderAddress","recipientBPN","status","messageId"],"properties":{"notificationId":{"type":"string","format":"uuid","example":"a7954026-3aff-4b6c-92bf-04671ef2fa46","description":"A UUIDv4 to uniquely identify a quality notification. Actually, this value cannot be updated. Rather, it is used to do a plausibility check."},"senderBPN":{"type":"string","example":"BPNL00000003BW3S","description":"The business partner number (BPN) of the sender. Actually, this value cannot be updated. Rather, it is used to do a plausibility check."},"senderAddress":{"type":"string","format":"uri","example":"https://edc.company-xyz.io/BPNL00000003BW3S","description":"The Eclipse Dataspace Connector (EDC) URL of the sender. Actually, this value cannot be updated. Rather, it is used to do a plausibility check."},"recipientBPN":{"type":"string","example":"BPNL00000003BV4H","description":"The business partner number (BPN) of the receiver. Actually, this value cannot be updated. Rather, it is used to do a plausibility check."},"severity":{"type":"string","enum":["MINOR","MAJOR","CRITICAL","LIFE-THREATENING"],"example":"CRITICAL","description":"The severity of the quality notification describes its criticality."},"status":{"type":"string","enum":["CREATED","SENT","RECEIVED","ACKNOWLEDGED","ACCEPTED","DECLINED","CLOSED"],"example":"SENT","description":"The status of the quality notification."},"targetDate":{"type":"string","format":"date-time","example":"2022-07-28T14:41:13.214Z","description":"The date and time when a processing of the notification is expected by the sender."},"messageId":{"type":"string","format":"uuid","example":"c2801472-5f87-41a7-9a25-b0939c4e0dff","description":"A UUIDv4 to uniquely identify an individual quality notification message. In case of an update of a notification the messageId must be a newly generated UUIDv4. It must not be an existing messageId."}}},"content":{"type":"object","properties":{"information":{"type":"string","maxLength":1000,"example":"Gear boxes loose oil while driving."}}}}}}}},"responses":{"200":{"description":"Quality notification was updated successfully"},"400":{"description":"Request body was malformed"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"404":{"description":"Could not update the quality notification, because a quality notification with that notificationId does not exist"},"405":{"description":"Method not allowed"},"422":{"description":"Could not update the quality notification even though the request is syntactically correct. The quality notification update is not accepted, because of semantic reasons (e.g., status cannot be changed)."}},"method":"post","path":"/qualitynotifications/update","servers":[{"url":"/"}],"jsonRequestBodyExample":{"header":{"notificationId":"a7954026-3aff-4b6c-92bf-04671ef2fa46","senderBPN":"BPNL00000003BW3S","senderAddress":"https://edc.company-xyz.io/BPNL00000003BW3S","recipientBPN":"BPNL00000003BV4H","severity":"CRITICAL","status":"SENT","targetDate":"2022-07-28T14:41:13.214Z","messageId":"c2801472-5f87-41a7-9a25-b0939c4e0dff"},"content":{"information":"Gear boxes loose oil while driving."}},"info":{"title":"Notification API","description":"Notification API","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"1.1.0"},"postman":{"name":"update Quality Notification","description":{"content":"Updates a quality notification","type":"text/plain"},"url":{"path":["qualitynotifications","update"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Traceability Kit/Software Development View/Notification API/notification-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## updateQualityNotification - - - -Updates a quality notification - -
Request Body
    header object required
    content object
- -Quality notification was updated successfully - -
- -Request body was malformed - -
- -Not authorized - -
- -Forbidden - -
- -Could not update the quality notification, because a quality notification with that notificationId does not exist - -
- -Method not allowed - -
- -Could not update the quality notification even though the request is syntactically correct. The quality notification update is not accepted, because of semantic reasons (e.g., status cannot be changed). - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Unique ID Push API/receive-unique-id-push-notification.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Unique ID Push API/receive-unique-id-push-notification.api.mdx deleted file mode 100644 index 3e94a998ff4..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Unique ID Push API/receive-unique-id-push-notification.api.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: receive-unique-id-push-notification -title: "receiveUniqueIdPushNotification" -description: "Receives a Traceability Unique Id push notification" -sidebar_label: "receiveUniqueIdPushNotification" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Unique ID Push Notification"],"description":"Receives a Traceability Unique Id push notification","operationId":"receiveUniqueIdPushNotification","requestBody":{"content":{"application/json":{"schema":{"required":["header","content"],"type":"object","properties":{"header":{"type":"object","required":["notificationId","senderBPN","senderAddress","recipientBPN","classification"],"properties":{"notificationId":{"type":"string","format":"uuid","example":"a7954026-3aff-4b6c-92bf-04671ef2fa46","description":"A UUIDv4 to uniquely identify a Unique ID push notification."},"senderBPN":{"type":"string","example":"BPNL00000003BW3S","description":"The business partner number (BPN) of the sender."},"senderAddress":{"type":"string","format":"uri","example":"https://edc.company-xyz.io/BPNL00000003BW3S","description":"The Eclipse Dataspace Connector (EDC) URL of the sender."},"recipientBPN":{"type":"string","example":"BPNL00000003BV4H","description":"The business partner number (BPN) of the receiver."},"classification":{"type":"string","enum":["Child-Relationship"],"example":"Child-Relationship","description":"The classification defines the type of the Unique ID push notification."}}},"content":{"type":"object","required":["listOfItems"],"properties":{"information":{"type":"string","maxLength":1000,"example":"Update of serialized parts and batches for which digital twins were created."},"listOfItems":{"type":"array","items":{"oneOf":[{"type":"object","required":["manufacturerId","manufacturerPartId","partInstanceId","catenaxId"],"properties":{"manufacturerId":{"type":"string","example":"BPNL00000003BW3S","description":"The Business Partner Number (BPNL) of the manufacturer of the serialized part, i.e., the companies main entry."},"manufacturerPartId":{"type":"string","example":"8840838-04","description":"The ID of the type/catalog part (of which the serialized part is an instance of) from the manufacturer."},"customerPartId":{"type":"string","example":"AAX178378","description":"The ID of the type/catalog part (of which the serialized part is an instance of) from the customer."},"partInstanceId":{"type":"string","example":"NO-009284492099792129568369","description":"The serial number of the serialized part from the manufacturer. We assume here that the customer does not have or create its own serial number for a part, but just used the manufacturer's serial number."},"catenaxId":{"type":"string","example":"urn:uuid:d32d3b55-d222-41e9-8d19-554af53124dd","description":"Catena-X ID for a serialized part."}}},{"type":"object","required":["manufacturerId","manufacturerPartId","batchId","catenaxId"],"properties":{"manufacturerId":{"type":"string","example":"BPNL00000003BW3S","description":"The Business Partner Number (BPNL) of the manufacturer of the batch, i.e., the companies main entry."},"manufacturerPartId":{"type":"string","example":"8840838-04","description":"The ID of the type/catalog part (of which the batch is an instance of) from the manufacturer."},"customerPartId":{"type":"string","example":"AAX178378","description":"The ID of the type/catalog part (of which the batch is an instance of) from the customer."},"batchId":{"type":"string","example":"NO-009284492099792129568369","description":"The serial number of the batch from the manufacturer. We assume here that the customer does not have or create its own serial number for a batch, but just used the manufacturer's serial number."},"catenaxId":{"type":"string","example":"urn:uuid:d32d3b55-d222-41e9-8d19-554af53124dd","description":"Catena-X ID for a batch."}}}]}}}}}}}}},"responses":{"201":{"description":"Notification was received successfully"},"400":{"description":"Request body was malformed"},"401":{"description":"Not authorized"},"403":{"description":"Forbidden"},"405":{"description":"Method not allowed"},"409":{"description":"Could not accept the send notification, because a notification with that notificationId already exists"},"422":{"description":"Could not accept the send notification even though it is syntactically correct. The notification is not accepted, because of semantic reasons (e.g., an item is not known by the receiver)."}},"method":"post","path":"/uniqueidpush/receive","servers":[{"url":"/"}],"jsonRequestBodyExample":{"header":{"notificationId":"a7954026-3aff-4b6c-92bf-04671ef2fa46","senderBPN":"BPNL00000003BW3S","senderAddress":"https://edc.company-xyz.io/BPNL00000003BW3S","recipientBPN":"BPNL00000003BV4H","classification":"Child-Relationship"},"content":{"information":"Update of serialized parts and batches for which digital twins were created.","listOfItems":[{"manufacturerId":"BPNL00000003BW3S","manufacturerPartId":"8840838-04","customerPartId":"AAX178378","partInstanceId":"NO-009284492099792129568369","catenaxId":"urn:uuid:d32d3b55-d222-41e9-8d19-554af53124dd"},{"manufacturerId":"BPNL00000003BW3S","manufacturerPartId":"8840838-04","customerPartId":"AAX178378","batchId":"NO-009284492099792129568369","catenaxId":"urn:uuid:d32d3b55-d222-41e9-8d19-554af53124dd"}]}},"info":{"title":"Unique ID Push Notification API","description":"API documentation for Traceability Unique ID Push Notifications","license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"1.0.0"},"postman":{"name":"receive Unique Id Push Notification","description":{"content":"Receives a Traceability Unique Id push notification","type":"text/plain"},"url":{"path":["uniqueidpush","receive"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Traceability Kit/Software Development View/Unique ID Push API/unique-id-push-notification-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## receiveUniqueIdPushNotification - - - -Receives a Traceability Unique Id push notification - -
Request Body
    header object required
    content object required
    listOfItems object[] required
    oneOf
- -Notification was received successfully - -
- -Request body was malformed - -
- -Not authorized - -
- -Forbidden - -
- -Method not allowed - -
- -Could not accept the send notification, because a notification with that notificationId already exists - -
- -Could not accept the send notification even though it is syntactically correct. The notification is not accepted, because of semantic reasons (e.g., an item is not known by the receiver). - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Unique ID Push API/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Unique ID Push API/sidebar.js deleted file mode 100644 index e91341315cc..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Unique ID Push API/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Traceability Kit/Software Development View/Unique ID Push API/unique-id-push-notification-api"},{"type":"category","label":"Unique ID Push Notification","link":{"type":"generated-index","title":"Unique ID Push Notification","slug":"/category/kits/Traceability Kit/Software Development View/Unique ID Push API/unique-id-push-notification"},"items":[{"type":"doc","id":"kits/Traceability Kit/Software Development View/Unique ID Push API/receive-unique-id-push-notification","label":"receiveUniqueIdPushNotification","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Unique ID Push API/unique-id-push-notification-api.info.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Unique ID Push API/unique-id-push-notification-api.info.mdx deleted file mode 100644 index 2bca1c1059e..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/Unique ID Push API/unique-id-push-notification-api.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: unique-id-push-notification-api -title: "Unique ID Push Notification API" -description: "API documentation for Traceability Unique ID Push Notifications" -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: 1.0.0 - -# Unique ID Push Notification API - - - -API documentation for Traceability Unique ID Push Notifications - - - \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/_category_.json b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/_category_.json deleted file mode 100644 index e5c5b7565a3..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Development View" -} diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/page_software-development-view.md deleted file mode 100644 index 74a8f4a47ee..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/Software Development View/page_software-development-view.md +++ /dev/null @@ -1,719 +0,0 @@ ---- -id: Specification Traceability Kit -title: Specification -description: 'Traceability Kit' -sidebar_position: 4 ---- - -![Traceability kit banner](@site/static/img/doc-traceability_header-minified.png) - -### Traceability KIT - - - - -## API Specifications - -### Unique ID Push Notifications - -Unique ID Push notifications are a way for a manufacturer to notify a customer as soon as possible when a new digital twin for a part is available. The solution is based on notification assets in the EDC (which is the same approach that is used for quality alerts & investigations). The customer creates a notification asset in the EDC and the customer's suppliers send their notifications (with the Unique Id) to this notification asset. Details can be found in section [Unique ID Push Notifications](#unique-id-push-notifications-1). - -All endpoints as well as the schema of the notification below are described in detail in the [Unique ID Push API documentation](Unique%20ID%20Push%20API/unique-id-push-notification-api). - -### Traceability Data Offers at EDC - -[Publish Traceability Data Offers at EDC](#publish-traceability-data-offers-at-edc) - - -## Sample Data - -In the following, example data for submodels are provided. - -### As Planned Submodels Sample Data - -#### Submodel "PartAsPlanned" for a Catalog Part - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.part_as_planned/1.0.1](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.part_as_planned/1.0.1) - -```json -{ - "partTypeInformation": { - "classification": "component", - "manufacturerPartId": "123-0.740-3434-A", - "nameAtManufacturer": "Mirror left" - }, - "validityPeriod": { - "validFrom": "2021-06-14T06:55:29.935Z", - "validTo": "2022-06-14T06:55:29.935Z" - }, - "catenaXId": "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379" -} -``` - -#### Submodel "SingleLevelBomAsPlanned" for a Catalog Part - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_planned/1.1.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_planned/1.1.0) - -```json -{ - "catenaXId": "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d", - "childParts": [ - { - "quantity": { - "quantityNumber": 2.5, - "measurementUnit": "unit:litre" - }, - "createdOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:5daB938E-Cafa-92B3-7ca1-9aD7885e9dC8" - } - ] -} -``` - -#### Submodel SingleLevelUsageAsPlanned for a Catalog Part - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_usage_as_planned/1.1.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_usage_as_planned/1.1.0) - -```json -{ - "parentParts": [ - { - "parentCatenaXId": "urn:uuid:c8B01D5A-ce0B-6Dd4-5bA0-A3e3fcE9cA93", - "quantity": { - "quantityNumber": 2.5, - "measurementUnit": "unit:litre" - }, - "createdOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z" - } - ], - "catenaXId": "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d" -} -``` - -#### Submodel "PartSiteInformationAsPlanned" for a component that is produced at the given site - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.part_site_information_as_planned/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.part_site_information_as_planned/1.0.0) - -```json -{ - "catenaXId": "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379", - "sites": [ - { - "catenaXSiteId": "BPNS1234567890ZZ", - "functionValidUntil": "2025-11-21T11:14:30.825+01:00", - "function": "production", - "functionValidFrom": "2022-11-21T11:14:30.825+01:00" - } - ] -} -``` - -### As Built Submodels Sample Data - -#### Submodel SerialPartTypization - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.serial_part_typization/1.1.1](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.serial_part_typization/1.1.1) - -##### Submodel "SerialPartTypization" for a Vehicle - -```json -{ - "localIdentifiers": [ - { - "key": "manufacturerId", - "value": "BPNL7588787849VQ" - }, - { - "key": "partInstanceId", - "value": "OEM-A-F8LM95T92WJ9KNDD3HA5P" - }, - { - "key": "van", - "value": "OEM-A-F8LM95T92WJ9KNDD3HA5P" - } - ], - "manufacturingInformation": { - "date": "2022-02-04T14:48:54", - "country": "DEU" - }, - "catenaXId": "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379", - "partTypeInformation": { - "manufacturerPartID": "QX-39", - "classification": "product", - "nameAtManufacturer": "Vehicle Model A" - } -} -``` - -##### Submodel "SerialPartTypization" for a Serialized Part (Non-Vehicle) - -```json -{ - "localIdentifiers": [ - { - "key": "manufacturerId", - "value": "BPNL7588787849VQ" - }, - { - "key": "manufacturerPartId", - "value": "95657362-83" - }, - { - "key": "partInstanceId", - "value": "NO-574868639429552535768526" - } - ], - "manufacturingInformation": { - "date": "2022-02-04T14:48:54", - "country": "DEU" - }, - "catenaXId": "urn:uuid:d60b99b0-f269-42f5-94d0-64fe0946ed04", - "partTypeInformation": { - "manufacturerPartID": "95657362-83", - "customerPartId": "798-515297795-A", - "classification": "component", - "nameAtManufacturer": "High Voltage Battery", - "nameAtCustomer": "High Voltage Battery" - } -} -``` - -#### Submodel AssemblyPartRelationship - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.assembly_part_relationship/1.1.1](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.assembly_part_relationship/1.1.1) - -##### Submodel "AssemblyPartRelationship" for a Serialized Part - -```json -{ - "catenaXId": "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379", - "childParts": [ - { - "lifecycleContext": "AsBuilt", - "quantity": { - "quantityNumber": 1.0, - "measurementUnit": "unit:piece" - }, - "createdOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:d60b99b0-f269-42f5-94d0-64fe0946ed04" - } - ] -} -``` - -##### Submodel "AssemblyPartRelationship" for a Batch - -```json -{ - "catenaXId": "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379", - "childParts": [ - { - "lifecycleContext": "AsBuilt", - "quantity": { - "quantityNumber": 25.0, - "measurementUnit": "unit:kilogram" - }, - "createdOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:d60b99b0-f269-42f5-94d0-64fe0946ed04" - } - ] -} -``` - -#### Submodel Batch - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.batch/1.0.2](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.batch/1.0.2) - -##### Submodel "Batch" for a Batch of Raw Material - -```json -{ - "localIdentifiers": [ - { - "value": "BID12345678", - "key": "batchId" - } - ], - "manufacturingInformation": { - "date": "2022-02-04T14:48:54", - "country": "HUR" - }, - "catenaXId": "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379", - "partTypeInformation": { - "manufacturerPartId": "123-0.740-3434-A", - "customerPartId": "PRT-12345", - "classification": "product", - "nameAtManufacturer": "PA66-GF30", - "nameAtCustomer": "Polyamide" - } -} -``` - -#### Submodel JustInSequencePart - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.just_in_sequence_part/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.just_in_sequence_part/1.0.0) - -##### Submodel "JustInSequencePart" for a non-serialized component - -```json -{ - "localIdentifiers": [ - { - "key": "manufacturerId", - "value": "BPNL7588787849VQ" - }, - { - "key": "jisNumber", - "value": "894651684" - }, - { - "key": "parentOrderNumber", - "value": "OEM-A-F8LM95T92WJ9KNDD3HA5P" - }, - { - "key": "jisCallDate", - "value": "2022-01-24T09:13:34" - } - ], - "manufacturingInformation": { - "date": "2022-02-04T14:48:54", - "country": "DEU" - }, - "catenaXId": "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379", - "partTypeInformation": { - "manufacturerPartID": "84816168424", - "classification": "product", - "nameAtManufacturer": "Black Leather Front Row Seat for Vehicle Model B" - } -} -``` - -> Please note that if a just-in-sequence part is also a serialized part SerialPartTypization should be used instead. - - -## Reference Implementation - -For a reference implementation, take a look at the open-source Trace-X app. More information are provided in the [Operation View](../page_software-operation-view.md) section. - - -## Documentation in the Context of Development - -### Data Provisioning - -The following diagram shows a basic data processing flow how a comany's internal data can be transformed into a Traceability-compliant format. It depicts the necessary steps as well as where communication with other services, e.g., Catena-X network services like the Digital TWin Registry, are necessary. Any implementation of this implementation specification can deviate from this basic flow as it's just one way to do it. But it should give a basic idea what the essential steps are. - -![Basic Data FLow](../assets/data_provisioning_data_flow.png) - -#### Register Digital Twins for Traceability - -In Traceability, digital twins for different types of parts are registered at the digital twin registry, e. g. serialized parts, batches, JIS parts or catalog parts. - -> :raised_hand: **Unique ID Push** -Once a digital twin was created, optionally a Unique ID Push notification can be send to the customer of the part of batch to inform them that a new digital twin is available. - -The following general conventions apply for all these digital twins: - -- identification: The AAS ID must be a UUIDv4 in URN format: `urn:uuid:` -- globalAssetId: The Unique ID of the real-world part for which a digital twin is created. - -> :warning: The AAS ID is not the same id as the Catena-X Unique ID, although they have the same format (UUID) and therefore look the same. A Unique ID identifies real-world parts, whereas a AAS ID identifies a digital twin of such a part. So, don't use the same value for Unique ID and AAS ID. - -##### Property specificAssetIds - -For Traceability, we define some specificAssetIds as mandatory. Mandatory specific asset IDs are used to lookup or search for digital twins. This is a required step by a customer of a part to connect the digital twins of their parts with the digital twins of the suppliers' child parts. To a customer, only the information printed on a real-world part is available and can be used for the lookup. Mandatory specific asset IDs ensure that at least this information is available for the digital twin. - -The following conventions for specificAssetIds apply to all digital twins: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key Availability Description Type
manufacturerId Mandatory The Business Partner Number (BPNL) of the manufacturer of the part. BPNL
manufacturerPartId Mandatory The ID of the type/catalog part from the manufacturer. String
customerPartId Optional The ID of the type/catalog part from the customer.
The main reason why this propertiy is optional is that it cannot be guaranteed that every manufacturer knows the customerPartId for their parts. If known, it is recommended to always add the customerPartId for easier lookup.
- If a part has multiple customers, e.g., for batches or catalog parts, multiple customerPartIds can be added. BPN-based access control can be applied to customerPartIds to restrict visiblility.
- Each company that shall have access to a specific customerPartId must be provided as externalSubjectId using its BPN.
- Access to customerPartId only for BPNL1234: - -```json -{ - "key": "customerPartId", - "value": "39192", - "externalSubjectId": "BPNL1234" -} -``` - -In case multiple companies shall have access, each company must be provided in a triple consisting of key, value and externalSubjectId. -If no access control shall be applied, externalSubjectId must be omitted (no access control for `customerPartId`): - -```json -{ - "key": "customerPartId", - "value": "39192" -} -``` - - 		String
assetLifecyclePhase Optional The lifecycle phase of the asset.
  • For serialized parts, batches, and JIS parts, use the value "AsBuilt".
  • For catalog parts, use the value "AsPlanned".
 Enum
- -**For serialized parts, additionally the following conventions apply:** - -| Key | Availability | Description | Type | -|:---------------|:-------------|:---------------------------------------------------------------------------------------------|:-------| -| partInstanceId | Mandatory | The serial number of the part from the manufacturer. | String | -| van | Optional | **Only for vehicles:** The pseudonymized vehicle identification number (VIN) of the vehicle. | String | - -**For batches, additionally the following conventions apply:** - -| Key | Availability | Description | Type | -|:---------------|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------| -| batchId | Optional | The number of the batch from the manufacturer. | String | -| partInstanceId | Mandatory | Also the number of the batch from the manufacturer.

For **Release 3.0**, we also use the batch number as partInstanceId. This makes looking up digital twins for serialized parts and batches easier as a data consumer only has to specify the partInstanceId no matter if they are looking up a serialized part or a batch. Otherwise, the data consumer would need to know for what type of digital twin it is looking for or it would have to look for both until a match is found. | String | - -**For just-in-sequence (JIS) parts, additionally the following conventions apply:** - -| Key | Availability | Description | Type | -|:-------------------|:-------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------| -| parentOrderNumber | Optional | A number identifying the just-in-sequence- part's destination parent part. The parent part is typically known upfront to the supplier for just-in-sequence parts. | String | -| jisNumber | Mandatory | A number that is used to identify the call-off that can be assumed unique within the specific just-in-sequence process. This is typically not the sequence number, but the call-off number. | String | -| jisCallDate | Optional | The date of the just-in-sequence call-off as stated on the call-off document itself.
The value must be compliant to ISO 8601: `YYYY-MM-DD` or `YYYY-MM-DDThh:mm:ss` or `YYYY-MM-DDThh:mm:ss±hh:mm` | Date | -| partInstanceId | Mandatory | A composition of `jisNumber`, `parentOrderNumber` (if available), `jisCallDate` (ifavailable). This information is typically known upfront to the supplier `jisNumber`, `partOrderNumber` and `jisCallDate` for just-in-sequence parts. | String | - -> :raised_hand: **Lookup of Digital Twins** -The lookup for parts can use the customerPartId or the manufacturerPartId. Both, manufacturer and customer must agree upon what part id will be used for the lookup. Otherwise, when the customer would use the customerPartId for the lookup, but the manufacturer would only provide the manufacturerPartId in its digital twins, the lookup would fail every time. **This is decision that a customer must agree upon with each of their suppliers individually.** - -##### Submodel Descriptors - -The following general conventions apply for all submodel descriptors: - -- `identification`: The submodel ID must be a UUIDv4 in URN format: "urn:uuid:<UUIDv4>" -- `idShort`: The name of the aspect model in camel case, e.g. for aspect SerialPartTypization: "serialPartTypization". -- `endpoints`: For access of submodels via EDC and AAS a new interface type EDC-AAS must be defined. - - `interface`: The value must be "EDC" - - `endpointAddress`: The endpoint address must have the following format: `http://provider.controlplane:port//submodel?content=value&extent=WithBLOBValue` - - `provider.controlplane:port`: server and port of the EDC that is providing the submodel - - `EDC Asset ID`: The EDC asset id under which the submodel was registered in the EDC. It must have the following format `-` - - `AAS ID`: The id of the digital twin (identification property in the AAS descriptor) - - `Submodel`: The id of the submodel (identification property in the submodel descriptor) - - `/submodel`: This method from the AAS Shell Interface that is invoked via the EDC. - - `content=value&extent=WithBLOBValue`: This are currently required parameters when requesting payload via the AAS standard from an EDC - - `endpointProtocol`: The value must be `IDS/ECLIPSE DATASPACE CONNECTOR` - - `endpointProtocolVersion`: The value must be `0.0.1-SNAPSHOT` - -> :raised_hand: **AAS Submodel Descriptor Endpoints** -The endpoint (endpointAddress) in the submodel descriptor cannot be used directly to contact the EDC and access the data. The endpoint has to be re-written as it combines EDC and AAS information. The AAS API Wrapper does that automatically when using it, i.e., it fetches the endpoint from the AAS Registry and re-writes it in a way to a Catena-X EDC with an AAS server in the background can process the query. - -#### Lookup for Digital Twins in the Digital Twin Registry - -For a data provider, there are currently the following steps where they have to lookup digital twins of other partners in the Catena-X network. - -- The data provider must use the local IDs for a serialized part or batch (manufacturer, part number, serial or batch number) and for a just-in-sequence part (manufacturer, parentOrderNumber, jisNumber, jisCallDate) to lookup the AAS ID of the digital twin of this serialized part, batch or just-in-sequence part. The AAS descriptor with this ID contains the Unique ID of the serialized part, batch or just-in-sequence (as globalAssetId) that is used to create the AssembyPartRelationship submodel. - -- The data provider must use the local IDs for a catalog part (manufacturer, part number) to lookup the AAS ID of the digital twin of this catalog part. The AAS descriptor with this ID contains the Unique ID of the catalog part (as globalAssetId) that is used to create the SingleLevelBoMAsPlanned submodel. - -For a data consumer, there are currently the following steps where they have to lookup digital twins of other partners in the Catena-X network. - -- The data consumer in the Traceability use case in most cases will use the Unique ID of a part to lookup the digital twin (more precisely, its AAS ID) of this part. -- The data consumer from another use case (e.g., Circular Economy), might either use the Unique ID of a part (if known) or the local IDs of a part to lookup the part's digital twin (AAS ID) depending on what is available in the use case. - -##### Lookup up a Digital Twin with Local IDs - -The local IDs of a serialized part (manufacturer, part number, serial number) are stored as specificAssetIds in the AAS descriptor of the digital twin. From the Digital Twin Registry API, the following function can be used for this lookup `GET /lookup/shells`. - -All Asset identifier key-value-pairs used as parameter to this lookup function are combined using AND. An example query would look like this: `https://URL/registry/lookup/shells?assetIds=%5B%7B%22key%22%3A%20%22manufacturerId%22,%22value%22%3A%20%22BPNL7588787849VQ%22%7D,%7B%22key%22%3A%20%22manufacturerPartId%22,%22value%22%3A%20%2295657362-83%22%7D,%7B%22key%22%3A%20%22partInstanceId%22,%22value%22%3A%20%22NO-574868639429552535768526%22%7D%5D` - -**The assetIds value looks like this unencoded (but with additional spaces and linebreaks):** - -```json -[ - { - "key": "manufacturerId", - "value": "BPNL7588787849VQ" - }, - { - "key": "manufacturerPartId", - "value": "95657362-83" - }, - { - "key": "partInstanceId", - "value": "NO-574868639429552535768526" - } -] -``` - -The lookup (for serialized parts/batches as well as catalog parts) can use the customer or the manufacturer part id (manufacturerPartId or manufacturerPartId). - -- For a digital twin, adding the customer part id to the specificAssetId property is optional (see (TRS) Create Digital Twins for Serialized Parts and Batches incl. Submodels). The main reason for this is that it cannot be guaranteed that every manufacturer knows the customer part id for their parts. But, if they know it, it is recommended to always add the customer part id to the specifiAssetId property for easier lookup (by customers). -- A customer that wants to do a lookup for a supplier's digital twin, must first decide what id they want to use for the lookup. This depends on the information that is available to them. - - If the customer knows the manufacturer part id, they should use the manufacturer part id for the lookup as the manufacturer part id is guaranteed to be available in the digital twin (as the manufacturer part id is a mandatory property). - - If the customer does not know the manufacturer part id, they must use the customer part id (i.e., their own part id). In that case they must make sure that their suppliers register their digital twins with this information (as the customer part id is optional) as part of the specificAssetId property. This is decision that a customer must agree upon with each of their suppliers individually. - -As a result, the AAS ID of the digital twin with this local IDs is returned. The AAS ID can then be used to retrieve details about the digital twin, i.e. the digital twin's AAS descriptor including submodel descriptors. - -**Example result for looking up a digital twin with local IDs:** - -```json -[ - "urn:uuid:c227a880-b82b-40f7-846c-3942ddf26c29" -] -```` - -Note that this query can return more than one AAS ID depending on the local IDs uniquely identifying a digital twin or not. - -For Release 3.0, even if more than one digital twin is returned in a lookup, these digital twins should have different submodels assigned to them. These submodels should be disjunct and not overlap. This means that you can use the submodel to filter out the correct digital twin. - -- If there are returned more than one digital twin with the same submodel (based on their semanticId), this is considered an error. Processing should be canceled and an error message should be reported. - -The next section describes to to modify the lookup to additionally restrict the results to digital twins with a specific submodel type based on it's semanticId. - -#### Unique ID Push Notifications - -Unique ID Push notifications are a way for a manufacturer to notify a customer as soon as possible when a new digital twin for a part is available. - -The solution is based on notification assets in the EDC (which is the same approach that is used for quality alerts & investigations). The customer creates a notification asset in the EDC and the customer's suppliers send their notifications (with the Unique Id) to this notification asset. As this notification asset is a general EDC asset - as for all EDC assets - access policies, usage policies and contract definitions must be created. - -> :raised_hand: It is important to understand that the customer (receiver) creates EDC asset and policies, and thus, the supplier (sender) of the Unique ID push notification must check during the EDC negotiation process if the conditions the receiver offers are acceptable for the sender. - -##### Prerequisites and Constraints - -In order to be able to push Unique ID(s) of part(s) to the correct partner, it is required that the data provider (manufacturer) pushing the Unique IDs is aware of the BPN of the actual receiver of the part (i.e., the customer) or has enough data in its context to use BPDM functions to determine the BPN Number of the receiver. - -For actively pushing Unique IDs, an EDC is required and the data provider needs to be enabled to execute the complete process including EDC communication and HTTP Push (i.e., HTTP POST) of the payload. - -Secondly, EDCs are being used for the exchange and it is currently required to offer a HTTP POST API to receive the Unique IDs push at the receiver's side. This API needs to be registered in the EDC Catalog as a data offer and requires specific properties to be set to standardized values, as this allows discover-ability. Details still tbd. - -##### Unique ID Push Process Overview - -How the actual process is triggered is application specific. It is recommended to to trigger the push of Unique IDs towards the customer after the Goods Issue has been booked, since commonly at that point the serial numbers/batch numbers of the parts being delivered are fixed in the logistics process and shall be contained in delivery documents, EDI Messages and/or any internal representation of the received items (non-Catena-X communication). - -The Unique ID push is initiated by the supplier (acting as sender) towards their customer (acting as receiver). Since the Unique ID of the asset (i.e., serial unit / batch) is unknown in the logistics process, the message needs to include local identifiers to be matched towards the information from the delivery documents and furthermore the internal data of the recipient's traceability solution. - -Upon receipt of the message, the customer needs to match the local identifiers with its internal traceability records and attach each Unique ID to the respective data set. How this is done is depending on the customer's internal systems: - -- If there is an object for incoming deliveries, this event could be updated. - Alternatively, if only production events are tracked, the data could be integrated at this point into the data provisioning pipeline's data structure for consumed materials. -- In the end this enables the customer to integrate the child parts into the AssemblyPartRelationship aspect. - -In the end this enables the customer to integrate the child parts into the AssemblyPartRelationship aspect. - -![Unique ID Push Process](../assets/unique_id_push_process.png) - - - -##### Schema of Unique ID Push Notifications - -The notifications send to inform a customer about the creating of a new digital twin for one of the parts they received have a standardized format. - -All endpoints as well as the schema of the notification below are described in detail in the [Unique ID Push API documentation](Unique%20ID%20Push%20API/unique-id-push-notification-api). - -> Adding the customer part id to the notification is optional. The main reason for this is that it cannot be guaranteed that every manufacturer knows the customer part id for their parts. But, if they know it, it is recommended to always add the customer part id to the notification. - -##### Notification Receiver (Customer) - -Here is a short overview what the receiver has to do when they want to support Unique Id Push notifications. This is an optional feature. - -- The Receiver in this scenario is the customer of a part. -- The Receiver must create a EDC asset in their EDC that works as the endpoint for receiving notifications. Also, access & usage policies as described below must be configured. -- The EDC in which the notification EDC asset was created must be registered at the Discovery Service (so that the sender can find the partner's EDC which should receive notifications) -- When the Receiver receives a Unique Id Push notification, it must process this notification after it was received by the EDC (in a Backend Data Service) -- How the Receiver processes the notification is up to them, but the following steps are recommended: - - Verify the correctness of the data in the notification (i.e., the receiver is actually the customer of this part). - - Store the notification data for later. - - Use this data when the digital twin for the part into which the delivered part is built into is created instead of doing a lookup to the digital twin registry. - -###### EDC Asset - -The EDC asset can be created using the EDC Data Management API. The following conventions apply for the properties of this asset: - -```apacheconf -"asset:prop:id": "uniqueidpushnnotification-receipt" -"asset:prop:type": "notification.trace.uniqueidpush" -"asset:prop:notificationtype": "uniqueidpush" -"asset:prop:notificationmethod": "receive" -``` - -###### EDC Policies - -_More information about the Policies with detailed descriptions, payloads etc. are described on the [Adoption View](../page_adoption-view.md) page._ - -**Access Policies** -A data provider can decide on its own what access policies they want to define for their notification asset. Based on the purpose of the asset, all suppliers of the data provider should in general be allowed to send notifications to this asset. Therefore, either a public access policy or a BPN-based access policy (allowing all suppliers) should be used. - -**Usage Policies** -In general, a data provider is free to decide which usage policies to define for its assets. For notifications, though, the data provider is actually the receiver of notifications, i.e., the usage policy here has the purpose to define what the data provider does or is allowed to do with the notifications. It's something the sender of the notification has to rely on and accept when sending its notification. - -Keep in mind that usage policies currently aren't technically enforced by the EDC or other components. - -> :raised_hand: **Usage Policy for Unique ID Push** -The Unique ID push notification endpoints are protected with a purpose-based usage policy and "R3-1_UniqueIDPush" as purpose. - -###### Backend Data Service to Process Unique ID Push Notifications - -The receiver must setup a backend data service that provides an HTTP Endpoint for notifications. All endpoints as well as the schema of the notification below are described in detail in the [Unique ID Push API documentation](Unique%20ID%20Push%20API/unique-id-push-notification-api). - -##### Notification Sender (Manufacturer, Supplier) - -Here is a short overview what the sender has to do when they want to support Unique Id Push notifications. This is an optional feature. - -- The Sender in this scenario is the manufacturer or supplier of a part. -- When a new digital twin for a part was created, the manufacturer is responsible to send a Unique Id Push notification for this twin to the customer of this part. -- It is recommended to send this notification as soon as possible, i.e., directly after the digital twin was created. - -###### Mapping BPN to EDC URL with Discovery Service API - -The sender must first find the EDC of the customer to which the notification should be sent to. For this, the BPN of the customer is required. With this, the Discovery Service can be used to query for all EDCs of the customer. After that, the data catalog of each of these EDCs must be queried for the notification EDC asset as described above. If this notification EDC asset is found in one of these EDCs, the notification can be sent. - -There should only be one EDC which provides the notification EDC asset for Unique Id Push. If more than one EDC (for the same BPN/partner) are found, this is considered a misconfiguration of the corresponding partner. - -#### Creating Submodels for Digital Twins - -Submodels for Traceability are mostly easy to create by transforming a company's internal data into the target aspect model, i.e. SerialPartTypization or Batch. Transformations are mostly straightforward in these cases. - -The only special step in creating these two submodels is the initial creation of the Unique ID for the corresponding serialized parts or batches. - -##### Creation of Submodel AssemblyPartRelationship - -The creation of the submodel AssemblyPartRelationship is more complicated. This submodel contains the Unique ID of the manufacturer's part (attribute catenaXId) which is created - as described above - when the part's SerialPartTypization or Batch submodel is created. But it also contains the Unique IDs of the built-in parts (attributes childParts.childCatenaXId), as shown in the following example: - -```json -{ - "catenaXId": "urn:uuid:d261e0fa-36f5-4128-875e-0f5735f5a535", - "childParts": [ - { - "quantity": { - "quantityNumber": 1, - "measurementUnit": "unit:piece" - }, - "lifecycleContext": "AsBuilt", - "createdOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:9dc1b6fb-94e7-4911-9e39-abf06c4941d2" - }, - { - "quantity": { - "quantityNumber": 1, - "measurementUnit": "unit:piece" - }, - "lifecycleContext": "AsBuilt", - "createdOn": "2022-02-03T14:48:54.709Z", - "lastModifiedOn": "2022-02-03T14:48:54.709Z", - "childCatenaXId": "urn:uuid:d17bbf68-6cb7-4045-b3ae-67f41403d098" - } - ] -} - -``` - -For the build-in parts (child parts), their Unique ID is not known to the manufacturer initially. Only know are the local ids that are printed on the physical part (serialized part or batch), i.e., manufacturer (BPN), manufacturer part id and serial or batch number. To get the Unique ID of a built-in part, a data provider therefore has to do the follwoing: - -- Get all necessary local ids for the built-in part: - - manufacturer (BPN), manufacturer part id and serial number for serialized parts - - manufacturer (BPN), manufacturer part id and batch number for batches -- The next step is about getting the Unique ID of all built-in parts. There are two ways: - - Unique IDs might for built-in parts might already be available locally if Unique ID Push is supported by the data provider and the suppliers of the built-in parts. - - Query the Digital Twin Registry to find the digital twin for this built-in part - -###### Unique ID Push - -Once the digital twin was created, optionally a Unique ID Push notification can be send by the manufacturer of the part to the customer of the serialized part of batch to inform the customer that information about a serialized part or batch is available as a digital twin. This is an optional process and both, the manufacturer of a part as well as the customer of the part must support Unique ID Push notifications. - -For more information, see [Unique ID Push Notifications](#unique-id-push-notifications) - -###### Query the Digital Twin Registry to find the digital twin for this built-in part - -- Querying digital twins is described in (TRS) Lookup for Digital Twins at the Digital Twin Registry - - Note that the query parameters differ depending on what type of digital twin is looked up. - - For Release 3.0 though, no matter if you want to lookup serialized parts or batches, you can use partInstanceId (using the serial number or the batch number as search parameter value). - - For Batch digital twins, the key batchId might be provided optionally. As this key is not mandatory for Release 2, you cannot rely on this key being available when looking for Batch digital twins. - - To understand why, take a look at how these digital twins are created, especially their specificAssetIds: (TRS) Create Digital Twins for Serialized Parts and Batches incl. Submodels - - The result of this query will be the AAS ID of the digital twin. -- Use this AAS ID to get the AAS Descriptor including all Submodel Descriptors of this digital twin. The AAS Descriptor contains the Submodel Descriptor SerialPartTypization or Batch (depending on the digital twin type). -- Fetch the submodel SerialPartTypization or Batch (depending on the digital twin type) from the EDC that is referenced in the corresponding Submodel Descriptor. -- The submodel then contains the Unique ID of the built-in part in its catenaXId attribute. - -These steps have to be repeated for all built-in parts by the manufacturer. After that, the manufacturer has all information to create the AssemblyPartRelationship. - -#### Publish Traceability Data Offers at EDC - -Currently, only the format and content of the `asset:prop:id` attribute is mandatory. All other attributes can be used optionally by data providers. - -- `asset:prop:id`: This is the EDC asset ID and must have the following format: `-` - -##### Data Provider Tasks - -Basically, as a data provider you have to do the following - -- Implement a Backend Data Service (BDS) for every asset that is provided via the EDC. It does not have to be a different BDS for each asset - you can use the same BDS for several assets (to be verified). -- The BDS must support the AAS Interface Shell REST-API. -- The BDS must use the REST API data plan for data transmission. -- The BDS must verify that it only returns data to the data consumer that is compliant for the asset and data offer for which data is queried. As a data offer is always assigned to one data consumer, only data must be returned that is accessible for the data consumer. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/assets/architecture_level_1.png b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/assets/architecture_level_1.png deleted file mode 100644 index 34ff323a175..00000000000 Binary files a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/assets/architecture_level_1.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/assets/data_provisioning_data_flow.png b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/assets/data_provisioning_data_flow.png deleted file mode 100644 index a137b9b0026..00000000000 Binary files a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/assets/data_provisioning_data_flow.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/assets/traceability_customer-journey.png b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/assets/traceability_customer-journey.png deleted file mode 100644 index 1ab1dc00fbe..00000000000 Binary files a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/assets/traceability_customer-journey.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/assets/unique_id_push_process.png b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/assets/unique_id_push_process.png deleted file mode 100644 index 7d038364355..00000000000 Binary files a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/assets/unique_id_push_process.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/page_adoption-view.md deleted file mode 100644 index 0016803c319..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/page_adoption-view.md +++ /dev/null @@ -1,392 +0,0 @@ ---- -id: Adoption View Traceability Kit -title: Adoption View -description: 'Traceability Kit' -sidebar_position: 2 ---- - -![Traceability kit banner](@site/static/img/doc-traceability_header-minified.png) - -### Traceability KIT - - - -## Vision & Mission - -### Vision - -The aim of the Traceability KIT is to trace parts and materials across the entire value chain to enable data driven use cases over all n-tier levels without compromising data sovereignty. This KIT enables data and app providers to deliver solutions for building data chains and to send quality notifications on all levels and industries. - -### Mission - -The Traceability KIT provides the necessary standards, aspect models, APIs, logics, and processes on how to build a data sovereign data chain and send quality notifications. This is done via the standardized creation of digital twins of components and vehicles as well as the logical linking to their sub-components (Bill of Material, BoM). The default visibility of digital twins and their respective semantic models follows the one-up/one-down principle. This enables businesses to track and trace products, components, material, and software along the value chain for all product lifecycle stages. - -All described specifications in the KIT are based on Catena-X standards like Asset Administration Shell, DAPS and Digital Twin Registry. They refer to other Catena-X KITs like the Connector KIT (EDC), Data Chain KIT (Item Relation Ship, IRS) and Business Partner KIT to ensure interoperability and data sovereignty according to IDSA and Gaia-X principles. - -Furthermore, APIs and data models enable partners to send quality notifications in a standardized way while already knowing which parts of their direct customer and suppliers are affected and which are not. Moreover, the KIT is compatible with the data chain KIT to allow apps and business to traverse through the data chains over n-tier levels to enable further use cases like Circular Economy. - -In the current version, the KIT supports the creation of data chains for the life cycle contexts “as built” and “as planned”. Further lifecycle contexts, e.g., as maintained will be supported in the future. Overall, the KIT represents the backbone to build data chains for use cases based on vehicles and parts. It empowers app providers to develop a Catena-X Traceability application and data provider to implement their digital twins and the connection to their subcomponents themselves. - -### Customer Journey - -With the Traceability KIT, we support the Catena-X customer journey for our adopters and solutions providers. - -![Customer Journey](assets/traceability_customer-journey.png) - - -## Business Value - -Through the standardized specifications described in the “Traceability-KIT” – for example the semantic models and APIs – application and service providers can reduce investment and implementation costs to integrate new Catena-X services. Furthermore, application and service providers can enter potential new markets within the PLM & Quality domain. Data Provider and Businesses are able to build data sovereign data chains to enable data driven use – also for other domains like sustainability. - - -## Use Case - -### Status Quo / Today’s challenge - -From Traceability's perspective, the main challenge within the automotive industry is to define and implement inter-organizational end-to-end data chains across the whole automotive supply chain to empower data driven use cases. Details regarding the challenges are: - -- Missing standards to trace serialized and non-serialized hardware and software components. This includes the datatype, data format and data description (semantics) as well as the data exchange. The existing regulatory requirements that every company within the industry faces today are being solved with individual, proprietary solutions. - -- The digital maturity is diverging within the automotive industry. For bigger companies it is a challenge to receive overall structured data from multiple different suppliers on a broad scale. Smaller companies struggle to generate and provide those data in a fully digitized way. - -- Current solutions are either costly due to expensive distributed ledgers or cannot guarantee trust and data sovereignty based on the GAIA-X and IDSA principles including the regulation of access and usage policies regarding data chains. Therefore, no end-to-end data exchange and cooperation has been achieved as of today. - -### Benefits - -#### OEM and large automotive suppliers - -For OEM and large automotive suppliers: The Traceability solution from Catena-X enables companies to identify products affected by a defect faster and more precisely and thus avoiding general and inaccurate recalls. Through this targeted containment, companies can save both time and money with fewer actions for their customers. Moreover, the Traceability solution enables businesses to rapidly identify the affected part and the corresponding supplier after receiving an alert from the customer. This leads to faster and, therefore, cheaper problem-solving for all parties and less complicated claim management. Furthermore, suppliers can prove compliance of their supply chain to upcoming regulations such as the Supply Chain Act. - -#### SME - -The developed and simple-to-use Traceability solutions support SMEs in their mission to digitize the shop floor and communication with customers and suppliers. Today, in order to provide data to their customers and suppliers, SMEs are obligated to use several, proprietary B2B-interfaces from their customers. With Catena-X aiming to have only one digital interface for all customers and suppliers, it increases the ease of data exchange and saves IT resources. Furthermore, due to the Catena-X data sovereignty principles, all participants know what happens with their data. This increases trust in the data exchange. - -#### Solution Provider - -Solution providers have the potential to scale customer groups and access new market potentials via marketplace and shared service network. - -### Example - Industry Problem - -The KIT enables business to start Quality Investigations and send Quality Alerts in a standardized way while already knowing which parts of your direct customer and suppliers are affected and which are not. - -Through the introduction of unique Catena-X IDs, companies can register digital twins for vehicles, products, components, and raw materials and uniquely identify them within the whole Catena-X ecosystem. Building on that, it is possible to interconnect the registered digital twins of different companies to create a coherent automotive data chain from end-to-end. Furthermore, those twins can easily be complemented with further data like material information to enable further use cases like Circular Economy. - - -## Tutorials - -The following video gives an overview of the presented Traceability Use Case. - - - - - - - -## Semantic Models - -### Bill of Material (BoM) - -A bill of material resembles the structure of an end product. It is a list of all raw materials, sub-assemblies and sub-components that are needed to manufacture the end procuct. -At Catena-X Traceability we consider more than one single BoM. The BoM changes during the lifecyle and therefore, we are talking about different BoMs in different lifecycles. - -#### BoM Representations - -##### Single-Level BOM - -A single-level BOM represents one level of an assembly and does not include any lower-level subassemblies. - -##### Multi-Level BOM - -A Multi-Level Bill of Materials (BOM) is a [bill of materials (BOM)](https://www.bterrell.com/sage-accpac-erp/manufacturing/definition-multi-level-bom/definition-bom/) that lists the components, assemblies, and materials required to make a part. It provides a display of all components that are directly or indirectly used in a parent item. When an item is a subcomponent, blend, intermediate, etc., all of its components, including purchased parts and [raw materials](https://www.bterrell.com/sage-accpac-erp/manufacturing/definition-multi-level-bom/definition-bom/definition-raw-materials/), are also exhibited. A multilevel structure can be illustrated by a tree with several levels. A multi-level BOM is created by connecting a series of individual single level BOMs together. - -##### Flattened BOM - -Flattening BOM means the intermediate levels in the BOM are removed and the lowest level is directly connected to the highest level. - -#### BoM Lifecycle Stages - -BoM LifeCycleStage concept based on STEP AP242 with slight adoptions in layout & wording: - -- Each instance can be identified by unique (within the organization) serial number (SN). -- The ‘multi-SN’ (multi Serial number) describes product defined with a generic part or item -- The ‘one per SN’ (one per Serial number) describes product defined with an individual part or item - -| Name |Identifier Step |Implemented CX |Identifier CX| Description |Purpose |Creating time of BoM | BoM Ausprägungen | one/more fix suppliers | -| :--- | :----:|:----: |:----: |:----: | :----: |:----: |:----: |:----: | -| **AsDesigned (AsDeveloped)** | multi-SN | Currently Not Implemented |Part number*
may not be the specific part number but a code that describes a part
(technische Produktbeschreibung) |BoM asDesigned is generated in the design phase of a new product including alternative parts. |Build up the initial BoM in design phase of a new automotive product including alternative parts
Expected to have research & development part descriptions instead of specific part numbers |starting 2 years before SoP (for e.g. of a new vehicle project) |150% incl. variants which will not be used later |partly known
can be open at this point of time | -| **AsPlanned** | multi-SN | **Implemented** |Part number|BoM AsPlanned is used to plan the manufacturing process including alternative parts. |BoM AsPlanned is used to plan manufacturing including alternative parts.
Sourcing will most likely be based on this (besides key parts which start earlier) |starting 1,5 years before building the first component |120% of all variants are covered, incl. possibly multiple suppliers for the same component |fixed suppliers, could be more than one supplier per part| -| **AsOrdered** | one per SN | Currently Not Implemented |Part number | BoM AsOrdered is used for manufacturing realization. | BoM that is used for manufacturing realization.
This is the list of parts & components currently used for manufactoring after start of production (SOP) or shortly before.| fixed order
(production order or custom order)|100% exact order is known |fixed suppliers, could be more than one supplier per part| -| **AsBuilt** | one per SN | **Implemented**|Serial number / batch number | BoM AsBuilt describes a product as manufactured. | BoM as a component is built or manufactured.
During manufactoring of for e.g. a vehicle the serial numbers & batch numbers are documented (German: Verbaudokumentation).
This leads to one BoM per built car|during building process or directly after finishing|100% |one specific supplier| -| **AsSupported / AsFlying / AsMaintained / AsOperated** | one per SN | Currently Not Implemented |Serial number / batch number | BoM AsMaintained describes the product after purchasing by a customer and updates by maintenance. | BoM after for e.g. a vehicle was picked up by the customer. Changes to live cycle before may apply due to maintenance or repair work e.g. exchange of parts, liquids, ...|Starts when customer has picked up the product, updating if any change is done|100% inkl. replaced parts, incl. history of exchanged parts |one specific supplier| -| **AsRecycled** | - |Currently Not Implemented| Serial number / batch number | BoM AsRecycled describes the BoM after the recycling of the product. | Requirement for Batteries.||100% || - -Two of the considered BoMs are already implemented in the use case Traceability and will be described as follows. - -### Overview "AsPlanned" - -#### Short introduction: what is a BoM AsPlanned? - -The BoM AsPlanned is the generic list of all possible catalogue parts & materials for a specific vehical project and the supply chain from OEM to raw material suppliers. The BoM is also called 120% which means that it includes alternative parts / materials (e.g. LED headlights and XENON headlights) and parts for certain markets. It will be set up way before Start of Production (SOP) and be updated if the contents are updated. It is used for Sourcing / Production Planning and always reflects the current state of parts / materials build into this specific vehicle project. - -The BoM AsPlanned also includes all versions of parts like changed parts. It has to enable parts/materials provided from multiple manufacturers or the same manufacturer at different production sites. Additionally it must be possible to map relations of the same part/material to different customers. - -The complexity of generic is much higher than BoM AsBuilt. It is used for technical topics, e.g., Supply Chain Act, DCM. - -#### Definition Status of the BoM AsPlanned - -Defined - -- Digital Twins - - Digtial Twin "PartType" - -- Traceability data aspect models - - Aspect model "PartAsPlanned" - - Aspect model "SingleLevelBoMAsPlanned" - - Aspect model "SingelLevelUsageAsPlanned" - - Aspect model "PartSiteInformationAsPlanned" - -### AsPlanned Aspect Models - -#### 1. PartAsPlanned - -A Part as Planned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status in a specific version. - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.part_as_planned/1.0.1](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.part_as_planned/1.0.1) - -#### 2. SingelLevelBomAsPlanned - -The single-level Bill of Material represents one sub-level of an assembly and does not include any lower-level subassemblies. In 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. - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_planned/1.1.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_bom_as_planned/1.1.0) - -#### 3. SingelLevelUsageAsPlanned - -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 a 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. - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_usage_as_planned/1.1.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.single_level_usage_as_planned/1.1.0) - -#### 4. PartSiteInformationAsPlanned - -The aspect provides site related information for a given as planned item (i.e. a part type or part instance that is uniquely identifiable within Catena-X via its Catena-X ID). 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. - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.part_site_information_as_planned/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.part_site_information_as_planned/1.0.0) - -### Overview "AsBuilt" - -#### Short introduction: what is a BoM AsBuilt? - -A BoM AsBuilt resembles a single vehicle, which means that each vehicle built has its own individual BoM asBuilt. The BoM includes all part/components which either have a serial number, batch number, JIS number (sequence number) or a combination out of these. This means, that there is a direct and specific connection between a parent and a child part/component so that an accurate and exact traceability is possible. - -Also, the BoM is called 100%, as there are no alternative parts included but only built parts. Therefore, it will be set up when a part is produced and can be connected to its parent and child parts. - -In Catena-X the BoM asBuilt is used for technical topics, e.g., Quality, Battery Passport (CE). - -#### Definition Status of the BoM AsBuilt - -Defined - -- Digital Twins - - Digital Twin Serialized Part - - Digital Twin Batch - - Digital Twin Vehicle -- Build up the basic chain - - Aspect model "SerialPartTypization" - - Aspect model "AssemblyPartRelation" - - Aspect model "Batch" - - Aspect model "JustInSequencePart" - -### AsBuilt Aspect Models - -#### 1. SerialPartTypization - -A serialized part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a serial numbers or a similar identifier (e.g. VAN) or a combination of multiple identifiers (e.g. combination of manufacturer, date and number) - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.serial_part_typization/1.1.1](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.serial_part_typization/1.1.1) - -#### 2. AssemblyPartRelationship - -The aspect provides the child parts (one structural level down) which the given object assembles. - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.assembly_part_relationship/1.1.1](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.assembly_part_relationship/1.1.1) - -#### 3. Batch - -A batch is a quantity of (semi-) finished products or (raw) material product that have been produced under the same circumstances (e.g. same production location), as specified groups or amounts, within a certain time frame. Every batch can differ in the number or amount of products. Different batches can have varied specifications, e.g., different colors. A batch is identified via a Batch ID. - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.batch/1.0.2](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.batch/1.0.2) - -#### 4. JustInSequencePart - -A just-in-sequence part is an instantiation of a (design-) part, where the particular instantiation can be uniquely identified by means of a combination of several IDs related to a just-in-sequence process. - -Github Link to semantic data model: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.just_in_sequence_part/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.just_in_sequence_part/1.0.0) - - -## Logic & Schema - -### Building Block Architecture Overview - -This architecture overview only shows Catena-X Core Services that are directly accessed by Traceability components, e.g. the EDC is shown, but not the DAPS which is accessed by the EDC, but not directly by the Data Provisioning component. - -![Architecture - Level 1](assets/architecture_level_1.png) - -#### Traceability Components - -| Subsystem | Description | -|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Data Provisioning | This component provides a company's data to the Catena-X network by transforming it into the Catena-X format and publishing it. In Catena-X, data must be provided to the network based on existing standards from the other Kits. One example that can be used is the Connector Kit that builds a component based on the IDS protocol, e.g. the Connector of the Eclipse Dataspace Components (EDC). As standard for digital twins, the Asset Administration Shell (AAS) standard is used - this is relevant for registering digital twins (in the Digital Twin Registry) as well as for providing digital twin data. The data format used for Traceability data is based on the BAMM aspects models published in the Semantic Hub. | -| Traceability App | Enables traceability functionalities like quality alerts or notifications. When a Traceability App fetches data for digital twins (submodels), there are two options:
  • Directly access the partner's EDC (and the Digital Twin Registry) to connect to other partner's EDC and retrieve the data from ther
  • Use a local IRS service to get the data and let the IRS handle the EDC and Digital Twin Registry communication.
| -| Internal Systems | Existing internal systems of a Catena-X partner which provide data to Traceability components.
  • For Data Provisioning: The data provided to Catena-X via the EDC should be fetched from a partner's internal PLM and parts master data systems.
  • For Traceability Apps: A Traceability App may show more data to a user than just the data that is provided to Catena-X (and fetched via the Data Provisioning component). The business scope of COTS software is bigger than just Traceability and they have existing interfaces to fetch all data they need for their business functionality (and not only Traceability data).
Both components can also send data back to internal systems. That's at the discretion of the Catena-X partner and neither required nor prohibited by the Traceability use case. | - -#### Catena-X Core Services - -| Subsystem | Description | -|:-----------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Digital Twin Registry | The Digital Twin Registry acts as an address book for Digital Twins. Data Providers register their Digital Twins in the Digital Twin Registry. Data consumers query the Digital Twin Registry to find Digital Twins and interact with them further. A Digital Twin contains endpoint references to Submodel endpoints. Calling a Submodel endpoint returns data compliant to a semantic model. A semantic model describes the data that a Submodel endpoint returns. [Repository of the Digital Twin Registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry). | -| Item Relationship Service (IRS) | The IRS is providing a technical API Endpoint in the Catena-X Network, which builds an item tree representation of given digital twins stored across the industry. Therefore it is a key component for the Network to provide data chains along the value chain in the industry. [Repository of the IRS](https://github.com/eclipse-tractusx/item-relationship-service). | -| Eclipse Dataspace Components (EDC) | The Connector of the Eclipse Dataspace Components provides a framework for sovereign, inter-organizational data exchange. It will implement 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. [Repository of the Catena-X specific EDC](https://github.com/eclipse-tractusx/tractusx-edc). | -| Discovery Service | The EDC / dataspace discovery interface is a CX network public available endpoint which can get used to retrieve EDC endpoints and the related BPNs, as well as search for endpoints via the BPN. | - - -## Business Process - -To enable data sovereignty, access and usage policies are important to protect the data assets of a data provider in the EDC, described in the following. - -### 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. - -#### BPN Access Policy - -Description: This policy will allow limiting access to a data offer based on a list of specific BPN. This translates to the following functionality: - -- The data offer creator will be able to create a policy listing all the BPN that can access the data offer -- This means that only the connectors registered in DAPS with the BPN listed in the policy can see the data offer and accept it (for the creation of data contracts and subsequent data exchange) - - -Examples for single and multiple BPN are described on [this page of the EDC](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/edc-extensions/business-partner-validation). - -```json -{ - "uid": "", - "prohibitions": [], - "obligations": [], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "USE" - }, - "constraints": [ - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BusinessPartnerNumber" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "" - }, - "operator": "EQ" - } - ] - } - ] -} -``` - -### Usage Policies - -To decide which company can use the data asset under specific conditions, usage policies are used. Therefore, they are more specific than access policies and only used just after access is granted. The `POST` `/api/v1/data/policydefinitions` endpoint is used to create a usage policy in the EDC. Currently, the usage policies aren't technically enforced (keep this in mind when publishing data assets). - -#### Purpose-based Usage Policy - -It is recommended to restrict the data usage for all traceability aspects. This can be made with the purpose restricted data usage policy. It contains a String as `value` that defines the purpose of usage. Every participant in the Catena-X network must follow these purposes. - -In the following, the purpose value, their detailed description and the aspects for which they are relevant fore are presented. - -| Purpose Value | Relevant for | Description | -|--------------------------|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| R2_Traceability | SerialPartTypization 1.1.0 Batch 1.0.2 | The data can only be used for the Catena-X Use Case Traceability. This means that the data can only be consumed in the context of visualization of parts and vehicles and their relations and quality analysis to e.g. select relevant components for further quality analysis or notifications.
For demonstrations based on artificial data, this policy does not apply. | -| R2_Traceability | AssemblyPartRelationship 1.1.1 | The data can only be used for the Catena-X Use Case Traceability. This means that t he data can only be consumed in the context of visualization of parts and vehicles and their relations and quality analysis to e.g. select relevant components for further quality analysis or notifications.
For demonstrations based on artificial data, this policy does not apply.
_"Assumption: only used by own data provider. No usage of other use cases like dismantling, ESS etc."_ | -| R2_QualityAlert | Notification API | This purpose is intended for a Catena-X Use-Case Traceability. This means that t he data exchange via the Quality Alert Notification endpoint can only be exchanged in the context of visualization of quality-relevant issues of parts and vehicles and their relations . The exchanged data can only be used on a "need to know" basis in the context of quality analysis.
For demonstrations based on artificial data, this policy does not apply. | -| R2_QualityInvestigation | Notification API | This purpose is intended for a Catena-X Use-Case Traceability. This means that the data exchange via the Quality Alert Notification endpoint can only be exchanged in the context of visualization of quality-relevant issues of parts and vehicles and their relations. The exchanged data can only be used on a "need to know" basis in the context of quality analysis.
For demonstrations based on artificial data, this policy does not apply. | - -The JSON payload of a purpose-based usage policy looks as follows: - -```json -{ - "uid": "", - "prohibitions": [], - "obligations": [], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "USE" - }, - "constraints": [ - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "idsc:PURPOSE" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "" - }, - "operator": "EQ" - } - ] - } - ] -} -``` - -### Contract Definitions - -In the EDC, every policy is associated with a contract. The `POST` `/api/v1/data/contractdefinitions` has the following JSON payload to create a contract definition that creates the relationship: - -```json -{ - "id": "", - "accessPolicyId" : "", - "contractPolicyId" : "", - "criteria": [ - { - "operandLeft": "asset:prop:id", - "operator": "=", - "operandRight": "" - } - ] -} -``` - -The properties in this JSON have the following values: - -- `acccessPolicyId` is the UUID of the basic policy -- `contractPolicyId` is the UUID of the basic policy -- `criteria` is a list of simple expressions to express, which assets are used in this ContractDefinition. - -In the current implementation of the EDC only the `in` and `= operators are supported. - - -## Standards - -Our relevant standards can be downloaded from the official [Catena-X Standard Library](https://catena-x.net/de/standard-library): - -- [CX - 0019 Aspect Model: Serial Part Typization](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/PLM_Quality_Use_Case_Traceability/CX_-_0019_SerialPartTypization_UseCaseTraceability_v_1.0.1.pdf) -- [CX - 0020 Aspect Model:Assembly Part Relationship](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/PLM_Quality_Use_Case_Traceability/CX_-_0020_AssemblyPartRelationship_UseCaseTraceability_v_1.0.1.pdf) -- [CX - 0021 Aspect Model: Batch](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/PLM_Quality_Use_Case_Traceability/CX_-_0021__Batch_UseCaseTraceability_v_1.0.1.pdf) -- [CX - 0022 Notification Process](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/PLM_Quality_Use_Case_Traceability/CX_-_0022_Notification_Process_v_1.1.1.pdf) -- [CX - 0023 Notification API](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/PLM_Quality_Use_Case_Traceability/CX_-_0023_Notification_API_v_1.1.1.pdf) diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/page_changelog.md b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/page_changelog.md deleted file mode 100644 index fc1a23676af..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/page_changelog.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: Traceability Kit Changelog -title: Changelog -description: 'Traceability Kit' -sidebar_position: 1 ---- - -![Traceability kit banner](@site/static/img/doc-traceability_header-minified.png) - -### Traceability KIT - -All notable changes to this Kit will be documented in this file. - -## [1.0.1] - 2023-04-14 - -

Added

- -- Adoption View: Traceability tutorial video -- Adoption View: Customer journey - -

Changed

- -- ./. - -

Removed

- -- ./. - -## [1.0.0] - 2023-04-12 - -

Added

- -- Initial version of the Kit including adoption, operation and development view + two API specifications (Notification API, Unique ID Push API) - -

Changed

- -- ./. - -

Removed

- -- ./. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/page_software-operation-view.md deleted file mode 100644 index c06853648d8..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/Traceability Kit/page_software-operation-view.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: Operation View Traceability Kit -title: Operation View -description: 'Traceability Kit' -sidebar_position: 3 ---- - -![Traceability kit banner](@site/static/img/doc-traceability_header-minified.png) - -### Traceability KIT - - - -Based on the information provided in this KIT, it is possible to create and operate an own, custom -Traceability app. One open-source example is the **Trace-X app** in conjunction with the **Simple -Data Exchanger (SDE)** for data provisioning. For further information regarding -their usage, configuration and deployment, follow these resources: - -- [Trace-X Frontend GitHub Repository](https://github.com/eclipse-tractusx/traceability-foss) -- [Trace-X Backend GitHub Repository](https://github.com/eclipse-tractusx/traceability-foss-backend) -- [Trace-X Installation Guide](https://github.com/eclipse-tractusx/traceability-foss/blob/main/frontend/INSTALL.md) -- [SDE Frontend GitHub Repository](https://github.com/eclipse-tractusx/dft-frontend) -- [SDE Backend GitHub Repository](https://github.com/eclipse-tractusx/dft-backend) diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/CHANGELOG.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/CHANGELOG.md deleted file mode 100644 index d66ce0b8d64..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/CHANGELOG.md +++ /dev/null @@ -1,59 +0,0 @@ -# Changelog - -![Connector kit banner](@site/static/img/ConnectorKitIcon.png) - -## Connector KIT - -All notable changes to this Kit will be documented in this file. - -## [1.2.0] - 2023-05-16 - -

Added

- -- chart documentation for tractusx-connector-azure-vault - -

Changed

- -- helm chart documentation -> added needed properties and information about self-signed certificates for testing - -

Removed

- -- chart documentation for tractusx-connector-app -- unused files like charts, values.yaml - -## [1.1.0] - 2023-04-28 - -

Added

- -- documentation of the control-plane-adapter extension -- openAPI documentation of the control-plane-adapter extension -- documentation of the observability-api-customization -- migration documentation -- postman collection - -

Changed

- -- helm chart version for the edc components is now 0.3.3 -- switched the whole documentation structure from product-edc to tractusx-edc -- switched build tool from maven to gradle -- restructured the whole documentation structure and order - -

Removed

- -- ./. - -## [1.0.0] - 2023-03-01 - -

Added

- -- documentation of the management-api -- documentation of adoption view -- documentation of software development view - -

Changed

- -- ./. - -

Removed

- -- ./. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/README.md deleted file mode 100644 index d1c6a042297..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/README.md +++ /dev/null @@ -1,82 +0,0 @@ -# Tractus-X EDC (Eclipse Dataspace Connector) - -[![Contributors][contributors-shield]][contributors-url] -[![Stargazers][stars-shield]][stars-url] -[![Apache 2.0 License][license-shield]][license-url] -[![Latest Release][release-shield]][release-url] - -Container images and deployments of the Eclipse Dataspace Components for the Tractus-X project. - -Please also refer to: - -- [Our docs](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/docs) -- [Our Releases](https://github.com/eclipse-tractusx/tractusx-edc/releases) -- [Eclipse Dataspace Components](https://github.com/eclipse-edc/Connector) -- [Report Bug / Request Feature](https://github.com/eclipse-tractusx/tractusx-edc/issues) - -## About The Project - -The project provides pre-built control- and data-plane [docker](https://www.docker.com/) images -and [helm](https://helm.sh/) charts of -the [Eclipse DataSpaceConnector Project](https://github.com/eclipse-edc/Connector). - -## Inventory - -The eclipse data space connector is split up into Control-Plane and Data-Plane, whereas the Control-Plane functions as -administration layer and has responsibility of resource management, contract negotiation and administer data transfer. -The Data-Plane does the heavy lifting of transferring and receiving data streams. - -Depending on your environment there are different derivatives of the control-plane prepared: - -- [edc-controlplane-postgresql](edc-controlplane/edc-controlplane-postgresql) with dependency onto - - [Azure Key Vault](https://azure.microsoft.com/en-us/services/key-vault/#product-overview) - - [PostgreSQL 8.2 or newer](https://www.postgresql.org/) -- [edc-controlplane-postgresql-hashicorp-vault](edc-controlplane/edc-controlplane-postgresql-hashicorp-vault) with - dependency onto - - [Hashicorp Vault](https://www.vaultproject.io/) - - [PostgreSQL 8.2 or newer](https://www.postgresql.org/) - -Derivatives of the Data-Plane can be found here - -- [edc-dataplane-azure-vault](edc-dataplane/edc-dataplane-azure-vault) with dependency onto - - [Azure Key Vault](https://azure.microsoft.com/en-us/services/key-vault/#product-overview) -- [edc-dataplane-hashicorp-vault](edc-dataplane/edc-dataplane-hashicorp-vault) with dependency onto - - [Hashicorp Vault](https://www.vaultproject.io/) - -For testing/development purposes: - -- [edc-runtime-memory](edc-controlplane/edc-runtime-memory) - -## Getting Started - -### Build - -Build Tractus-X EDC together with its Container Images - -```shell -./gradlew dockerize -``` - -## License - -Distributed under the Apache 2.0 License. -See [LICENSE](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE) for more information. - - - - -[contributors-shield]: https://img.shields.io/github/contributors/eclipse-tractusx/tractusx-edc.svg?style=for-the-badge - -[contributors-url]: https://github.com/eclipse-tractusx/tractusx-edc/graphs/contributors - -[stars-shield]: https://img.shields.io/github/stars/eclipse-tractusx/tractusx-edc.svg?style=for-the-badge - -[stars-url]: https://github.com/eclipse-tractusx/tractusx-edc/stargazers - -[license-shield]: https://img.shields.io/github/license/eclipse-tractusx/tractusx-edc.svg?style=for-the-badge - -[license-url]: https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE - -[release-shield]: https://img.shields.io/github/v/release/eclipse-tractusx/tractusx-edc.svg?style=for-the-badge - -[release-url]: https://github.com/eclipse-tractusx/tractusx-edc/releases diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/charts/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/charts/README.md deleted file mode 100644 index adbaac6af1a..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/charts/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# Helm Charts - -## Chart Linting - -Chart linting is performed using [helm's CT tool](https://github.com/helm/chart-testing). - -Configuration files for [CT](../ct.yaml), [Yamale](../chart_schema.yaml) and [Yamllint](../lintconf.yaml) have been provided. - -## Generate Chart Readme's - -To generate chart README.md files from its respective values.yaml file we use the [helm-docs tool](https://github.com/norwoodj/helm-docs): - -```shell -docker run --rm --volume "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:v1.10.0 -``` - -## Confidential EDC Settings - -Some EDC settings should better not be part of the actual deployment (like credentials to the database or the vault). Therefore, it is possible to deploy a secret with these confidential settings beforehand, and make it known to the deployment by setting the secret name in the `envSecretName` field of the deployment. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/charts/tractusx-connector-azure-vault/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/charts/tractusx-connector-azure-vault/README.md deleted file mode 100644 index 593469b75a2..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/charts/tractusx-connector-azure-vault/README.md +++ /dev/null @@ -1,266 +0,0 @@ -# tractusx-connector-azure-vault - -![Version: 0.3.3](https://img.shields.io/badge/Version-0.3.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.3.3](https://img.shields.io/badge/AppVersion-0.3.3-informational?style=flat-square) - -A Helm chart for Tractus-X Eclipse Data Space Connector. The connector deployment consists of two runtime consists of a -Control Plane and a Data Plane. Note that _no_ external dependencies such as a PostgreSQL database and Azure KeyVault are included. - -This chart is intended for use with an _existing_ PostgreSQL database and an _existing_ Azure KeyVault. - -**Homepage:** - -This chart uses Azure KeyVault, which is expected to contain the following secrets on application start: - -- `daps-cert`: contains the x509 certificate of the connector. -- `daps-key`: the private key of the x509 certificate -- `aes-keys`: a 128bit, 256bit or 512bit string used to encrypt data. Must be stored in base64 format. - -These must be obtained from a DAPS instance, the process of which is out of the scope of this document. Alternatively, -self-signed certificates can be used for testing: - -```shell -openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout daps.key -out daps.cert -subj "/CN=test" -export DAPS_KEY="$(cat daps.key)" -export DAPS_CERT="$(cat daps.cert)" -``` - -## Launching the application - -The following requirements must be met before launching the application: - -- Write access to an Azure KeyVault instance is required to run this chart -- Secrets are seeded in advance -- The vault's client id, client secret, tenant id and vault name (not the url!) are known - -Please also consider using [this example configuration](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-tests/deployment/src/main/resources/helm/tractusx-connector-azure-vault-test.yaml) -to launch the application. -Combined, run this shell command to start the in-memory Tractus-X EDC runtime: - -```shell -helm repo add tractusx-edc https://eclipse-tractusx.github.io/charts/dev -helm install my-release tractusx-edc/tractusx-connector-azure-vault --version 0.3.3 \ - -f /tractusx-connector-azure-vault-test.yaml \ - --set vault.azure.name=$AZURE_VAULT_NAME \ - --set vault.azure.client=$AZURE_CLIENT_ID \ - --set vault.azure.secret=$AZURE_CLIENT_SECRET \ - --set vault.azure.tenant=$AZURE_TENANT_ID -``` - -Note that `DAPS_CERT` contains the x509 certificate, `DAPS_KEY` contains the private key. - -## Source Code - -- - -## Values - -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| backendService.httpProxyTokenReceiverUrl | string | `""` | | -| controlplane.affinity | object | `{}` | | -| controlplane.autoscaling.enabled | bool | `false` | Enables [horizontal pod autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) | -| controlplane.autoscaling.maxReplicas | int | `100` | Maximum replicas if resource consumption exceeds resource threshholds | -| controlplane.autoscaling.minReplicas | int | `1` | Minimal replicas if resource consumption falls below resource threshholds | -| controlplane.autoscaling.targetCPUUtilizationPercentage | int | `80` | targetAverageUtilization of cpu provided to a pod | -| controlplane.autoscaling.targetMemoryUtilizationPercentage | int | `80` | targetAverageUtilization of memory provided to a pod | -| controlplane.businessPartnerValidation.log.agreementValidation | bool | `true` | | -| controlplane.debug.enabled | bool | `false` | | -| controlplane.debug.port | int | `1044` | | -| controlplane.debug.suspendOnStart | bool | `false` | | -| controlplane.endpoints | object | `{"control":{"path":"/control","port":8083},"default":{"path":"/api","port":8080},"management":{"authKey":"","path":"/management","port":8081},"metrics":{"path":"/metrics","port":9090},"observability":{"insecure":true,"path":"/observability","port":8085},"protocol":{"path":"/api/v1/ids","port":8084}}` | endpoints of the control plane | -| controlplane.endpoints.control | object | `{"path":"/control","port":8083}` | control api, used for internal control calls. can be added to the internal ingress, but should probably not | -| controlplane.endpoints.control.path | string | `"/control"` | path for incoming api calls | -| controlplane.endpoints.control.port | int | `8083` | port for incoming api calls | -| controlplane.endpoints.default | object | `{"path":"/api","port":8080}` | default api for health checks, should not be added to any ingress | -| controlplane.endpoints.default.path | string | `"/api"` | path for incoming api calls | -| controlplane.endpoints.default.port | int | `8080` | port for incoming api calls | -| controlplane.endpoints.management | object | `{"authKey":"","path":"/management","port":8081}` | data management api, used by internal users, can be added to an ingress and must not be internet facing | -| controlplane.endpoints.management.authKey | string | `""` | authentication key, must be attached to each 'X-Api-Key' request header | -| controlplane.endpoints.management.path | string | `"/management"` | path for incoming api calls | -| controlplane.endpoints.management.port | int | `8081` | port for incoming api calls | -| controlplane.endpoints.metrics | object | `{"path":"/metrics","port":9090}` | metrics api, used for application metrics, must not be internet facing | -| controlplane.endpoints.metrics.path | string | `"/metrics"` | path for incoming api calls | -| controlplane.endpoints.metrics.port | int | `9090` | port for incoming api calls | -| controlplane.endpoints.observability | object | `{"insecure":true,"path":"/observability","port":8085}` | observability api with unsecured access, must not be internet facing | -| controlplane.endpoints.observability.insecure | bool | `true` | allow or disallow insecure access, i.e. access without authentication | -| controlplane.endpoints.observability.path | string | `"/observability"` | observability api, provides /health /readiness and /liveness endpoints | -| controlplane.endpoints.observability.port | int | `8085` | port for incoming API calls | -| controlplane.endpoints.protocol | object | `{"path":"/api/v1/ids","port":8084}` | ids api, used for inter connector communication and must be internet facing | -| controlplane.endpoints.protocol.path | string | `"/api/v1/ids"` | path for incoming api calls | -| controlplane.endpoints.protocol.port | int | `8084` | port for incoming api calls | -| controlplane.env | object | `{}` | | -| controlplane.envConfigMapNames | list | `[]` | | -| controlplane.envSecretNames | list | `[]` | | -| controlplane.envValueFrom | object | `{}` | | -| controlplane.image.pullPolicy | string | `"IfNotPresent"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy) to use | -| controlplane.image.repository | string | `""` | Which derivate of the control plane to use. when left empty the deployment will select the correct image automatically | -| controlplane.image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion | -| controlplane.ingresses[0].annotations | object | `{}` | Additional ingress annotations to add | -| controlplane.ingresses[0].certManager.clusterIssuer | string | `""` | If preset enables certificate generation via cert-manager cluster-wide issuer | -| controlplane.ingresses[0].certManager.issuer | string | `""` | If preset enables certificate generation via cert-manager namespace scoped issuer | -| controlplane.ingresses[0].className | string | `""` | Defines the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use | -| controlplane.ingresses[0].enabled | bool | `false` | | -| controlplane.ingresses[0].endpoints | list | `["ids"]` | EDC endpoints exposed by this ingress resource | -| controlplane.ingresses[0].hostname | string | `"edc-control.local"` | The hostname to be used to precisely map incoming traffic onto the underlying network service | -| controlplane.ingresses[0].tls | object | `{"enabled":false,"secretName":""}` | TLS [tls class](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) applied to the ingress resource | -| controlplane.ingresses[0].tls.enabled | bool | `false` | Enables TLS on the ingress resource | -| controlplane.ingresses[0].tls.secretName | string | `""` | If present overwrites the default secret name | -| controlplane.ingresses[1].annotations | object | `{}` | Additional ingress annotations to add | -| controlplane.ingresses[1].certManager.clusterIssuer | string | `""` | If preset enables certificate generation via cert-manager cluster-wide issuer | -| controlplane.ingresses[1].certManager.issuer | string | `""` | If preset enables certificate generation via cert-manager namespace scoped issuer | -| controlplane.ingresses[1].className | string | `""` | Defines the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use | -| controlplane.ingresses[1].enabled | bool | `false` | | -| controlplane.ingresses[1].endpoints | list | `["management","control"]` | EDC endpoints exposed by this ingress resource | -| controlplane.ingresses[1].hostname | string | `"edc-control.intranet"` | The hostname to be used to precisely map incoming traffic onto the underlying network service | -| controlplane.ingresses[1].tls | object | `{"enabled":false,"secretName":""}` | TLS [tls class](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) applied to the ingress resource | -| controlplane.ingresses[1].tls.enabled | bool | `false` | Enables TLS on the ingress resource | -| controlplane.ingresses[1].tls.secretName | string | `""` | If present overwrites the default secret name | -| controlplane.initContainers | list | `[]` | | -| controlplane.internationalDataSpaces.catalogId | string | `"TXDC-Catalog"` | | -| controlplane.internationalDataSpaces.curator | string | `""` | | -| controlplane.internationalDataSpaces.description | string | `"Tractus-X Eclipse IDS Data Space Connector"` | | -| controlplane.internationalDataSpaces.id | string | `"TXDC"` | | -| controlplane.internationalDataSpaces.maintainer | string | `""` | | -| controlplane.internationalDataSpaces.title | string | `""` | | -| controlplane.livenessProbe.enabled | bool | `true` | Whether to enable kubernetes [liveness-probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| controlplane.livenessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| controlplane.livenessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first liveness check | -| controlplane.livenessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a liveness check every 10 seconds | -| controlplane.livenessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| controlplane.livenessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| controlplane.logging | string | `".level=INFO\norg.eclipse.edc.level=ALL\nhandlers=java.util.logging.ConsoleHandler\njava.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter\njava.util.logging.ConsoleHandler.level=ALL\njava.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n"` | configuration of the [Java Util Logging Facade](https://docs.oracle.com/javase/7/docs/technotes/guides/logging/overview.html) | -| controlplane.nodeSelector | object | `{}` | | -| controlplane.opentelemetry | string | `"otel.javaagent.enabled=false\notel.javaagent.debug=false"` | configuration of the [Open Telemetry Agent](https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/) to collect and expose metrics | -| controlplane.podAnnotations | object | `{}` | additional annotations for the pod | -| controlplane.podLabels | object | `{}` | additional labels for the pod | -| controlplane.podSecurityContext | object | `{"fsGroup":10001,"runAsGroup":10001,"runAsUser":10001,"seccompProfile":{"type":"RuntimeDefault"}}` | The [pod security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod) defines privilege and access control settings for a Pod within the deployment | -| controlplane.podSecurityContext.fsGroup | int | `10001` | The owner for volumes and any files created within volumes will belong to this guid | -| controlplane.podSecurityContext.runAsGroup | int | `10001` | Processes within a pod will belong to this guid | -| controlplane.podSecurityContext.runAsUser | int | `10001` | Runs all processes within a pod with a special uid | -| controlplane.podSecurityContext.seccompProfile.type | string | `"RuntimeDefault"` | Restrict a Container's Syscalls with seccomp | -| controlplane.readinessProbe.enabled | bool | `true` | Whether to enable kubernetes [readiness-probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| controlplane.readinessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| controlplane.readinessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first readiness check | -| controlplane.readinessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a readiness check every 10 seconds | -| controlplane.readinessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| controlplane.readinessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| controlplane.replicaCount | int | `1` | | -| controlplane.resources | object | `{}` | [resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for the container | -| controlplane.securityContext.allowPrivilegeEscalation | bool | `false` | Controls [Privilege Escalation](https://kubernetes.io/docs/concepts/security/pod-security-policy/#privilege-escalation) enabling setuid binaries changing the effective user ID | -| controlplane.securityContext.capabilities.add | list | `[]` | Specifies which capabilities to add to issue specialized syscalls | -| controlplane.securityContext.capabilities.drop | list | `["ALL"]` | Specifies which capabilities to drop to reduce syscall attack surface | -| controlplane.securityContext.readOnlyRootFilesystem | bool | `true` | Whether the root filesystem is mounted in read-only mode | -| controlplane.securityContext.runAsNonRoot | bool | `true` | Requires the container to run without root privileges | -| controlplane.securityContext.runAsUser | int | `10001` | The container's process will run with the specified uid | -| controlplane.service.annotations | object | `{}` | | -| controlplane.service.type | string | `"ClusterIP"` | [Service type](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) to expose the running application on a set of Pods as a network service. | -| controlplane.tolerations | list | `[]` | | -| controlplane.url.ids | string | `""` | Explicitly declared url for reaching the ids api (e.g. if ingresses not used) | -| controlplane.volumeMounts | list | `[]` | declare where to mount [volumes](https://kubernetes.io/docs/concepts/storage/volumes/) into the container | -| controlplane.volumes | list | `[]` | [volume](https://kubernetes.io/docs/concepts/storage/volumes/) directories | -| customLabels | object | `{}` | | -| daps.clientId | string | `""` | | -| daps.paths.jwks | string | `"/jwks.json"` | | -| daps.paths.token | string | `"/token"` | | -| daps.url | string | `""` | | -| dataplane.affinity | object | `{}` | | -| dataplane.autoscaling.enabled | bool | `false` | Enables [horizontal pod autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) | -| dataplane.autoscaling.maxReplicas | int | `100` | Maximum replicas if resource consumption exceeds resource threshholds | -| dataplane.autoscaling.minReplicas | int | `1` | Minimal replicas if resource consumption falls below resource threshholds | -| dataplane.autoscaling.targetCPUUtilizationPercentage | int | `80` | targetAverageUtilization of cpu provided to a pod | -| dataplane.autoscaling.targetMemoryUtilizationPercentage | int | `80` | targetAverageUtilization of memory provided to a pod | -| dataplane.aws.accessKeyId | string | `""` | | -| dataplane.aws.endpointOverride | string | `""` | | -| dataplane.aws.secretAccessKey | string | `""` | | -| dataplane.debug.enabled | bool | `false` | | -| dataplane.debug.port | int | `1044` | | -| dataplane.debug.suspendOnStart | bool | `false` | | -| dataplane.endpoints.control.path | string | `"/api/dataplane/control"` | | -| dataplane.endpoints.control.port | int | `8083` | | -| dataplane.endpoints.default.path | string | `"/api"` | | -| dataplane.endpoints.default.port | int | `8080` | | -| dataplane.endpoints.metrics.path | string | `"/metrics"` | | -| dataplane.endpoints.metrics.port | int | `9090` | | -| dataplane.endpoints.observability.insecure | bool | `true` | allow or disallow insecure access, i.e. access without authentication | -| dataplane.endpoints.observability.path | string | `"/observability"` | observability api, provides /health /readiness and /liveness endpoints | -| dataplane.endpoints.observability.port | int | `8085` | port for incoming API calls | -| dataplane.endpoints.public.path | string | `"/api/public"` | | -| dataplane.endpoints.public.port | int | `8081` | | -| dataplane.env | object | `{}` | | -| dataplane.envConfigMapNames | list | `[]` | | -| dataplane.envSecretNames | list | `[]` | | -| dataplane.envValueFrom | object | `{}` | | -| dataplane.image.pullPolicy | string | `"IfNotPresent"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy) to use | -| dataplane.image.repository | string | `""` | Which derivate of the data plane to use. when left empty the deployment will select the correct image automatically | -| dataplane.image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion | -| dataplane.ingresses[0].annotations | object | `{}` | Additional ingress annotations to add | -| dataplane.ingresses[0].certManager.clusterIssuer | string | `""` | If preset enables certificate generation via cert-manager cluster-wide issuer | -| dataplane.ingresses[0].certManager.issuer | string | `""` | If preset enables certificate generation via cert-manager namespace scoped issuer | -| dataplane.ingresses[0].className | string | `""` | Defines the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use | -| dataplane.ingresses[0].enabled | bool | `false` | | -| dataplane.ingresses[0].endpoints | list | `["public"]` | EDC endpoints exposed by this ingress resource | -| dataplane.ingresses[0].hostname | string | `"edc-data.local"` | The hostname to be used to precisely map incoming traffic onto the underlying network service | -| dataplane.ingresses[0].tls | object | `{"enabled":false,"secretName":""}` | TLS [tls class](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) applied to the ingress resource | -| dataplane.ingresses[0].tls.enabled | bool | `false` | Enables TLS on the ingress resource | -| dataplane.ingresses[0].tls.secretName | string | `""` | If present overwrites the default secret name | -| dataplane.initContainers | list | `[]` | | -| dataplane.livenessProbe.enabled | bool | `true` | Whether to enable kubernetes [liveness-probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| dataplane.livenessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| dataplane.livenessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first liveness check | -| dataplane.livenessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a liveness check every 10 seconds | -| dataplane.livenessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| dataplane.livenessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| dataplane.logging | string | `".level=INFO\norg.eclipse.edc.level=ALL\nhandlers=java.util.logging.ConsoleHandler\njava.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter\njava.util.logging.ConsoleHandler.level=ALL\njava.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n"` | configuration of the [Java Util Logging Facade](https://docs.oracle.com/javase/7/docs/technotes/guides/logging/overview.html) | -| dataplane.nodeSelector | object | `{}` | | -| dataplane.opentelemetry | string | `"otel.javaagent.enabled=false\notel.javaagent.debug=false"` | configuration of the [Open Telemetry Agent](https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/) to collect and expose metrics | -| dataplane.podAnnotations | object | `{}` | additional annotations for the pod | -| dataplane.podLabels | object | `{}` | additional labels for the pod | -| dataplane.podSecurityContext | object | `{"fsGroup":10001,"runAsGroup":10001,"runAsUser":10001,"seccompProfile":{"type":"RuntimeDefault"}}` | The [pod security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod) defines privilege and access control settings for a Pod within the deployment | -| dataplane.podSecurityContext.fsGroup | int | `10001` | The owner for volumes and any files created within volumes will belong to this guid | -| dataplane.podSecurityContext.runAsGroup | int | `10001` | Processes within a pod will belong to this guid | -| dataplane.podSecurityContext.runAsUser | int | `10001` | Runs all processes within a pod with a special uid | -| dataplane.podSecurityContext.seccompProfile.type | string | `"RuntimeDefault"` | Restrict a Container's Syscalls with seccomp | -| dataplane.readinessProbe.enabled | bool | `true` | Whether to enable kubernetes [readiness-probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| dataplane.readinessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| dataplane.readinessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first readiness check | -| dataplane.readinessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a liveness check every 10 seconds | -| dataplane.readinessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| dataplane.readinessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| dataplane.replicaCount | int | `1` | | -| dataplane.resources | object | `{}` | [resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for the container | -| dataplane.securityContext.allowPrivilegeEscalation | bool | `false` | Controls [Privilege Escalation](https://kubernetes.io/docs/concepts/security/pod-security-policy/#privilege-escalation) enabling setuid binaries changing the effective user ID | -| dataplane.securityContext.capabilities.add | list | `[]` | Specifies which capabilities to add to issue specialized syscalls | -| dataplane.securityContext.capabilities.drop | list | `["ALL"]` | Specifies which capabilities to drop to reduce syscall attack surface | -| dataplane.securityContext.readOnlyRootFilesystem | bool | `true` | Whether the root filesystem is mounted in read-only mode | -| dataplane.securityContext.runAsNonRoot | bool | `true` | Requires the container to run without root privileges | -| dataplane.securityContext.runAsUser | int | `10001` | The container's process will run with the specified uid | -| dataplane.service.port | int | `80` | | -| dataplane.service.type | string | `"ClusterIP"` | [Service type](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) to expose the running application on a set of Pods as a network service. | -| dataplane.tolerations | list | `[]` | | -| dataplane.url.public | string | `""` | Explicitly declared url for reaching the public api (e.g. if ingresses not used) | -| dataplane.volumeMounts | list | `[]` | declare where to mount [volumes](https://kubernetes.io/docs/concepts/storage/volumes/) into the container | -| dataplane.volumes | list | `[]` | [volume](https://kubernetes.io/docs/concepts/storage/volumes/) directories | -| fullnameOverride | string | `""` | | -| imagePullSecrets | list | `[]` | Existing image pull secret to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry) | -| nameOverride | string | `""` | | -| postgresql.enabled | bool | `false` | | -| postgresql.jdbcUrl | string | `""` | | -| postgresql.password | string | `""` | | -| postgresql.username | string | `""` | | -| serviceAccount.annotations | object | `{}` | | -| serviceAccount.create | bool | `true` | | -| serviceAccount.imagePullSecrets | list | `[]` | Existing image pull secret bound to the service account to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry) | -| serviceAccount.name | string | `""` | | -| vault.azure.certificate | string | `nil` | | -| vault.azure.client | string | `""` | | -| vault.azure.name | string | `""` | | -| vault.azure.secret | string | `nil` | | -| vault.azure.tenant | string | `""` | | -| vault.secretNames.dapsPrivateKey | string | `"daps-private-key"` | | -| vault.secretNames.dapsPublicKey | string | `"daps-public-key"` | | -| vault.secretNames.transferProxyTokenEncryptionAesKey | string | `"transfer-proxy-token-encryption-aes-key"` | | -| vault.secretNames.transferProxyTokenSignerPrivateKey | string | `"transfer-proxy-token-signer-private-key"` | | -| vault.secretNames.transferProxyTokenSignerPublicKey | string | `"transfer-proxy-token-signer-public-key"` | | - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.10.0](https://github.com/norwoodj/helm-docs/releases/v1.10.0) diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/charts/tractusx-connector-memory/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/charts/tractusx-connector-memory/README.md deleted file mode 100644 index 5d5c5983e18..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/charts/tractusx-connector-memory/README.md +++ /dev/null @@ -1,173 +0,0 @@ -# tractusx-connector-memory - -![Version: 0.3.3](https://img.shields.io/badge/Version-0.3.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.3.3](https://img.shields.io/badge/AppVersion-0.3.3-informational?style=flat-square) - -A Helm chart for Tractus-X Eclipse Data Space Connector based on memory. Please only use this for development or testing purposes, never in production workloads! - -**Homepage:** - -This chart uses an in-memory secrets vault, which is required to contain the following secrets on application start: - -- `daps-cert`: contains the x509 certificate of the connector. -- `daps-key`: the private key of the x509 certificate - -These must be obtained from a DAPS instance, the process of which is out of the scope of this document. Alternatively, -self-signed certificates can be used for testing: - -```shell -openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout daps.key -out daps.cert -subj "/CN=test" -export DAPS_KEY="$(cat daps.key)" -export DAPS_CERT="$(cat daps.cert)" -``` - -## Launching the application - -The in-memory vault can be seeded directly with secrets that are passed in `:;:;...` format. -This config value can be passed to the runtime using the `vault.secrets` parameter. In addition, the runtime requires a -couple of configuration parameters, all of which can be found in the section below. Please also consider using -[this example configuration](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/charts/tractusx-connector-memory/example.yaml) -to launch the application. - -Combined, run this shell command to start the in-memory Tractus-X EDC runtime: - -```shell -helm repo add tractusx-edc https://eclipse-tractusx.github.io/charts/dev -helm install my-release tractusx-edc/tractusx-connector-memory --version 0.3.3 \ - -f /example.yaml \ - --set vault.secrets="daps-cert:$DAPS_CERT;daps-key:$DAPS_KEY" \ -``` - -Note that `DAPS_CERT` contains the x509 certificate, `DAPS_KEY` contains the private key. - -## Source Code - -- - -## Values - -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| backendService.httpProxyTokenReceiverUrl | string | `""` | | -| customLabels | object | `{}` | | -| daps.clientId | string | `""` | | -| daps.paths.jwks | string | `"/jwks.json"` | | -| daps.paths.token | string | `"/token"` | | -| daps.url | string | `""` | | -| fullnameOverride | string | `""` | | -| imagePullSecrets | list | `[]` | Existing image pull secret to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry) | -| nameOverride | string | `""` | | -| runtime.affinity | object | `{}` | | -| runtime.autoscaling.enabled | bool | `false` | Enables [horizontal pod autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) | -| runtime.autoscaling.maxReplicas | int | `100` | Maximum replicas if resource consumption exceeds resource threshholds | -| runtime.autoscaling.minReplicas | int | `1` | Minimal replicas if resource consumption falls below resource threshholds | -| runtime.autoscaling.targetCPUUtilizationPercentage | int | `80` | targetAverageUtilization of cpu provided to a pod | -| runtime.autoscaling.targetMemoryUtilizationPercentage | int | `80` | targetAverageUtilization of memory provided to a pod | -| runtime.businessPartnerValidation.log.agreementValidation | bool | `true` | | -| runtime.debug.enabled | bool | `false` | | -| runtime.debug.port | int | `1044` | | -| runtime.debug.suspendOnStart | bool | `false` | | -| runtime.endpoints | object | `{"control":{"path":"/control","port":8083},"data":{"authKey":"","path":"/data","port":8081},"default":{"path":"/api","port":8080},"ids":{"path":"/api/v1/ids","port":8084},"observability":{"insecure":true,"path":"/observability","port":8085},"public":{"path":"/api/public","port":8086},"validation":{"path":"/validation","port":8082}}` | endpoints of the control plane | -| runtime.endpoints.control | object | `{"path":"/control","port":8083}` | control api, used for internal control calls. can be added to the internal ingress, but should probably not | -| runtime.endpoints.control.path | string | `"/control"` | path for incoming api calls | -| runtime.endpoints.control.port | int | `8083` | port for incoming api calls | -| runtime.endpoints.data | object | `{"authKey":"","path":"/data","port":8081}` | data management api, used by internal users, can be added to an ingress and must not be internet facing | -| runtime.endpoints.data.authKey | string | `""` | authentication key, must be attached to each 'X-Api-Key' request header | -| runtime.endpoints.data.path | string | `"/data"` | path for incoming api calls | -| runtime.endpoints.data.port | int | `8081` | port for incoming api calls | -| runtime.endpoints.default | object | `{"path":"/api","port":8080}` | default api for health checks, should not be added to any ingress | -| runtime.endpoints.default.path | string | `"/api"` | path for incoming api calls | -| runtime.endpoints.default.port | int | `8080` | port for incoming api calls | -| runtime.endpoints.ids | object | `{"path":"/api/v1/ids","port":8084}` | ids api, used for inter connector communication and must be internet facing | -| runtime.endpoints.ids.path | string | `"/api/v1/ids"` | path for incoming api calls | -| runtime.endpoints.ids.port | int | `8084` | port for incoming api calls | -| runtime.endpoints.observability | object | `{"insecure":true,"path":"/observability","port":8085}` | observability api with unsecured access, must not be internet facing | -| runtime.endpoints.observability.insecure | bool | `true` | allow or disallow insecure access, i.e. access without authentication | -| runtime.endpoints.observability.path | string | `"/observability"` | observability api, provides /health /readiness and /liveness endpoints | -| runtime.endpoints.observability.port | int | `8085` | port for incoming API calls | -| runtime.endpoints.validation | object | `{"path":"/validation","port":8082}` | validation api, only used by the data plane and should not be added to any ingress | -| runtime.endpoints.validation.path | string | `"/validation"` | path for incoming api calls | -| runtime.endpoints.validation.port | int | `8082` | port for incoming api calls | -| runtime.env | object | `{}` | | -| runtime.envConfigMapNames | list | `[]` | | -| runtime.envSecretNames | list | `[]` | | -| runtime.envValueFrom | object | `{}` | | -| runtime.image.pullPolicy | string | `"IfNotPresent"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy) to use | -| runtime.image.repository | string | `""` | | -| runtime.image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion | -| runtime.ingresses[0].annotations | object | `{}` | Additional ingress annotations to add | -| runtime.ingresses[0].certManager.clusterIssuer | string | `""` | If preset enables certificate generation via cert-manager cluster-wide issuer | -| runtime.ingresses[0].certManager.issuer | string | `""` | If preset enables certificate generation via cert-manager namespace scoped issuer | -| runtime.ingresses[0].className | string | `""` | Defines the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use | -| runtime.ingresses[0].enabled | bool | `false` | | -| runtime.ingresses[0].endpoints | list | `["ids"]` | EDC endpoints exposed by this ingress resource | -| runtime.ingresses[0].hostname | string | `"edc-control.local"` | The hostname to be used to precisely map incoming traffic onto the underlying network service | -| runtime.ingresses[0].tls | object | `{"enabled":false,"secretName":""}` | TLS [tls class](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) applied to the ingress resource | -| runtime.ingresses[0].tls.enabled | bool | `false` | Enables TLS on the ingress resource | -| runtime.ingresses[0].tls.secretName | string | `""` | If present overwrites the default secret name | -| runtime.ingresses[1].annotations | object | `{}` | Additional ingress annotations to add | -| runtime.ingresses[1].certManager.clusterIssuer | string | `""` | If preset enables certificate generation via cert-manager cluster-wide issuer | -| runtime.ingresses[1].certManager.issuer | string | `""` | If preset enables certificate generation via cert-manager namespace scoped issuer | -| runtime.ingresses[1].className | string | `""` | Defines the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use | -| runtime.ingresses[1].enabled | bool | `false` | | -| runtime.ingresses[1].endpoints | list | `["data","control"]` | EDC endpoints exposed by this ingress resource | -| runtime.ingresses[1].hostname | string | `"edc-control.intranet"` | The hostname to be used to precisely map incoming traffic onto the underlying network service | -| runtime.ingresses[1].tls | object | `{"enabled":false,"secretName":""}` | TLS [tls class](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) applied to the ingress resource | -| runtime.ingresses[1].tls.enabled | bool | `false` | Enables TLS on the ingress resource | -| runtime.ingresses[1].tls.secretName | string | `""` | If present overwrites the default secret name | -| runtime.initContainers | list | `[]` | | -| runtime.internationalDataSpaces.catalogId | string | `"TXDC-Catalog"` | | -| runtime.internationalDataSpaces.curator | string | `""` | | -| runtime.internationalDataSpaces.description | string | `"Tractus-X Eclipse IDS Data Space Connector"` | | -| runtime.internationalDataSpaces.id | string | `"TXDC"` | | -| runtime.internationalDataSpaces.maintainer | string | `""` | | -| runtime.internationalDataSpaces.title | string | `""` | | -| runtime.livenessProbe.enabled | bool | `true` | Whether to enable kubernetes [liveness-probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| runtime.livenessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| runtime.livenessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first liveness check | -| runtime.livenessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a liveness check every 10 seconds | -| runtime.livenessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| runtime.livenessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| runtime.logging | string | `".level=INFO\norg.eclipse.edc.level=ALL\nhandlers=java.util.logging.ConsoleHandler\njava.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter\njava.util.logging.ConsoleHandler.level=ALL\njava.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n"` | configuration of the [Java Util Logging Facade](https://docs.oracle.com/javase/7/docs/technotes/guides/logging/overview.html) | -| runtime.nodeSelector | object | `{}` | | -| runtime.podAnnotations | object | `{}` | additional annotations for the pod | -| runtime.podLabels | object | `{}` | additional labels for the pod | -| runtime.podSecurityContext | object | `{"fsGroup":10001,"runAsGroup":10001,"runAsUser":10001,"seccompProfile":{"type":"RuntimeDefault"}}` | The [pod security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod) defines privilege and access control settings for a Pod within the deployment | -| runtime.podSecurityContext.fsGroup | int | `10001` | The owner for volumes and any files created within volumes will belong to this guid | -| runtime.podSecurityContext.runAsGroup | int | `10001` | Processes within a pod will belong to this guid | -| runtime.podSecurityContext.runAsUser | int | `10001` | Runs all processes within a pod with a special uid | -| runtime.podSecurityContext.seccompProfile.type | string | `"RuntimeDefault"` | Restrict a Container's Syscalls with seccomp | -| runtime.readinessProbe.enabled | bool | `true` | Whether to enable kubernetes [readiness-probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| runtime.readinessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| runtime.readinessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first readiness check | -| runtime.readinessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a readiness check every 10 seconds | -| runtime.readinessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| runtime.readinessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| runtime.replicaCount | int | `1` | | -| runtime.resources | object | `{}` | [resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for the container | -| runtime.securityContext.allowPrivilegeEscalation | bool | `false` | Controls [Privilege Escalation](https://kubernetes.io/docs/concepts/security/pod-security-policy/#privilege-escalation) enabling setuid binaries changing the effective user ID | -| runtime.securityContext.capabilities.add | list | `[]` | Specifies which capabilities to add to issue specialized syscalls | -| runtime.securityContext.capabilities.drop | list | `["ALL"]` | Specifies which capabilities to drop to reduce syscall attack surface | -| runtime.securityContext.readOnlyRootFilesystem | bool | `true` | Whether the root filesystem is mounted in read-only mode | -| runtime.securityContext.runAsNonRoot | bool | `true` | Requires the container to run without root privileges | -| runtime.securityContext.runAsUser | int | `10001` | The container's process will run with the specified uid | -| runtime.service.annotations | object | `{}` | | -| runtime.service.type | string | `"ClusterIP"` | [Service type](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) to expose the running application on a set of Pods as a network service. | -| runtime.tolerations | list | `[]` | | -| runtime.url.ids | string | `""` | Explicitly declared url for reaching the ids api (e.g. if ingresses not used) | -| runtime.url.public | string | `""` | | -| runtime.url.readiness | string | `""` | | -| runtime.volumeMounts | list | `[]` | declare where to mount [volumes](https://kubernetes.io/docs/concepts/storage/volumes/) into the container | -| runtime.volumes | list | `[]` | [volume](https://kubernetes.io/docs/concepts/storage/volumes/) directories | -| serviceAccount.annotations | object | `{}` | | -| serviceAccount.create | bool | `true` | | -| serviceAccount.imagePullSecrets | list | `[]` | Existing image pull secret bound to the service account to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry) | -| serviceAccount.name | string | `""` | | -| vault.secretNames.dapsPrivateKey | string | `"daps-private-key"` | | -| vault.secretNames.dapsPublicKey | string | `"daps-public-key"` | | -| vault.secretNames.transferProxyTokenEncryptionAesKey | string | `"transfer-proxy-token-encryption-aes-key"` | | -| vault.secretNames.transferProxyTokenSignerPrivateKey | string | `"transfer-proxy-token-signer-private-key"` | | -| vault.secretNames.transferProxyTokenSignerPublicKey | string | `"transfer-proxy-token-signer-public-key"` | | -| vault.secrets | string | `""` | | - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.10.0](https://github.com/norwoodj/helm-docs/releases/v1.10.0) diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/charts/tractusx-connector/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/charts/tractusx-connector/README.md deleted file mode 100644 index f432afc9de0..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/charts/tractusx-connector/README.md +++ /dev/null @@ -1,261 +0,0 @@ -# tractusx-connector - -![Version: 0.3.3](https://img.shields.io/badge/Version-0.3.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.3.3](https://img.shields.io/badge/AppVersion-0.3.3-informational?style=flat-square) - -A Helm chart for Tractus-X Eclipse Data Space Connector. The connector deployment consists of two runtime consists of a -Control Plane and a Data Plane. Note that _no_ external dependencies such as a PostgreSQL database and HashiCorp Vault are included. - -This chart is intended for use with an _existing_ PostgreSQL database and an _existing_ HashiCorp Vault. - -**Homepage:** - -This chart uses Hashicorp Vault, which is expected to contain the following secrets on application start: - -- `daps-cert`: contains the x509 certificate of the connector. -- `daps-key`: the private key of the x509 certificate -- `aes-keys`: a 128bit, 256bit or 512bit string used to encrypt data. Must be stored in base64 format. - -These must be obtained from a DAPS instance, the process of which is out of the scope of this document. Alternatively, -self-signed certificates can be used for testing: - -```shell -openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout daps.key -out daps.cert -subj "/CN=test" -export DAPS_KEY="$(cat daps.key)" -export DAPS_CERT="$(cat daps.cert)" -``` - -## Launching the application - -The following requirements must be met before launching the application: - -- Write access to a HashiCorp Vault instance is required to run this chart -- Secrets are seeded in advance - -Please also consider using [this example configuration](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-tests/deployment/src/main/resources/helm/tractusx-connector-test.yaml) -to launch the application. -Combined, run this shell command to start the in-memory Tractus-X EDC runtime: - -```shell -helm repo add tractusx-edc https://eclipse-tractusx.github.io/charts/dev -helm install my-release tractusx-edc/tractusx-connector-azure-vault --version 0.3.3 \ - -f /tractusx-connector-test.yaml -``` - -## Source Code - -- - -## Values - -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| backendService.httpProxyTokenReceiverUrl | string | `""` | | -| controlplane.affinity | object | `{}` | | -| controlplane.autoscaling.enabled | bool | `false` | Enables [horizontal pod autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) | -| controlplane.autoscaling.maxReplicas | int | `100` | Maximum replicas if resource consumption exceeds resource threshholds | -| controlplane.autoscaling.minReplicas | int | `1` | Minimal replicas if resource consumption falls below resource threshholds | -| controlplane.autoscaling.targetCPUUtilizationPercentage | int | `80` | targetAverageUtilization of cpu provided to a pod | -| controlplane.autoscaling.targetMemoryUtilizationPercentage | int | `80` | targetAverageUtilization of memory provided to a pod | -| controlplane.businessPartnerValidation.log.agreementValidation | bool | `true` | | -| controlplane.debug.enabled | bool | `false` | | -| controlplane.debug.port | int | `1044` | | -| controlplane.debug.suspendOnStart | bool | `false` | | -| controlplane.endpoints | object | `{"control":{"path":"/control","port":8083},"default":{"path":"/api","port":8080},"management":{"authKey":"","path":"/management","port":8081},"metrics":{"path":"/metrics","port":9090},"observability":{"insecure":true,"path":"/observability","port":8085},"protocol":{"path":"/api/v1/ids","port":8084}}` | endpoints of the control plane | -| controlplane.endpoints.control | object | `{"path":"/control","port":8083}` | control api, used for internal control calls. can be added to the internal ingress, but should probably not | -| controlplane.endpoints.control.path | string | `"/control"` | path for incoming api calls | -| controlplane.endpoints.control.port | int | `8083` | port for incoming api calls | -| controlplane.endpoints.default | object | `{"path":"/api","port":8080}` | default api for health checks, should not be added to any ingress | -| controlplane.endpoints.default.path | string | `"/api"` | path for incoming api calls | -| controlplane.endpoints.default.port | int | `8080` | port for incoming api calls | -| controlplane.endpoints.management | object | `{"authKey":"","path":"/management","port":8081}` | data management api, used by internal users, can be added to an ingress and must not be internet facing | -| controlplane.endpoints.management.authKey | string | `""` | authentication key, must be attached to each 'X-Api-Key' request header | -| controlplane.endpoints.management.path | string | `"/management"` | path for incoming api calls | -| controlplane.endpoints.management.port | int | `8081` | port for incoming api calls | -| controlplane.endpoints.metrics | object | `{"path":"/metrics","port":9090}` | metrics api, used for application metrics, must not be internet facing | -| controlplane.endpoints.metrics.path | string | `"/metrics"` | path for incoming api calls | -| controlplane.endpoints.metrics.port | int | `9090` | port for incoming api calls | -| controlplane.endpoints.observability | object | `{"insecure":true,"path":"/observability","port":8085}` | observability api with unsecured access, must not be internet facing | -| controlplane.endpoints.observability.insecure | bool | `true` | allow or disallow insecure access, i.e. access without authentication | -| controlplane.endpoints.observability.path | string | `"/observability"` | observability api, provides /health /readiness and /liveness endpoints | -| controlplane.endpoints.observability.port | int | `8085` | port for incoming API calls | -| controlplane.endpoints.protocol | object | `{"path":"/api/v1/ids","port":8084}` | ids api, used for inter connector communication and must be internet facing | -| controlplane.endpoints.protocol.path | string | `"/api/v1/ids"` | path for incoming api calls | -| controlplane.endpoints.protocol.port | int | `8084` | port for incoming api calls | -| controlplane.env | object | `{}` | | -| controlplane.envConfigMapNames | list | `[]` | | -| controlplane.envSecretNames | list | `[]` | | -| controlplane.envValueFrom | object | `{}` | | -| controlplane.image.pullPolicy | string | `"IfNotPresent"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy) to use | -| controlplane.image.repository | string | `""` | Which derivate of the control plane to use. when left empty the deployment will select the correct image automatically | -| controlplane.image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion | -| controlplane.ingresses[0].annotations | object | `{}` | Additional ingress annotations to add | -| controlplane.ingresses[0].certManager.clusterIssuer | string | `""` | If preset enables certificate generation via cert-manager cluster-wide issuer | -| controlplane.ingresses[0].certManager.issuer | string | `""` | If preset enables certificate generation via cert-manager namespace scoped issuer | -| controlplane.ingresses[0].className | string | `""` | Defines the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use | -| controlplane.ingresses[0].enabled | bool | `false` | | -| controlplane.ingresses[0].endpoints | list | `["ids"]` | EDC endpoints exposed by this ingress resource | -| controlplane.ingresses[0].hostname | string | `"edc-control.local"` | The hostname to be used to precisely map incoming traffic onto the underlying network service | -| controlplane.ingresses[0].tls | object | `{"enabled":false,"secretName":""}` | TLS [tls class](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) applied to the ingress resource | -| controlplane.ingresses[0].tls.enabled | bool | `false` | Enables TLS on the ingress resource | -| controlplane.ingresses[0].tls.secretName | string | `""` | If present overwrites the default secret name | -| controlplane.ingresses[1].annotations | object | `{}` | Additional ingress annotations to add | -| controlplane.ingresses[1].certManager.clusterIssuer | string | `""` | If preset enables certificate generation via cert-manager cluster-wide issuer | -| controlplane.ingresses[1].certManager.issuer | string | `""` | If preset enables certificate generation via cert-manager namespace scoped issuer | -| controlplane.ingresses[1].className | string | `""` | Defines the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use | -| controlplane.ingresses[1].enabled | bool | `false` | | -| controlplane.ingresses[1].endpoints | list | `["management","control"]` | EDC endpoints exposed by this ingress resource | -| controlplane.ingresses[1].hostname | string | `"edc-control.intranet"` | The hostname to be used to precisely map incoming traffic onto the underlying network service | -| controlplane.ingresses[1].tls | object | `{"enabled":false,"secretName":""}` | TLS [tls class](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) applied to the ingress resource | -| controlplane.ingresses[1].tls.enabled | bool | `false` | Enables TLS on the ingress resource | -| controlplane.ingresses[1].tls.secretName | string | `""` | If present overwrites the default secret name | -| controlplane.initContainers | list | `[]` | | -| controlplane.internationalDataSpaces.catalogId | string | `"TXDC-Catalog"` | | -| controlplane.internationalDataSpaces.curator | string | `""` | | -| controlplane.internationalDataSpaces.description | string | `"Tractus-X Eclipse IDS Data Space Connector"` | | -| controlplane.internationalDataSpaces.id | string | `"TXDC"` | | -| controlplane.internationalDataSpaces.maintainer | string | `""` | | -| controlplane.internationalDataSpaces.title | string | `""` | | -| controlplane.livenessProbe.enabled | bool | `true` | Whether to enable kubernetes [liveness-probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| controlplane.livenessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| controlplane.livenessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first liveness check | -| controlplane.livenessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a liveness check every 10 seconds | -| controlplane.livenessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| controlplane.livenessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| controlplane.logging | string | `".level=INFO\norg.eclipse.edc.level=ALL\nhandlers=java.util.logging.ConsoleHandler\njava.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter\njava.util.logging.ConsoleHandler.level=ALL\njava.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n"` | configuration of the [Java Util Logging Facade](https://docs.oracle.com/javase/7/docs/technotes/guides/logging/overview.html) | -| controlplane.nodeSelector | object | `{}` | | -| controlplane.opentelemetry | string | `"otel.javaagent.enabled=false\notel.javaagent.debug=false"` | configuration of the [Open Telemetry Agent](https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/) to collect and expose metrics | -| controlplane.podAnnotations | object | `{}` | additional annotations for the pod | -| controlplane.podLabels | object | `{}` | additional labels for the pod | -| controlplane.podSecurityContext | object | `{"fsGroup":10001,"runAsGroup":10001,"runAsUser":10001,"seccompProfile":{"type":"RuntimeDefault"}}` | The [pod security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod) defines privilege and access control settings for a Pod within the deployment | -| controlplane.podSecurityContext.fsGroup | int | `10001` | The owner for volumes and any files created within volumes will belong to this guid | -| controlplane.podSecurityContext.runAsGroup | int | `10001` | Processes within a pod will belong to this guid | -| controlplane.podSecurityContext.runAsUser | int | `10001` | Runs all processes within a pod with a special uid | -| controlplane.podSecurityContext.seccompProfile.type | string | `"RuntimeDefault"` | Restrict a Container's Syscalls with seccomp | -| controlplane.readinessProbe.enabled | bool | `true` | Whether to enable kubernetes [readiness-probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| controlplane.readinessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| controlplane.readinessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first readiness check | -| controlplane.readinessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a readiness check every 10 seconds | -| controlplane.readinessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| controlplane.readinessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| controlplane.replicaCount | int | `1` | | -| controlplane.resources | object | `{}` | [resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for the container | -| controlplane.securityContext.allowPrivilegeEscalation | bool | `false` | Controls [Privilege Escalation](https://kubernetes.io/docs/concepts/security/pod-security-policy/#privilege-escalation) enabling setuid binaries changing the effective user ID | -| controlplane.securityContext.capabilities.add | list | `[]` | Specifies which capabilities to add to issue specialized syscalls | -| controlplane.securityContext.capabilities.drop | list | `["ALL"]` | Specifies which capabilities to drop to reduce syscall attack surface | -| controlplane.securityContext.readOnlyRootFilesystem | bool | `true` | Whether the root filesystem is mounted in read-only mode | -| controlplane.securityContext.runAsNonRoot | bool | `true` | Requires the container to run without root privileges | -| controlplane.securityContext.runAsUser | int | `10001` | The container's process will run with the specified uid | -| controlplane.service.annotations | object | `{}` | | -| controlplane.service.type | string | `"ClusterIP"` | [Service type](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) to expose the running application on a set of Pods as a network service. | -| controlplane.tolerations | list | `[]` | | -| controlplane.url.ids | string | `""` | Explicitly declared url for reaching the ids api (e.g. if ingresses not used) | -| controlplane.volumeMounts | list | `[]` | declare where to mount [volumes](https://kubernetes.io/docs/concepts/storage/volumes/) into the container | -| controlplane.volumes | list | `[]` | [volume](https://kubernetes.io/docs/concepts/storage/volumes/) directories | -| customLabels | object | `{}` | | -| daps.clientId | string | `""` | | -| daps.paths.jwks | string | `"/jwks.json"` | | -| daps.paths.token | string | `"/token"` | | -| daps.url | string | `""` | | -| dataplane.affinity | object | `{}` | | -| dataplane.autoscaling.enabled | bool | `false` | Enables [horizontal pod autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) | -| dataplane.autoscaling.maxReplicas | int | `100` | Maximum replicas if resource consumption exceeds resource threshholds | -| dataplane.autoscaling.minReplicas | int | `1` | Minimal replicas if resource consumption falls below resource threshholds | -| dataplane.autoscaling.targetCPUUtilizationPercentage | int | `80` | targetAverageUtilization of cpu provided to a pod | -| dataplane.autoscaling.targetMemoryUtilizationPercentage | int | `80` | targetAverageUtilization of memory provided to a pod | -| dataplane.aws.accessKeyId | string | `""` | | -| dataplane.aws.endpointOverride | string | `""` | | -| dataplane.aws.secretAccessKey | string | `""` | | -| dataplane.debug.enabled | bool | `false` | | -| dataplane.debug.port | int | `1044` | | -| dataplane.debug.suspendOnStart | bool | `false` | | -| dataplane.endpoints.control.path | string | `"/api/dataplane/control"` | | -| dataplane.endpoints.control.port | int | `8083` | | -| dataplane.endpoints.default.path | string | `"/api"` | | -| dataplane.endpoints.default.port | int | `8080` | | -| dataplane.endpoints.metrics.path | string | `"/metrics"` | | -| dataplane.endpoints.metrics.port | int | `9090` | | -| dataplane.endpoints.observability.insecure | bool | `true` | allow or disallow insecure access, i.e. access without authentication | -| dataplane.endpoints.observability.path | string | `"/observability"` | observability api, provides /health /readiness and /liveness endpoints | -| dataplane.endpoints.observability.port | int | `8085` | port for incoming API calls | -| dataplane.endpoints.public.path | string | `"/api/public"` | | -| dataplane.endpoints.public.port | int | `8081` | | -| dataplane.env | object | `{}` | | -| dataplane.envConfigMapNames | list | `[]` | | -| dataplane.envSecretNames | list | `[]` | | -| dataplane.envValueFrom | object | `{}` | | -| dataplane.image.pullPolicy | string | `"IfNotPresent"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy) to use | -| dataplane.image.repository | string | `""` | Which derivate of the data plane to use. when left empty the deployment will select the correct image automatically | -| dataplane.image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion | -| dataplane.ingresses[0].annotations | object | `{}` | Additional ingress annotations to add | -| dataplane.ingresses[0].certManager.clusterIssuer | string | `""` | If preset enables certificate generation via cert-manager cluster-wide issuer | -| dataplane.ingresses[0].certManager.issuer | string | `""` | If preset enables certificate generation via cert-manager namespace scoped issuer | -| dataplane.ingresses[0].className | string | `""` | Defines the [ingress class](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class) to use | -| dataplane.ingresses[0].enabled | bool | `false` | | -| dataplane.ingresses[0].endpoints | list | `["public"]` | EDC endpoints exposed by this ingress resource | -| dataplane.ingresses[0].hostname | string | `"edc-data.local"` | The hostname to be used to precisely map incoming traffic onto the underlying network service | -| dataplane.ingresses[0].tls | object | `{"enabled":false,"secretName":""}` | TLS [tls class](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) applied to the ingress resource | -| dataplane.ingresses[0].tls.enabled | bool | `false` | Enables TLS on the ingress resource | -| dataplane.ingresses[0].tls.secretName | string | `""` | If present overwrites the default secret name | -| dataplane.initContainers | list | `[]` | | -| dataplane.livenessProbe.enabled | bool | `true` | Whether to enable kubernetes [liveness-probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| dataplane.livenessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| dataplane.livenessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first liveness check | -| dataplane.livenessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a liveness check every 10 seconds | -| dataplane.livenessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| dataplane.livenessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| dataplane.logging | string | `".level=INFO\norg.eclipse.edc.level=ALL\nhandlers=java.util.logging.ConsoleHandler\njava.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter\njava.util.logging.ConsoleHandler.level=ALL\njava.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n"` | configuration of the [Java Util Logging Facade](https://docs.oracle.com/javase/7/docs/technotes/guides/logging/overview.html) | -| dataplane.nodeSelector | object | `{}` | | -| dataplane.opentelemetry | string | `"otel.javaagent.enabled=false\notel.javaagent.debug=false"` | configuration of the [Open Telemetry Agent](https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/) to collect and expose metrics | -| dataplane.podAnnotations | object | `{}` | additional annotations for the pod | -| dataplane.podLabels | object | `{}` | additional labels for the pod | -| dataplane.podSecurityContext | object | `{"fsGroup":10001,"runAsGroup":10001,"runAsUser":10001,"seccompProfile":{"type":"RuntimeDefault"}}` | The [pod security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod) defines privilege and access control settings for a Pod within the deployment | -| dataplane.podSecurityContext.fsGroup | int | `10001` | The owner for volumes and any files created within volumes will belong to this guid | -| dataplane.podSecurityContext.runAsGroup | int | `10001` | Processes within a pod will belong to this guid | -| dataplane.podSecurityContext.runAsUser | int | `10001` | Runs all processes within a pod with a special uid | -| dataplane.podSecurityContext.seccompProfile.type | string | `"RuntimeDefault"` | Restrict a Container's Syscalls with seccomp | -| dataplane.readinessProbe.enabled | bool | `true` | Whether to enable kubernetes [readiness-probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| dataplane.readinessProbe.failureThreshold | int | `6` | when a probe fails kubernetes will try 6 times before giving up | -| dataplane.readinessProbe.initialDelaySeconds | int | `30` | seconds to wait before performing the first readiness check | -| dataplane.readinessProbe.periodSeconds | int | `10` | this fields specifies that kubernetes should perform a liveness check every 10 seconds | -| dataplane.readinessProbe.successThreshold | int | `1` | number of consecutive successes for the probe to be considered successful after having failed | -| dataplane.readinessProbe.timeoutSeconds | int | `5` | number of seconds after which the probe times out | -| dataplane.replicaCount | int | `1` | | -| dataplane.resources | object | `{}` | [resource management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for the container | -| dataplane.securityContext.allowPrivilegeEscalation | bool | `false` | Controls [Privilege Escalation](https://kubernetes.io/docs/concepts/security/pod-security-policy/#privilege-escalation) enabling setuid binaries changing the effective user ID | -| dataplane.securityContext.capabilities.add | list | `[]` | Specifies which capabilities to add to issue specialized syscalls | -| dataplane.securityContext.capabilities.drop | list | `["ALL"]` | Specifies which capabilities to drop to reduce syscall attack surface | -| dataplane.securityContext.readOnlyRootFilesystem | bool | `true` | Whether the root filesystem is mounted in read-only mode | -| dataplane.securityContext.runAsNonRoot | bool | `true` | Requires the container to run without root privileges | -| dataplane.securityContext.runAsUser | int | `10001` | The container's process will run with the specified uid | -| dataplane.service.port | int | `80` | | -| dataplane.service.type | string | `"ClusterIP"` | [Service type](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) to expose the running application on a set of Pods as a network service. | -| dataplane.tolerations | list | `[]` | | -| dataplane.url.public | string | `""` | Explicitly declared url for reaching the public api (e.g. if ingresses not used) | -| dataplane.volumeMounts | list | `[]` | declare where to mount [volumes](https://kubernetes.io/docs/concepts/storage/volumes/) into the container | -| dataplane.volumes | list | `[]` | [volume](https://kubernetes.io/docs/concepts/storage/volumes/) directories | -| fullnameOverride | string | `""` | | -| imagePullSecrets | list | `[]` | Existing image pull secret to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry) | -| nameOverride | string | `""` | | -| postgresql.enabled | bool | `false` | | -| postgresql.jdbcUrl | string | `""` | | -| postgresql.password | string | `""` | | -| postgresql.username | string | `""` | | -| serviceAccount.annotations | object | `{}` | | -| serviceAccount.create | bool | `true` | | -| serviceAccount.imagePullSecrets | list | `[]` | Existing image pull secret bound to the service account to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry) | -| serviceAccount.name | string | `""` | | -| vault.hashicorp.healthCheck.enabled | bool | `true` | | -| vault.hashicorp.healthCheck.standbyOk | bool | `true` | | -| vault.hashicorp.paths.health | string | `"/v1/sys/health"` | | -| vault.hashicorp.paths.secret | string | `"/v1/secret"` | | -| vault.hashicorp.timeout | int | `30` | | -| vault.hashicorp.token | string | `""` | | -| vault.hashicorp.url | string | `""` | | -| vault.secretNames.dapsPrivateKey | string | `"daps-private-key"` | | -| vault.secretNames.dapsPublicKey | string | `"daps-public-key"` | | -| vault.secretNames.transferProxyTokenEncryptionAesKey | string | `"transfer-proxy-token-encryption-aes-key"` | | -| vault.secretNames.transferProxyTokenSignerPrivateKey | string | `"transfer-proxy-token-signer-private-key"` | | -| vault.secretNames.transferProxyTokenSignerPublicKey | string | `"transfer-proxy-token-signer-public-key"` | | - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.10.0](https://github.com/norwoodj/helm-docs/releases/v1.10.0) diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/README.md deleted file mode 100644 index 17ad45b1422..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/README.md +++ /dev/null @@ -1,54 +0,0 @@ -# Tractus-X EDC - -The Tractus-X EDC repository creates runnable applications out of EDC extensions from -the [Eclipse DataSpace Connector](https://github.com/eclipse-edc/Connector) repository. - -When running a EDC connector from the Tractus-X EDC repository there are three setups to choose from. They only vary by -using different extensions for - -- Resolving of Connector-Identities -- Persistence of the Control-Plane-State -- Persistence of Secrets (Vault) - -## Connector Setup - -The three supported setups are. - -- Setup 1: Pure in Memory **Not intended for production use!** - - [Control Plane](../edc-controlplane/edc-runtime-memory/README.md) - - [IDS DAPS Extensions](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/iam/oauth2/daps) - - In Memory Persistence done by using no extension - - In Memory Keyvault with seedable secrets. - - [Data Plane](../edc-dataplane/edc-dataplane-azure-vault/README.md) - - [Azure Key Vault Extension](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/vault/azure-vault) -- Setup 2: PostgreSQL & Azure Vault - - [Control Plane](../edc-controlplane/edc-controlplane-postgresql/README.md) - - [IDS DAPS Extensions](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/iam/oauth2/daps) - - [PostgreSQL Persistence Extensions](https://github.com/eclipse-edc/Connector/tree/main/extensions/control-plane/store/sql) - - [Azure Key Vault Extension](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/vault/azure-vault) - - [Data Plane](../edc-dataplane/edc-dataplane-azure-vault/README.md) - - [Azure Key Vault Extension](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/vault/azure-vault) -- Setup 3: PostgreSQL & HashiCorp Vault - - [Control Plane](../edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/README.md) - - [IDS DAPS Extensions](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/iam/oauth2/daps) - - [PostgreSQL Persistence Extensions](https://github.com/eclipse-edc/Connector/tree/main/extensions/control-plane/store/sql) - - [HashiCorp Vault Extension](../edc-extensions/hashicorp-vault/README.md) - - [Data Plane](../edc-dataplane/edc-dataplane-hashicorp-vault/README.md) - - [HashiCorp Vault Extension](../edc-extensions/hashicorp-vault/README.md) - -## Recommended Documentation - -### This Repository - -- [Update EDC Version from 0.0.x - 0.1.x](migration/Version_0.0.x_0.1.x.md) -- [Application: Control Plane](../edc-controlplane) -- [Application: Data Plane](../edc-dataplane) -- [Extension: Business Partner Numbers](../edc-extensions/business-partner-validation/README.md) -- [Example: Local TXDC Setup](samples/Local%20TXDC%20Setup.md) -- [Example: Data Transfer](samples/Transfer%20Data.md) - -### Eclipse Dataspace Connector - -- [EDC Domain Model](https://github.com/eclipse-edc/Connector/blob/main/docs/developer/architecture/domain-model.md) -- [EDC Open API Spec](https://github.com/eclipse-edc/Connector/blob/main/resources/openapi/openapi.yaml) -- [HTTP Receiver Extension](https://github.com/eclipse-edc/Connector/tree/main/extensions/control-plane/http-receiver) diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/Release.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/Release.md deleted file mode 100644 index 5f2fbd74daf..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/Release.md +++ /dev/null @@ -1,48 +0,0 @@ -# Release - -## Prerequisites - -[![Apache Maven][maven-shield]][maven-url] - -## Update DEPENDENCIES file - -### 1. Setup Eclipse Dash License Tool locally - -For instructions on how to download the Eclipse Dash Tool executable, refer to the -project's [GitHub page](https://github.com/eclipse/dash-licenses#get-it). - -### 2. Generate DEPENDENCIES file - -The following call generates the dependencies file. This list is populated by deriving dependencies using the build tool (i.e., -gradle), analysing them using an IP tool (i.e., Eclipse Dash Tool), and decorating the resulting report with additional -information using a custom script. - -Execute the gradle task `allDependencies` for creating an integrated dependency report over all sub-modules of the -project (including isolated modules). To process the dependencies of a specific module (e.g., an individual launcher) -execute the standard `dependencies` task. - -First, the dependencies of this module are calculated with gradle and passed to the Dash tool: - -```shell -gradle allDependencies | grep -Poh "(?<=\s)[\w.-]+:[\w.-]+:[^:\s]+" | sort | uniq | java -jar /path/org.eclipse.dash.licenses-0.0.1-SNAPSHOT.jar - -summary DEPENDENCIES -``` - -_Note: on some machines (e.g. macOS) [the ack tool](https://beyondgrep.com/install/) should be used instead of `grep`._ - -### 3. Resolve restricted Dependencies - -If a dependency is `restricted`, it is not approved by the Eclipse Foundation, yet. -The Eclipse Bot is able to approve dependencies automatically, if the license can be resolved by ClearlyDefined. - -1. (optional) Visit and harvest the dependency - from maven central. -2. Create the Eclipse IP Issues or ask an Eclipse Commiter to do this for you. - -## 4. Update OpenAPI docs - -As part of the [kits documentation provided for docusaurus](../kit/development-view/page00_development_view.md) we provide an OpenAPI reference. -This refers to the [EDC API](https://github.com/eclipse-edc/Connector/tree/main/resources/openapi) and needs to be updated to the current release. -The yaml files found there are then converted with the [docusaurus openapi plugin](https://www.npmjs.com/package/docusaurus-plugin-openapi-docs). - -[maven-shield]: https://img.shields.io/badge/Apache%20Maven-URL-blue -[maven-url]: https://maven.apache.org diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/Run-business-tests-local.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/Run-business-tests-local.md deleted file mode 100644 index cab17c6c2e3..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/Run-business-tests-local.md +++ /dev/null @@ -1,161 +0,0 @@ -# Run and debug Business-Tests local within IDE - -Prerequisites: - -- You need a local kubernetes cluster to install the services (Docker Desktop is recommended). -- You need kubectl and helm command line tools installed. - -## 1. Build all modules with maven and produce docker images - -```shell -./gradlew dockerize -``` - -## 2. Install the all-in-one supporting infrastructure environment (Daps, Vault, PostgreSql, Minio, Backend-Service) - -```shel -helm install infrastructure edc-tests/src/main/resources/deployment/helm/supporting-infrastructure -n business-tests --dependency-update --create-namespace -``` - -To access the PostgreSql databases you could use following kubectl port forwardings: - -```shell -kubectl port-forward plato-postgresql-0 -n business-tests 5555:5432 -kubectl port-forward sokrates-postgresql-0 -n business-tests 6666:5432 -``` - -Please use the same ports later for your environment variables. - -## 3. Install Plato as provider EDC - -```shell -helm install plato charts/tractusx-connector -n business-tests --create-namespace \ - --set fullnameOverride=plato \ - --set controlplane.service.type=NodePort \ - --set controlplane.endpoints.data.authKey=password \ - --set controlplane.image.pullPolicy=Never \ - --set controlplane.image.tag=latest \ - --set controlplane.image.repository=edc-controlplane-postgresql-hashicorp-vault \ - --set dataplane.image.tag=latest \ - --set dataplane.image.pullPolicy=Never \ - --set dataplane.image.repository=edc-dataplane-hashicorp-vault \ - --set controlplane.debug.enabled=true \ - --set controlplane.suspendOnStart=false \ - --set postgresql.enabled=true \ - --set postgresql.username=user \ - --set postgresql.password=password \ - --set postgresql.jdbcUrl=jdbc:postgresql://plato-postgresql:5432/edc \ - --set vault.hashicorp.enabled=true \ - --set vault.hashicorp.url=http://vault:8200 \ - --set vault.hashicorp.token=root \ - --set vault.secretNames.transferProxyTokenSignerPublicKey=plato/daps/my-plato-daps-crt \ - --set vault.secretNames.transferProxyTokenSignerPrivateKey=plato/daps/my-plato-daps-key \ - --set vault.secretNames.transferProxyTokenEncryptionAesKey=plato/data-encryption-aes-keys \ - --set vault.secretNames.dapsPrivateKey=plato/daps/my-plato-daps-key \ - --set vault.secretNames.dapsPublicKey=plato/daps/my-plato-daps-crt \ - --set daps.url=http://ids-daps:4567 \ - --set daps.clientId=99:83:A7:17:86:FF:98:93:CE:A0:DD:A1:F1:36:FA:F6:0F:75:0A:23:keyid:99:83:A7:17:86:FF:98:93:CE:A0:DD:A1:F1:36:FA:F6:0F:75:0A:23 \ - --set dataplane.aws.endpointOverride=http://minio:9000 \ - --set dataplane.aws.secretAccessKey=platoqwerty123 \ - --set dataplane.aws.accessKeyId=platoqwerty123 \ - --set backendService.httpProxyTokenReceiverUrl=http://backend:8080 \ - --wait-for-jobs --timeout=120s -``` - -## 4. Install Socrates as consumer EDC - -```shell -helm install sokrates charts/tractusx-connector -n business-tests --create-namespace \ - --set fullnameOverride=sokrates \ - --set controlplane.service.type=NodePort \ - --set controlplane.endpoints.data.authKey=password \ - --set controlplane.image.pullPolicy=Never \ - --set controlplane.image.tag=latest \ - --set controlplane.image.repository=edc-controlplane-postgresql-hashicorp-vault \ - --set dataplane.image.tag=latest \ - --set dataplane.image.pullPolicy=Never \ - --set dataplane.image.repository=edc-dataplane-hashicorp-vault \ - --set controlplane.debug.enabled=true \ - --set controlplane.suspendOnStart=false \ - --set postgresql.enabled=true \ - --set postgresql.username=user \ - --set postgresql.password=password \ - --set postgresql.jdbcUrl=jdbc:postgresql://sokrates-postgresql:5432/edc \ - --set vault.hashicorp.enabled=true \ - --set vault.hashicorp.url=http://vault:8200 \ - --set vault.hashicorp.token=root \ - --set vault.secretNames.transferProxyTokenSignerPublicKey=sokrates/daps/my-sokrates-daps-crt \ - --set vault.secretNames.transferProxyTokenSignerPrivateKey=sokrates/daps/my-sokrates-daps-key \ - --set vault.secretNames.transferProxyTokenEncryptionAesKey=sokrates/data-encryption-aes-keys \ - --set vault.secretNames.dapsPrivateKey=sokrates/daps/my-sokrates-daps-key \ - --set vault.secretNames.dapsPublicKey=sokrates/daps/my-sokrates-daps-crt \ - --set daps.url=http://ids-daps:4567 \ - --set daps.clientId=E7:07:2D:74:56:66:31:F0:7B:10:EA:B6:03:06:4C:23:7F:ED:A6:65:keyid:E7:07:2D:74:56:66:31:F0:7B:10:EA:B6:03:06:4C:23:7F:ED:A6:65 \ - --set dataplane.aws.endpointOverride=http://minio:9000 \ - --set dataplane.aws.secretAccessKey=sokratesqwerty123 \ - --set dataplane.aws.accessKeyId=sokratesqwerty123 \ - --set backendService.httpProxyTokenReceiverUrl=http://backend:8080 \ - --wait-for-jobs --timeout=120s -``` - -## 5. Set environment variables and run configuration in IDE - -You can create a run configuration in IntelliJ like bellow screenshot and copy/paste the whole set of environments variables if you use ";" after each line. - -![Example run config](run-config.png) - -```shell -PLATO_BACKEND_SERVICE_BACKEND_API_URL=http://localhost:; -PLATO_DATA_MANAGEMENT_API_AUTH_KEY=password; -PLATO_DATA_MANAGEMENT_URL=http://localhost:/data; -PLATO_DATA_PLANE_URL=foo; -PLATO_DATABASE_PASSWORD=password; -PLATO_DATABASE_URL=jdbc:postgresql://localhost:5555/edc; -PLATO_DATABASE_USER=user; -PLATO_IDS_URL=http://plato-controlplane:8084/api/v1/ids; -PLATO_AWS_SECRET_ACCESS_KEY=platoqwerty123; -PLATO_AWS_ACCESS_KEY_ID=platoqwerty123; -SOKRATES_BACKEND_SERVICE_BACKEND_API_URL=http://localhost:; -SOKRATES_BACKEND_URL=http://localhost:; -SOKRATES_DATA_MANAGEMENT_API_AUTH_KEY=password; -SOKRATES_DATA_MANAGEMENT_URL=http://localhost:/data; -SOKRATES_DATA_PLANE_URL=foo; -SOKRATES_DATABASE_PASSWORD=password; -SOKRATES_DATABASE_URL=jdbc:postgresql://localhost:6666/edc; -SOKRATES_DATABASE_USER=user; -SOKRATES_IDS_URL=http://sokrates-controlplane:8084/api/v1/ids; -SOKRATES_AWS_SECRET_ACCESS_KEY=sokratesqwerty123; -SOKRATES_AWS_ACCESS_KEY_ID=sokratesqwerty123; -EDC_AWS_ENDPOINT_OVERRIDE=http://localhost:32000 -``` - -The services are using NodePort to expose the endpoints therefore the ports are not fix and needs to be determined after each deployment. -To determine the current ports you can use the following kubectl command: - -```shell -kubectl get svc -n business-tests -o go-template='{{range .items}}{{ $save := . }}{{range.spec.ports}}{{if .nodePort}}{{$save.metadata.namespace}}{{"/"}}{{$save.metadata.name}}{{" - "}}{{.name}}{{": "}}{{.nodePort}}{{"("}}{{.port}}{{")"}}{{"\n"}}{{end}}{{end}}{{end}}' -``` - -This will return all NodePorts which are available in business-tests namespace where you can pick the ports to use in your environment variables. -Now you are able to run it in IDE either as normal "Run" mode or in "Debug" mode where you can debug the business-tests by setting debugging points. - -Example of mapping to environment variables needed for the business tests: - -```shell -business-tests/plato-controlplane - data: 30955(8081) -> PLATO_DATA_MANAGEMENT_URL=http://localhost:30955/data; -business-tests/sokrates-controlplane - data: 30538(8081) -> SOKRATES_DATA_MANAGEMENT_URL=http://localhost:30538/data; -business-tests/backend - backend: 30556(8081) -> SOKRATES_BACKEND_SERVICE_BACKEND_API_URL= http://localhost:30556 -``` - -## 6. Update your components - -Once everything is installed you just need to update your services when you have a new image. - -```shell -helm upgrade plato charts/tractusx-connector --recreate-pods -helm upgrade sokrates charts/tractusx-connector --recreate-pods -``` - -## 7. Tips - -If you use the kubernetes within Docker Desktop you have direct access to the images which you have created with Docker Desktop they are using the same docker daemon. So you don't need to transfer it in your k8s cluster. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/coding-principles.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/coding-principles.md deleted file mode 100644 index 624186c4675..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/coding-principles.md +++ /dev/null @@ -1,138 +0,0 @@ -# Coding Principles and Style Guide - -## Fail-fast and Explicit Configuration - -1. Configuration should be loaded and validated at extension initialization so that issues are reported immediately. Do - not lazy-load configuration unless it is required to do so. -2. Settings can be pulled from the extension context and placed into configuration objects, which are passed to services - via their constructor. -3. Service configuration requirements should always be explicit; as a general rule, do not pass a single configuration - object with many values to multiple services. -4. Annotate configuration keys with `@Setting` so that they may be tracked. - -## Errors - -1. Do not throw checked exceptions; always use unchecked exceptions. If an unchecked exception type needs to be defined, - inherit from `org.eclipse.edc.spi.EdcException`. -2. Do not throw exceptions to signal a validation error; report the error (preferably collated) and return an error - response. -3. Throw an unchecked exception if something unexpected happens (e.g. a backing store connection is down after a number - of retries). Note that validation errors are expected. -4. Only throw an exception when there is no remediation possible, i.e. the exception is fatal. Do not throw an exception - if an operation can be retried. -5. Generally, services should return a `org.eclipse.edc.spi.result.Result` (or a suitable subclass). - -## Simplicity - -1. Avoid layers of indirection when they are not needed (e.g. "pass-through methods"). -2. Avoid needlessly wrapping objects, especially primitive datatypes. - -## General Coding Style - -1. Use `var` instead of explicit types (helps with clarity) -2. Avoid `final` in method args and local variables -3. Use `final` in field declarations -4. Avoid `static` fields except in constants or when absolutely necessary (you should be able to provide a reason). -5. Use interfaces to define shared constants -6. Use "minimally required types" (or "smallest possible API"), e.g. use `ObjectMapper` instead of `TypeManager`, or use - a `String` instead of a more complex object containing the String, etc. -7. Use either `public` members, which are documented and tested, or `private` members. -8. Avoid package-private members, especially if only needed for testing -9. Avoid `protected` members unless they're intended to be overridden. -10. Use package-private classes if they're not needed outside the package, e.g. implementation classes -11. Avoid using `enum`s for anything other than named integer enumerations. -12. Avoid using static classes as much as possible. Exceptions to this are helper functions and test utils, etc. as well - as static inner classes. -13. Use only camel case and no prefixes for naming. -14. Avoid unnecessary `this.` except when it is necessary e.g. when there is a name overlap -15. Use static imports, as long as code readability and comprehension is not impacted. For example, - - use `assertThat(...)` instead of `Assertions.assertThat(...)` - - use `format("...",arg1)` instead of `String.format(...)`, but - - avoid `of(item1, item2).map(it -> it.someOperation)...` instead of `Stream.of(item1, item2)`. - Also, avoid static imports if two static methods with the same name would be imported from different classes -16. Avoid `Optional` as method return type or method argument, except when designing a fluent API. Use `null` in - signatures. -17. Avoid cryptic variable names, especially in long methods. Instead, try to write them out, at least to a reasonable - extent. - -## Testing - -1. All handlers and services should have dedicated unit tests with mocks used for dependencies. -2. Prefer unit tests over all other test types: unit > integration/component > e2e -3. When appropriate, prefer composing services via the constructor so that dependencies can be mocked as opposed to - instantiating dependencies directly. -4. Use classes with static test functions to provide common helper methods, e.g. to instantiate an object. -5. Use `[METHOD]_when[CONDITION]_should[EXPECTATION]` as naming template for test methods, - e.g. `verifyInput_whenNull_shouldThrowNpe()` as opposed to `testInputNull()` - -## Data Objects - -1. Use the `Builder` pattern when: - - there are any number of optional constructor args - - there are more than 3 constructor args - - inheriting from an object that fulfills any of the above. In this case use derived builders as well. -2. Although serializability is not the reason we use the builder pattern, it is a strong indication that a builder - should be used. -3. Builders should be named just `Builder` and be static nested classes. -4. Create a `public static Builder newInstance(){...}` method to instantiate the builder -5. Builders have non-public constructors -6. Use single-field builders: a `Builder` instantiates the object it builds in its constructor, and sets the properties - in its builder methods. The `build()` method then only performs verification (optional) and returns the instance. -7. Use `private` constructors for the objects that the builder builds. -8. If there is a builder for an object, use it to deserialize an object, i.e. put Jackson annotations such - as `JsonCreator` and `@JsonBuilder` on builders. -9. Note that the motivation behind use of builders is not for immutability (although that may be good in certain - circumstances). Rather, it is to make code less error-prone and - simpler given the lack of named arguments and optional parameters in Java. - -## Secrets - -1. Only store secrets in the `Vault` and do not hold them in objects that may be persisted to other stores. -2. Do not log secrets or sensitive information. - -## Extensions and Libraries - -1. Extension modules contribute a feature to the runtime such as a service. -2. SPI modules define extensibility points in the runtime. There is a core SPI module that defines extensibility for - essential runtime features. There are other SPI modules that - define extensibility points for optional features such as IDS. -3. Libraries are utility modules that provide classes which may be used by other modules. They do not directly - contribute features to the runtime. -4. An SPI module may only reference other SPI modules and library modules. -5. An Extension module may only reference other SPI modules and library modules. -6. A library module may only reference other library modules. - -## Build - -1. There should only be a root `gradle.properties` that contains build variables. Do not create separate - `gradle.properties` files in a module. -2. For external dependencies, do not reference the version directly. Instead, use - the version catalog feature. - -## Handling Null Return Values - -1. In certain situations, `null` may need to be returned from a method, passed as a parameter, or set on a field. Only - use `Optional` if a method is part of a fluent API. - Since the runtime will rarely require this, the project standard is to use the `org.jetbrains.annotations.Nullable` - and `org.jetbrains.annotations.NotNull` annotations. - -## Objects Serialization/Deserialization - -1. `TypeManager` is the component responsible for json ser/des, you can also use the `ObjectMapper` inside it, but there - should be no other `ObjectMapper` instance. - -## Class Naming - -1. A single implementor of an interface should be named `Impl`. -2. An implementor who is meant to be the default implementation for an interface but other are/can be defined used - instead. - -## Observability - -Services can implement one the following interfaces: `ReadinessProvider`, `LivenessProvider`, `StartupStatusProvider` -and register with the `HealthCheckService`, thus reporting the service's readiness status through the observability API. - -## Streams - -1. Always close explicitly `Stream` objects that are returned by a service/store, since they could carry a connection, - which otherwise would leak. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-02-09-release-process/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-02-09-release-process/README.md deleted file mode 100644 index 4b2771c0ae8..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-02-09-release-process/README.md +++ /dev/null @@ -1,118 +0,0 @@ -# Release process of tractusx-edc - -## Decision - -To improve stability, reproducibility and maintainability of releases, tractusx-edc will undergo the following changes: - -- use EDC `SNAPSHOT` builds during development -- use release versions of EDC in releases. Release branches must not change upstream dependency versions, unless there - is a clear and concise reason to do so. -- slightly update branching model -- if possible, bugs/defects should be fixed on `main` and be backported to the respective `hotfix/` branch -- only hotfixes for critical security bugs will be provided as defined by the committers for the - currently released version. Nothing else. -- feature development happens _in developers' forks only_ to keep the Git reflog of the `origin` clean. - -## Rationale - -Having releases depend on snapshot versions of upstream projects, such as EDC, is inherently dangerous, particularly -when that dependency has not yet reached a final state and breaking changes are to be expected. Most problems will stem -from breaking changes, such as Java SPIs, APIs and changes in service contracts. - -Up until now, the only way out was cherry-picking, which is extremely cumbersome and error-prone, and requires a -parallel build pipeline to publish the cherry-picked artifacts of EDC (and potentially others). With the approach -presented here, cherry-picking is still an option, but there are easier alternatives to it. - -Every release version published by tractusx-edc must be reproducible at any time. - -## Approach - -### Use EDC `SNAPSHOT` versions during development - -During feature development we only use `-SNAPSHOT` versions of EDC packages. It is assumed that when the build breaks -due to changes in upstream, the fix can be done quickly and easily, much more so than working off technical -debt that would otherwise accumulate over several months. Builds on `main` are therefore _not repeatable_, but that -downside is easily offset by the tighter alignment with and smaller technical debt and integration pain with the -upstream EDC. - -### Use release versions of EDC in releases - -First, a new branch `release/X.Y.Z` based off of `main` is created. This can either be done -on `HEAD`, or - if desired - on a particular ref. The latter case is relevant if there are already features -in `main` that are not scoped for a particular release. - -Second, the dependency onto EDC is updated to the most recent build. For example, if a release is -created on March 27th 2023, the most recent nightly would be `0.0.1-20230326`. - -_Updating Gradle files or Maven POMs, creating branches and tags in Git should be automated through GitHub Actions as -part of the release process. For reference_: - -- Modifying and committing files: -- Creating branches: -- Creating tags using GitHub's - API: ( - example) -- Create GitHub Release: (example) - -Once a release is created, the EDC upstream version must not change anymore, unless there is good reason to do so, for -example, a defect, that needs to be fixed upstream. At that point a decision can also be made to employ a cherry-pick model, in case the -upstream's development has progressed to the point of breaking changes. - -### Changes to the branching model - -Tractusx-edc's branching model is already very close to -the [GitFlow branching model](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow#:~:text=What%20is%20Gitflow%3F,lived%20branches%20and%20larger%20commits) -which is good. The following changes need to be made: - -- feature development happens in forks only. Thus, `feature/` branches don't exist in the `origin`. This is important - when moving to OSS. -- adhere to GitFlow branch naming conventions, i.e. no `docu`, `tryout_something` branches. Increases readability and - clarity, improves tool support. - -_Other guidelines w.r.t. the review process, merging etc. will follow in a later DR._ - -## Further considerations - -### A word on Bugfixes/Hotfixes - -Once a release is published, for example `0.3.1` it will receive no further development other than hotfixes. Similarly, -hotfix branches are created based off of the release branch, here `releases/0.3.1`, thus, `hotfix/0.3.1`. From this, -three scenarios emerge: - -1. The actual fix is done on `main` and can be cherry-picked into the `hotfix/0.3.1` branch. No new commits are - made directly in that branch. -2. The actual fix is done on `main` and must be manually ported into the `hotfix/0.3.1` branch. One or several new - commits are made on `hotfix/0.3.1`. This is needed when cherry-picking is not available due to incompatibilities - between `main` and the hotfix branch due to intermittent changes. -3. The fix is only relevant for the `0.3.1` hotfix, it is not needed in `main`. This can happen, when the problem is - not present on `main`, because it was already implicitly fixed, or otherwise doesn't exist. - -This might produce many branches, and the first `hotfix` makes the release obsolete, but it will greatly help -readability and make a release's history readily apparent. - -### Nightly builds - -Nightly builds are generated according to a fixed schedule. Upstream EDC will soon begin to publish nightly -builds as actual releases (as opposed to: snapshots) to a separate OSSRH-operated repository (see -[this EDC decision record](https://github.com/eclipse-edc/Connector/tree/main/docs/developer/decision-records/2023-02-10-nightly-builds)). - -Unfortunately there is no way to automatically trigger the tractusx-edc build whenever a new EDC nightly is -created. The most reliable method is to periodically query for the latest EDC nightly, e.g. leveraging GitHub's -`dependabot` feature, or using the following `curl` command: - -```shell -curl /org/eclipse/edc/connector-core/maven-metadata.xml | xmllint --xpath "//metadata/versioning/versions/version[last()]" - -``` - -That would return something like to `0.0.1-20230213`. As soon as the version string (here: Feb 13th, 2023) matches the -current date, we can start the nightly. If the EDC nightly doesn't appear within a set timeframe, we throw an error. - -## Notes for becoming OpenSource - -- All artifacts (docker images, helm charts, Maven artifacts) should be published to well-known and publicly accessible - locations such as MavenCentral, DockerHub, etc. The GitHub Packages repository is only accessible to authenticated - users. -- When the project was migrated to be an Eclipse project, we'll have to adopt the Eclipse Foundation's publishing guidelines, - which prescribes the use of Jenkins for publishing to MavenCentral and OSSRH. -- Typically, GitHub Actions should perform all verification tasks, running tests, etc. and Jenkins' only purpose is to - publish. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-02-27_testing/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-02-27_testing/README.md deleted file mode 100644 index 0d12ab35320..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-02-27_testing/README.md +++ /dev/null @@ -1,86 +0,0 @@ -# Testing concept for tractusx-edc - -## Decision - -Henceforth, testing shall be done in accordance with the herein outlined rules and definitions. As the guiding principles we shall establish: - -- separation-of-concerns -- fast test execution speed -- debuggability -- low resource footprint -- leverage features provided by, and adopt standards set by the [Eclipse Dataspace Project](https://github.com/eclipse-edc/Connector) -- easy setup on developer systems - -## Rationale - -Past experiences with tractusx-edc's testing setup has shown that it is time- and resource-consuming, which also makes it unreliable at times. -Furthermore, a finer-grained test classification such as the one outlined in this document is currently neither present nor documented. - -### Definitions and distinction - -This section is largely taken from the [EDC's testing documentation](https://github.com/eclipse-edc/Connector/blob/bab97cccf4d61a3a380a1d70925b34f4cec1b401/docs/developer/testing.md) with a few amendments. - -- **unit tests**: test one single class by mocking/stubbing all collaborating objects. - -- **integration tests**: test one particular aspect of a software, that may involve external systems. Example: testing a particular object store based on PostgreSQL. External systems are to be provided out-of-band, e.g. through a CI pipeline or a script that runs on a local machine. Starting external systems from code violates the separation of concerns and it may also cause problems on some systems, e.g. when docker is not on the `PATH`, or not available at all. Integration tests typically only involve parts of a connector. A _component test_ is a special form of an integration test, where real collaborators, but no external systems are used. - -- **system tests**: rely on the _entire system_ being present. This is specific for each variant, for example testing a request against a system's API and verifying that a particular entry was created in the database. System tests involve _one connector_ and the external service. - -- **end-to-end-tests**: similar to system tests, but they involve several connectors plus external services such as databases, identity providers, objects stores, etc. This type of test is used to verify that certain business requirements are fulfilled by simulating real user scenarios from start to finish, hence they are sometimes dubbed "business tests". For example, one would send a data request to a connector's public API and expect the connector to behave in a certain way and expect a certain response back. To keep things simple, end-to-end tests can be conjoined with system tests. - -- **deployment tests**: tests deployment artifacts such a Docker images or a Helm charts. The purpose of such a test is to verify the correct configuration and composition of an artifact, its purpose is _not_ to test application logic. However, we can use normal requests to _verify_ the correct installation. Sometimes this is referred to as "Smoke test". - -- **performance tests**: measure whether a certain iteration of the software fulfills pre-established performance goals. These tests are highly specific and may have dependencies onto specific hardware and network parameters. - -It is a [well-established](https://martinfowler.com/articles/practical-test-pyramid.html) fact that unit tests should make up for the majority of tests, because they are easy and quick to write and quick to execute, whereas integration and end-to-end tests are usually more complex and time-consuming to write and run. - -## Approach - -Generally we should aim at writing unit tests rather than integration tests, because they are simpler, more stable and typically run faster. Sometimes that's not (easily) possible, especially when an implementation relies on an external system that is not easily mocked or stubbed such as cloud-based databases. - -Therefore, in many cases writing unit tests is more involved that writing an integration test, for example say we wanted to test our implementation of a PostgreSQL-backed queue. We would have to mock the behaviour of the PostgreSQL API, which - while certainly possible - can get complicated pretty quickly. Now we still might do that for simpler scenarios, but -eventually we might want to write an integration test that uses a (containerized) PostgreSQL test instance. - -### Adopt a "local-first" mindset - -EDC provides a way to launch (multiple) embedded connector runtimes from within the JVM using the JUnit runner, see [this module](https://github.com/eclipse-edc/Connector/tree/main/system-tests/e2e-transfer-test/runner/src/test/java/org/eclipse/edc/test/e2e) and the [test runtime extension](https://github.com/eclipse-edc/Connector/blob/main/core/common/junit/src/main/java/org/eclipse/edc/junit/extensions/EdcRuntimeExtension.java) for reference. All tests except deployment tests should be implemented using this feature to offer an easily debuggable and maintainable test suite. We call this a "local first" mindset, because we primarily aim at running a test locally (possibly using manual setup of external services). Once we have that, we can execute the test in the same way on CI runners. It should not matter whether we run tests on developer machines or on CI runners. - -> As a general rule of thumb, we should aim at running as much code from the JVM as opposed to: in external runtimes such as Docker or Kubernetes. - -### Running tests in CI - -External systems such as databases or identity providers should be setup "out-of-band" of the test, using a script or the CI pipeline's declarative syntax (e.g. GitHub Actions' `services` feature). If possible, we should employ external systems in a self-contained way, e.g. using docker containers, because that increases portability and decreases the potential for conflict, e.g. in always-on databases. - -### DO - -- use integration tests sparingly and only when unit tests are not practical -- deploy the external system as service directly in the workflow or -- use a dedicated always-on test instance if provisioning is complicated and time-consuming (e.g. CosmosDB) -- adopt a local-first mindset, i.e. aim at running test code inside the JVM. -- take into account that external systems might experience transient failures or have degraded performance, so test - methods should have a timeout so as not to block the runner indefinitely. -- use randomized strings for things like database/table/bucket/container names, etc., especially when the external - system does not get destroyed after the test. -- use the class annotations provided by EDC to categorize and configure test execution - -### DO NOT - -- try to cover everything with integration tests. It's typically a code smell if there are no corresponding unit tests - for an integration test. -- slip into a habit of testing the external system rather than your usage of it -- store secrets directly in the code. Github will warn about that. -- perform complex external system setup in @BeforeEach or @BeforeAll -- write tests that are opaque, or can only run in certain enviroments -- use Test Containers, as it violates the separation of concerns. If external systems are needed, it should be an integration test. - -## Test execution strategies - -This section explains _at which point in time_ we should execute which test. This is intended to minimize the impact on overall test execution time on CI, while still maintaining sufficient coverage. - -| Test type | When to run | Remarks | -|------------------------|-------------------------------------------------------------------------------------|---------| -| Unit test | when running tests locally, without any parameters, on every commit on every branch | | -| Integration test | on every commit on every branch | | -| System/End-To-End test | on pull request branches except when marked as `draft` | | -| Deployment test | before merging pull requests and on every commit on `main` | | -| Performance test | Only on a specific schedule, e.g. once per day or week | | diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-03-02_gradle_build/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-03-02_gradle_build/README.md deleted file mode 100644 index 9d4461cc60b..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-03-02_gradle_build/README.md +++ /dev/null @@ -1,48 +0,0 @@ -# Migration to Gradle - -## Decision - -Tractus-X EDC will move to Gradle as its build system. This decision -record outlines the reasoning behind the decision as well as the migration path. - -## Rationale - -The primary motivator for migrating to Gradle is the overarching goal, set by the board of Catena-X, of pursuing an -open-source methodology in general, and to track the Eclipse Datasource Components project in particular. While in -theory that could be achieved with any build tool, much of what is useful or even necessary to achieve that goal, such -as publishing to OSSRH/Sonatype and - in further consequence - to MavenCentral, has already been implemented in the EDC -project. This reduces the implementation and maintenance surface of tractusx-edc with regard to the build, documentation -and testing, and hence increases the development velocity considerably. - -It is therefore a foregone conclusion to rely on technology that has already proven itself in the opensource community, -instead of re-implementing (and maintaining) the same functionality all over again. - -In detail, the aforementioned features are: - -- automatic and structured documentation using the `autodoc` plugin -- generating unified OpenAPI documentation -- default module dependencies -- default configuration (POM, Swagger, artifact signing, code style,...) -- default plugins for project submodules -- publishing to artifact repositories (OSSRH/Sonatype and Maven) -- unified and core-maintained version catalogs and version resolution strategies to avoid version clashes and runtime - errors - -This also contributes to much smaller, easier readable and more succinct build files. Since the build itself is -executable code, a high degree of customization, optimization and modularization is possible. - -Furthermore, developers can expect a much improved experience due to Gradle features like caching, task avoidance and -parallelization resulting in faster and more responsive builds. - -## Approach - -- convert Maven POMs to `build.gradle.kts` files, including BOMs -- generate docker images using [this plugin](https://github.com/bmuschko/gradle-docker-plugin) -- convert maven profiles -> JUnit tags (cf. EDC): run tests using JUnit `@Tag`s and the `includeBuild` feature -- adapt documentation (i.e. exchange the commands) - -## Further consideration - -Planned improvements regarding the testing procedure will also greatly benefit from the EDC build tools such -as JUnit tags and conditional evaluation of the tagged tests. Much of EDC's testing framework is based on Gradle and can -be seamlessly integrated in tractusx-edc. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-03-23_remove_lombok/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-03-23_remove_lombok/README.md deleted file mode 100644 index b7014c8b868..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-03-23_remove_lombok/README.md +++ /dev/null @@ -1,37 +0,0 @@ -# Remove Lombok from code base - -## Decision - -The Lombok library will be removed from the code base. - -## Rationale - -Lombok uses byte-code modification to achieve its goal. That is dangerous for a number of reasons. - -First and foremost, to achieve its goal, it relies on internal APIs of the JVM, which are not intended for public -consumption, thus they can and will get removed, refactored or made otherwise unavailable. This has been discussed at -length in the [project's GitHub page](https://github.com/projectlombok/lombok/issues/2681). -This is especially problematic for an OSS project such as TractusX. - -Second, many of the features that are currently used by TractusX-EDC are experimental (e.g. `@UtilityClass`) and are -known to break some Java standard features, such as static imports. - -Third, the value that Lombok offers is questionable at best (e.g. various constructor -annotations, `@Builder`, `@Value`), because modern IDEs have ample features to generate boilerplate code. Further, it -makes the code arguably less readable and less debuggable, very non-resilient against -refactoring (`@ToString(of = )`) and more dangerous (`@SneakyThrows`) at runtime. - -Fourth and finally bytecode modification could conceivably cause problems in use cases where audited/certified code is -required. Since the code gets modified during compilation in a way not covered by any spec, technically the runtime code -could be significantly different from the source code. Although this problem is admittedly theoretical at the moment, we -should not build those obstructions into the code base. - -## Approach - -- Remove the lombok library from the version catalog -- replace all annotations with actual code -- [optional] add an entry to our coding principles to forbid byte-code modification (lombok, aspectJ,...) - -## Further consideration - -We can even expect a slightly faster build, because "delomboking" will become unnecessary. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-04-03_renaming_branches/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-04-03_renaming_branches/README.md deleted file mode 100644 index 5638a79dd7d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-04-03_renaming_branches/README.md +++ /dev/null @@ -1,61 +0,0 @@ -# Renaming Git branches to comply with TractusX standards - -## Decision - -TractusX-EDC will rename its Git branching structure to comply with TractusX release guidelines, and to be able to -leverage -GitHub convenience features, while continuing to use the Gitflow branching model. - -## Rationale - -The TractusX organization has established -a [release guideline](https://eclipse-tractusx.github.io/docs/release/trg-2/trg-2-1/) which mandates that all projects' -default branch be called `main`. - -### Selecting default branches - -In GitHub, the default branch has a couple of important features attached to it: - -- cloning or forking the repository will automatically check out the default branch -- when creating pull requests the default branch is targeted by default -- [automatic issue linking and closing](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) - only works with the default branch - -### The problem with GitFlow - -The GitFlow branching model suggests that the day-to-day work be done on a branch called `develop`, while the `main` -branch stores the version history and only receives (merge) commits after a version releases. - -This would call for `develop` being the GitHub default branch, which is forbidden by the aforementioned release -guideline. - -## Approach - -In order to comply with the TractusX release guideline, to make use of the GitHub features _and_ also use GitFlow, we -propose renaming a couple of branches. While GitFlow _suggests_ branch names, it does not _require_ it, and most -tools allow for customizing them anyway. Thus, from an abstract perspective, the following changes are necessary: - -- `main` becomes our work/development branch. All pull requests target `main`. -- `develop` gets deleted -- a new branch `releases` is introduced, which tracks the release history and receives post-release merge commits. - -Technically this will involve force-pushing, which is a potentially destructive operation. Therefor the following -section outlines the exact sequence of steps. Note that "upstream" refers to `eclipse-tractusx/tractusx-edc`, while " -fork" refers to `catenax-ng/tx-tractusx-edc`. - -- create a new branch `upstream/releases` -- create a new branch `fork/releases`, set it to track `upstream/releases` -- push the contents of `fork/main` -> `upstream/releases` -- synchronize `upstream/develop` with `fork/develop` -- force-push the contents of `develop` -> `upstream/main` (do **not** update the tracking branch!) -- synchronize `upstream/main` -> `fork/main` -- delete/archive `upstream/develop` and `fork/develop` - -_Note that most of this will likely need to be done manually, since GitHub does not allow for advanced Git operations -like force-pushing. Write access to `upstream` is required!_ - -## Further notes - -The new `releases` branch (note the plural) will serve the same purpose that `main` did up until now, which is to track -all releases (via merge commits and tags) in chronological order. We will continue to have separate `release/x.y.z` -branches for every release. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-04-11_refactor_helmcharts/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-04-11_refactor_helmcharts/README.md deleted file mode 100644 index 5cf59f958d3..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-04-11_refactor_helmcharts/README.md +++ /dev/null @@ -1,112 +0,0 @@ -# Refactor TractusX-EDC Helm charts - -## Decision - -The Helm charts provided by Tractusx-EDC will be refactored to be more focused and opinionated. Specifically, there will -be the following charts: - -1. `tractusx-connector-memory`: all backing stores are memory-based and thus ephemeral. The vault will also be - memory-based. _This chart is intended for testing/demo purposes only!_ -2. `tractusx-connector`: this is the "production-ready" chart that uses PostgreSQL and Hashicorp-Vault -3. `tractusx-connector-azure-vault`: this is a variant of `tractusx-connector-azure-vault` that uses Azure KeyVault (" - AZKV") instead - of Hashicorp as some stakeholders still use AZKV. - -These charts and their default configuration will be fully [tested](#testing). - -In addition to that, the Docker images will undergo some [refactoring](#docker-image-refactoring) as well. - -## Rationale - -The current "dynamically composed" helm chart has proven to be a source for issues, and it is difficult to isolate -errors due to the great number of variations. Further, only one particular variant (i.e. postgres+hashicorp) is put to -any semblance of testing (i.e. business tests). - -The official recommendation of TractusX-EDC is to use PostgreSQL and HashiCorp Vault, and alongside it, we will provide -charts for easy testing and setting up demos as well as an Azure KeyVault variant for legacy use cases. - -> Note: using Azure KeyVault is not officially supported or recommended by TractusX-EDC! - -This will also reduce the number of Docker images that need to be published. - -## Approach - -### Variant 1: `tractusx-connector-memory` - -This chart is intended for blackbox-testing or for easily setting up demos etc. It is **not** recommended for anything -else. It will have the following properties: - -- all backing stores (Asset Index, Policy Store etc.) are ephemeral in-memory stores -- the vault implementation will either be based also on memory, or on the `FsVault`, which uses local storage to store - secrets -- an embedded data plane will be used -- no scalability or replication is possible -- DAPS will be used as identity provider, so there is an implicit dependency onto a DAPS instance -- the `edc-runtime-memory` Docker image will be used. That image contains both control plane and data plane. - -### Variant 2: `tractusx-connector` - -This is the production-ready chart that is published by TractusX-EDC, and it will actually consist of two charts. One is -the `tractusx-runtime` sub-chart, that contains all configuration for data plane and control plane, and the other one is -the top-level `tractusx-connector` chart, that pulls in other charts as dependencies that are needed for one TractusX -connector application. This is sometimes referred to -as ["umbrella chart"](https://helm.sh/docs/howto/charts_tips_and_tricks/#complex-charts-with-many-dependencies). - -> Note: this will **not** include sub-charts for DAPS or MinIO. - -```shell -tractusx-connector - |-> tractusx-runtime - |-> postgres - |-> hashicorp-vault -``` - -The `tractusx-runtime` chart has the following properties: - -- PostgreSQL is used as persistence backend -- HashiCorp Vault is used as secret store -- the data plane is a separate runtime, i.e. separate pod -- DAPS is used as identity provider -- the `edc-controlplane-postgresql-hashicorp-vault` and `edc-dataplane-hashicorp-vault` Docker images will be used - -### Variant 3: `tractusx-connector-azure-vault` - -This variant is essentially identical to `tractusx-connector` except for dropping the HashiCorp Vault chart, and -replacing the HashiCorp Vault configuration with Azure KeyVault configuration. - -For this, the `edc-controlplane-postgresql-azure-vault` and `edc-dataplane-azure-vault` Docker images will be used. - -### Testing - -There are several steps to testing our Helm charts: - -1. waiting for all pods to come up: using an exemplary configuration, this relies on the health checks, i.e. liveness - and readiness probe (i.e. the runtime`s observability endpoints) to ensure that (most of) the static - configuration is correct, no values are missing etc. -2. executing a set of HTTP requests against the management API and assert a successful HTTP status code. For that we - use [Helm chart tests](https://helm.sh/docs/topics/chart_tests/) - -> Note: we refer to this kind of testing as "deployment testing" - -### Docker image refactoring - -The following changes need to be made to our Docker images: - -- rename `edc-controlplane-memory` -> `-edc-runtime-memory` -- in `edc-runtime-memory` use `FsVault` instead of `AzureVault` -- `edc-runtime-memory` contains an embedded data plane -- rename `edc-controlplane-postgresql` -> `edc-controlplane-postgresql-azure-vault` -- delete `edc-controlplane-memory-hashicorp-vault` - -thus effectively resulting in the following structure: - -```shell -edc-controlplane -|-> edc-runtime-memory -|-> edc-controlplane-postgresql-hashicorp-vault -|-> edc-controlplane-postgresql-azure-vault - -edc-dataplane -|-> edc-dataplane-hashicorp-vault -|-> edc-dataplane-azure-vaul -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-04-20_conventional_commits/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-04-20_conventional_commits/README.md deleted file mode 100644 index d58b55c6116..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/decision-records/2023-04-20_conventional_commits/README.md +++ /dev/null @@ -1,43 +0,0 @@ -# Using Conventional Commit messages - -## Decision - -From now on, TractusX-EDC will use only conventional commit messages. The specification can be -found [here](https://www.conventionalcommits.org/en/v1.0.0/#summary) - -## Rationale - -Conventional commits create a structured, explicit and unambiguous commit history, that is easy to read and to -interpret. Conventional commits are widely used in the world of open source development. -On top of that, there -is [extensive tooling](https://www.conventionalcommits.org/en/about/#tooling-for-conventional-commits) to support the -creation, interpretation and enforcement of conventional commits. - -## Approach - -As a first step, we enforce conventional commits as part of our CI pipeline. TractusX-EDC is using -Squash-Rebase-merging, and the PR title is used as commit message. We will not dictate how people structure their -commits during the _development_ phase of their PR, but we _will_ enforce, that PR titles (and thus: merge commit -messages) are in the conventional commit format. - -To do that, we can use a very simple regex check on the PR title: - -```yaml -- uses: deepakputhraya/action-pr-title@master - with: - regex: '^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\(\w+((,|\/|\\)?\s?\w+)+\))?!?: [\S ]{1,80}[^\.]$' - allowed_prefixes: 'build,chore,ci,docs,feat,fix,perf,refactor,revert,style,test' - prefix_case_sensitive: true -``` - -That way, we can catch malformed PR titles early, which would result in malformed _merge commit messages_. In addition, -we can -use any of the tools linked above to ensure commit messages, e.g. when merge commits are altered manually, etc. - -## Future outlook - -Once we have a structured commit history done in the conventional commit format, we can auto-generate changelogs, link -to (auto-generated) documentation, render visually appealing version information, etc. Essentially, we can use any -number of tooling on top of cc's. -One key aspect would be to get rid of the manual changelog, -see [this discussion](https://github.com/eclipse-tractusx/tractusx-edc/discussions/253). diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/postman/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/postman/README.md deleted file mode 100644 index f4a7d2b24a5..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/postman/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# Postman Collection - -## Prerequisites - -[![Postman][postman-shield]][postman-url] - -## Postman - -The Postman app can be used to send and receive EDC messages. - -### Install/Download Postman - -please visit - -### Import Postman collection - -please visit - -## Collection - -The postman collection contains the most common API calls. Please note that the - -- Policy & Negotiation calls come in pairs for the different kinds of policies -- the 'Data' call only works when using the All-In-One Deployment of this repository - -![screenshot](./images/screenshot.png) - -[postman-shield]: https://img.shields.io/badge/Postman-URL-orange -[postman-url]: https://www.postman.com diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/postman/collection.json b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/postman/collection.json deleted file mode 100644 index 26de5c7d267..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/postman/collection.json +++ /dev/null @@ -1,884 +0,0 @@ -{ - "info": { - "_postman_id": "fcea09d2-13d9-49ce-8c44-d3cb3078eb82", - "name": "EDC", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "_exporter_id": "6134257" - }, - "item": [ - { - "name": "Asset", - "request": { - "method": "GET", - "header": [], - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/assets/{{ASSET_ID}}", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "assets", - "{{ASSET_ID}}" - ] - } - }, - "response": [] - }, - { - "name": "Assets", - "request": { - "method": "GET", - "header": [], - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/assets", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "assets" - ] - } - }, - "response": [] - }, - { - "name": "Asset", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Status code is 201\", function () {", - " pm.response.to.have.status(201);", - "});" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"asset\": {\n \"properties\": {\n \"asset:prop:id\": \"{{ASSET_ID}}\",\n \"asset:prop:description\": \"Tractus-X EDC Demo Asset\"\n }\n },\n \"dataAddress\": {\n \"properties\": {\n \"type\": \"HttpData\",\n \"baseUrl\": \"https://jsonplaceholder.typicode.com/todos/1\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/assets", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "assets" - ] - } - }, - "response": [] - }, - { - "name": "Asset", - "request": { - "method": "DELETE", - "header": [], - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/assets/{{ASSET_ID}}", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "assets", - "{{ASSET_ID}}" - ] - } - }, - "response": [] - }, - { - "name": "Policy", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"{{POLICY_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"constraints\": []\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/policydefinitions/{{POLICY_ID}}", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "policydefinitions", - "{{POLICY_ID}}" - ] - } - }, - "response": [] - }, - { - "name": "Policies", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"{{POLICY_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"constraints\": []\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/policydefinitions", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "policydefinitions" - ] - } - }, - "response": [] - }, - { - "name": "Policy (Public)", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"{{POLICY_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"constraints\": []\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/policydefinitions", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "policydefinitions" - ] - } - }, - "response": [] - }, - { - "name": "Policy (Properties)", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"{{POLICY_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"constraints\": []\n }\n ],\n \"extensibleProperties\": {\n \"foo\": \"bar\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/policydefinitions", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "policydefinitions" - ] - } - }, - "response": [] - }, - { - "name": "Policy (BPN)", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"{{POLICY_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"constraints\": [\n {\n \"edctype\": \"AtomicConstraint\",\n \"leftExpression\": {\n \"edctype\": \"dataspaceconnector:literalexpression\",\n \"value\": \"BusinessPartnerNumber\"\n },\n \"rightExpression\": {\n \"edctype\": \"dataspaceconnector:literalexpression\",\n \"value\": \"{{POLICY_BPN}}\"\n },\n \"operator\": \"EQ\"\n }\n ]\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/policydefinitions", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "policydefinitions" - ] - } - }, - "response": [] - }, - { - "name": "Policy", - "request": { - "method": "DELETE", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"{{POLICY_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"constraints\": []\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/policydefinitions/{{POLICY_ID}}", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "policydefinitions", - "{{POLICY_ID}}" - ] - } - }, - "response": [] - }, - { - "name": "Contract Definition", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"{{POLICY_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"constraints\": []\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/contractdefinitions/{{POLICY_ID}}", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "contractdefinitions", - "{{POLICY_ID}}" - ] - } - }, - "response": [] - }, - { - "name": "Contract Definitiions", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"{{POLICY_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"constraints\": []\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/contractdefinitions", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "contractdefinitions" - ] - } - }, - "response": [] - }, - { - "name": "Contract Definitiion", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"{{CONTRACT_DEFINITION_ID}}\",\n \"criteria\": [\n {\n \"operandLeft\": \"asset:prop:id\",\n \"operator\": \"=\",\n \"operandRight\": \"{{ASSET_ID}}\"\n }\n ],\n \"accessPolicyId\": \"{{ACCESS_POLICY_ID}}\",\n \"contractPolicyId\": \"{{CONTRACT_POLICY_ID}}\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/contractdefinitions", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "contractdefinitions" - ] - } - }, - "response": [] - }, - { - "name": "Contract Definition", - "request": { - "method": "DELETE", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"id\": \"{{POLICY_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"constraints\": []\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{PROVIDER_MANAGEMENT_URL}}/contractdefinitions/{{POLICY_ID}}", - "host": [ - "{{PROVIDER_MANAGEMENT_URL}}" - ], - "path": [ - "contractdefinitions", - "{{POLICY_ID}}" - ] - } - }, - "response": [] - }, - { - "name": "Catalog", - "request": { - "method": "GET", - "header": [], - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/catalog?providerUrl={{PROVIDER_PROTOCOL_URL}}/api/v1/ids/data&size=50", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "catalog" - ], - "query": [ - { - "key": "providerUrl", - "value": "{{PROVIDER_PROTOCOL_URL}}/api/v1/ids/data" - }, - { - "key": "size", - "value": "50" - } - ] - } - }, - "response": [] - }, - { - "name": "Query Catalog", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"providerUrl\": \"{{PROVIDER_PROTOCOL_URL}}/api/v1/ids/data\",\r\n \"querySpec\": {\r\n \"offset\": 0,\r\n \"limit\": 100,\r\n \"sort\": \"ASC\",\r\n \"sortField\": \"\"\r\n }\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/catalog/request", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "catalog", - "request" - ] - } - }, - "response": [] - }, - { - "name": "Negotation (Public)", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Body matches string\", function () {", - " var jsonData = pm.response.json();", - " pm.collectionVariables.set(\"NEGOTIATION_ID\", jsonData.id);", - "", - "});" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"connectorId\": \"foo\",\n \"connectorAddress\": \"{{PROVIDER_PROTOCOL_URL}}/api/v1/ids/data\",\n \"offer\": {\n \"offerId\": \"{{CONTRACT_DEFINITION_ID}}:foo\",\n \"assetId\": \"{{ASSET_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"target\": \"{{ASSET_ID}}\",\n \"constraints\": []\n }\n ]\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/contractnegotiations", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "contractnegotiations" - ] - } - }, - "response": [] - }, - { - "name": "Negotation (Properties)", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Body matches string\", function () {", - " var jsonData = pm.response.json();", - " pm.collectionVariables.set(\"NEGOTIATION_ID\", jsonData.id);", - "", - "});" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"connectorId\": \"foo\",\n \"connectorAddress\": \"{{PROVIDER_PROTOCOL_URL}}/api/v1/ids/data\",\n \"offer\": {\n \"offerId\": \"{{POLICY_ID}}:foo\",\n \"assetId\": \"{{ASSET_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"target\": \"{{ASSET_ID}}\",\n \"constraints\": []\n }\n ],\n \"extensibleProperties\": {\n \"foo\": \"bar\"\n }\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/contractnegotiations", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "contractnegotiations" - ] - } - }, - "response": [] - }, - { - "name": "Negotation (BPN)", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Body matches string\", function () {", - " var jsonData = pm.response.json();", - " pm.collectionVariables.set(\"NEGOTIATION_ID\", jsonData.id);", - "", - "});" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"connectorId\": \"foo\",\n \"connectorAddress\": \"{{PROVIDER_PROTOCOL_URL}}/api/v1/ids/data\",\n \"offer\": {\n \"offerId\": \"{{POLICY_ID}}:foo\",\n \"assetId\": \"{{ASSET_ID}}\",\n \"policy\": {\n \"prohibitions\": [],\n \"obligations\": [],\n \"permissions\": [\n {\n \"edctype\": \"dataspaceconnector:permission\",\n \"action\": {\n \"type\": \"USE\"\n },\n \"target\": \"{{ASSET_ID}}\",\n \"constraints\": [\n {\n \"edctype\": \"AtomicConstraint\",\n \"leftExpression\": {\n \"edctype\": \"dataspaceconnector:literalexpression\",\n \"value\": \"BusinessPartnerNumber\"\n },\n \"rightExpression\": {\n \"edctype\": \"dataspaceconnector:literalexpression\",\n \"value\": \"{{POLICY_BPN}}\"\n },\n \"operator\": \"EQ\"\n }\n ]\n }\n ]\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/contractnegotiations", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "contractnegotiations" - ] - } - }, - "response": [] - }, - { - "name": "Negotation (init AGREEMENT_ID)", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript" - } - }, - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Body matches string\", function () {\r", - " var jsonData = pm.response.json();\r", - " pm.collectionVariables.set(\"AGREEMENT_ID\", jsonData.contractAgreementId);\r", - "});" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "GET", - "header": [], - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/contractnegotiations/{{NEGOTIATION_ID}}", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "contractnegotiations", - "{{NEGOTIATION_ID}}" - ] - } - }, - "response": [] - }, - { - "name": "Transfer", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "pm.collectionVariables.set(\"TRANSFER_ID\", Math.random());" - ], - "type": "text/javascript" - } - }, - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Body matches string\", function () {", - " var jsonData = pm.response.json();", - " pm.collectionVariables.set(\"TRANSFER_PROCESS_ID\", jsonData.id);", - "});" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{ \"id\": \"{{TRANSFER_ID}}\",\n \"connectorId\": \"foo\", \n \"connectorAddress\": \"{{PROVIDER_PROTOCOL_URL}}/api/v1/ids/data\", \n \"contractId\": \"{{AGREEMENT_ID}}\", \n \"assetId\": \"{{ASSET_ID}}\",\n \"managedResources\": \"false\", \n \"dataDestination\": { \"type\": \"HttpProxy\" }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/transferprocess", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "transferprocess" - ] - } - }, - "response": [] - }, - { - "name": "Transfer dynamic http receiver", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "pm.collectionVariables.set(\"TRANSFER_ID\", Math.random());" - ], - "type": "text/javascript" - } - }, - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Body matches string\", function () {", - " var jsonData = pm.response.json();", - " pm.collectionVariables.set(\"TRANSFER_PROCESS_ID\", jsonData.id);", - "});" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{ \"id\": \"{{TRANSFER_ID}}\",\n \"connectorId\": \"foo\", \n \"connectorAddress\": \"{{PROVIDER_PROTOCOL_URL}}/api/v1/ids/data\", \n \"contractId\": \"{{AGREEMENT_ID}}\", \n \"assetId\": \"{{ASSET_ID}}\",\n \"managedResources\": \"false\", \n \"dataDestination\": { \"type\": \"HttpProxy\" },\n \"properties\": {\n \"receiver.http.endpoint\": \"{{BACKEND_SERVICE}}\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/transferprocess", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "transferprocess" - ] - } - }, - "response": [] - }, - { - "name": "Transfer", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript" - } - }, - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "GET", - "header": [], - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/transferprocess/{{TRANSFER_PROCESS_ID}}", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "transferprocess", - "{{TRANSFER_PROCESS_ID}}" - ] - } - }, - "response": [] - }, - { - "name": "CPA (getData)", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Body matches string\", function () {\r", - " var jsonData = pm.response.json();\r", - " pm.collectionVariables.set(\"authCode\", jsonData.authCode);\r", - "});" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "GET", - "header": [], - "url": { - "raw": "{{CONSUMER_MANAGEMENT_URL}}/adapter/asset/sync/{{ASSET_ID}}?providerUrl={{PROVIDER_PROTOCOL_URL}}/api/v1/ids/data&contractAgreementReuse=false", - "host": [ - "{{CONSUMER_MANAGEMENT_URL}}" - ], - "path": [ - "adapter", - "asset", - "sync", - "{{ASSET_ID}}" - ], - "query": [ - { - "key": "providerUrl", - "value": "{{PROVIDER_PROTOCOL_URL}}/api/v1/ids/data" - }, - { - "key": "contractAgreementReuse", - "value": "false" - } - ] - } - }, - "response": [] - } - ], - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "value", - "value": "", - "type": "string" - }, - { - "key": "key", - "value": "X-Api-Key", - "type": "string" - } - ] - }, - "event": [ - { - "listen": "prerequest", - "script": { - "type": "text/javascript", - "exec": [ - "" - ] - } - }, - { - "listen": "test", - "script": { - "type": "text/javascript", - "exec": [ - "" - ] - } - } - ], - "variable": [ - { - "key": "CONSUMER_MANAGEMENT_URL", - "value": "https://sokrates-txdc.int.demo.catena-x.net/management" - }, - { - "key": "PROVIDER_PROTOCOL_URL", - "value": "https://plato-txdc.int.demo.catena-x.net" - }, - { - "key": "PROVIDER_MANAGEMENT_URL", - "value": "https://plato-txdc.int.demo.catena-x.net/management" - }, - { - "key": "ASSET_ID", - "value": "1", - "type": "default" - }, - { - "key": "POLICY_ID", - "value": "1", - "type": "default" - }, - { - "key": "CONTRACT_POLICY_ID", - "value": "1", - "type": "default" - }, - { - "key": "ACCESS_POLICY_ID", - "value": "1", - "type": "default" - }, - { - "key": "CONTRACT_DEFINITION_ID", - "value": "1", - "type": "default" - }, - { - "key": "POLICY_BPN", - "value": "BPNSOKRATES", - "type": "default" - }, - { - "key": "NEGOTIATION_ID", - "value": "" - }, - { - "key": "AGREEMENT_ID", - "value": "" - }, - { - "key": "TRANSFER_ID", - "value": "" - }, - { - "key": "TRANSFER_PROCESS_ID", - "value": "" - }, - { - "key": "BACKEND_SERVICE", - "value": "http://backend:8080", - "type": "string" - }, - { - "key": "AGREEMENT-ID", - "value": "" - }, - { - "key": "authCode", - "value": "" - } - ] -} \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/postman/images/screenshot.png b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/postman/images/screenshot.png deleted file mode 100644 index 8a9d231c673..00000000000 Binary files a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/postman/images/screenshot.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/run-config.png b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/run-config.png deleted file mode 100644 index 4be2d85ad69..00000000000 Binary files a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/run-config.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/scripts/daps_token/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/scripts/daps_token/README.md deleted file mode 100644 index cbc7475ffd6..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/scripts/daps_token/README.md +++ /dev/null @@ -1,27 +0,0 @@ -# DAPS Token Script - -Script to request an IDS token from the DAPS. - -## Usage - -1. Copy your DAPS private key into `key.pem` -2. Edit in the script the following variables - - `token_url` - - `client_id` - - `resource` -3. Run script - - ```bash - ./daps_auth_sh - ``` - -4. Take the `access_token` from the output in use it in IDS messages. The output of the script looks like this: - - ```json - { - "access_token": "eyJ0eXAiOiJhdCtqd3QiLCJraWQiOiI3MDM2MzAwNzVkYTM2N2IxYmZiYjRjY2Q0N2M1Y2ViMGQ5ZjM1MmRmYWU2MzJkMzYxMGMxNzNmMTM1NDI0NmM5IiwiYWxnIjoiUlMyNTYifQ.eyJzY29wZSI6Imlkc2M6SURTX0NPTk5FQ1RPUl9BVFRSSUJVVEVTX0FMTCIsImF1ZCI6WyJodHRwczovL3Blbi10ZXN0LXBsYXRvLXR4ZGMuaW50LmRlbW8uY2F0ZW5hLXgubmV0L2FwaS92MS9pZHMvZGF0YSJdLCJpc3MiOiJodHRwOi8vaWRzLWRhcHM6NDU2Ny8iLCJzdWIiOiI5OTo4MzpBNzoxNzo4NjpGRjo5ODo5MzpDRTpBMDpERDpBMTpGMTozNjpGQTpGNjowRjo3NTowQToyMzprZXlpZDo5OTo4MzpBNzoxNzo4NjpGRjo5ODo5MzpDRTpBMDpERDpBMTpGMTozNjpGQTpGNjowRjo3NTowQToyMyIsIm5iZiI6MTY3ODMxMDE0OSwiaWF0IjoxNjc4MzEwMTQ5LCJqdGkiOiJkZmY5Y2FmOS05NDZiLTQ1YmMtOWY4My0yYmJkMDI4NTlmYWMiLCJleHAiOjE2NzgzMTM3NDksImNsaWVudF9pZCI6Ijk5OjgzOkE3OjE3Ojg2OkZGOjk4OjkzOkNFOkEwOkREOkExOkYxOjM2OkZBOkY2OjBGOjc1OjBBOjIzOmtleWlkOjk5OjgzOkE3OjE3Ojg2OkZGOjk4OjkzOkNFOkEwOkREOkExOkYxOjM2OkZBOkY2OjBGOjc1OjBBOjIzIiwicmVmZXJyaW5nQ29ubmVjdG9yIjoiaHR0cDovL3BsYXRvLWNvbnRyb2xwbGFuZS9CUE5QTEFUTyJ9.JQqt9gCpaG7rLztO5-pJa7HIybVjKog9v0CFXHoVJZgdxMc5nTKZnuwBVHC1PXuWrBiyPxPoNg0TsfRg9DqF8rFD5noarxOJ1S84BF7AUUi3phQzBF26lsmNmOW_gdNBC-8xw1WMo5hRHH56cB64_x4V8T4VwFlSYYrmA5ge_EiPCW_KWF9sNguXBKs8uTbLB3lvTELGTjmZI93tVR-vYuYzW2jxH1PJNW29KJRQcM0D1AiveMs3_ThRjheEvugyh9QIY1RwPXMgYQpSTvoumNuFFTnpR21ueWfSUtU-4Qu9suNTkcaFihvEObXVrhyMja-HjhQaC8i0XsAgY0tT1A", - "expires_in": 3600, - "token_type": "bearer", - "scope": "idsc:IDS_CONNECTOR_ATTRIBUTES_ALL" - } - ``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/scripts/daps_token/daps_auth.sh b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/scripts/daps_token/daps_auth.sh deleted file mode 100755 index 2835a2e6152..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/development/scripts/daps_token/daps_auth.sh +++ /dev/null @@ -1,45 +0,0 @@ -#!/bin/bash - -#################################################### -# Update these variables before running the script # -#################################################### -token_url="https://mydaps/token" -client_id="99:83:A7:17:86:FF:98:93:CE:A0:DD:A1:F1:36:FF:F6:0F:75:0A:23:keyid:99:83:A7:17:86:FF:98:93:CE:A0:DD:A1:F1:36:FA:F6:0F:75:0A:24" -# resource is later used as token audience, so it must be the IDS url of the token receiving connector -resource="https://receiving-connector/api/v1/ids/data" - - -base64_encode() -{ - declare input=${1:-$( The shown picture illustrates only a generic view of the Domain Model and is not intended to show all aspects of the project. - -## Asset - -An asset represents data (databases, files, cache information, etc.) which should be published and shared between -organizations. For each asset, a [`DataAddress`](#data-address) needs to be resolvable. - -## Data address - -A data address is a pointer into the physical storage location where an asset will be stored. - -## Contract - -A contract always contains one or more [`Assets`](#asset) and a single [`Policy`](#policy). The contract construct is -used to define the arrangement between two parties ("consumer" and "provider"). Regarding this arrangement, the contract -passes several stages which are explained below: - -### Contract definition - - Contract definitions associate a policy with assets. A `ContractDefinition` object contains an access policy, a contract - policy, and an asset selector which links the contract to one or more assets. - -### Contract offer - - The contract offer is a dynamic representation of the [`ContractDefinition`](#contract-definition) - for a specific consumer and serves as protocol's data transfer object (DTO) for a particular contract negotiation. - Contract offers are not persisted and will be regenerated on every request. The connector acting as data provider will - generate contract offers only for contract definitions dedicated to the organization or data space participant - operating the requesting connector acting as data consumer. A contract offer is always related to a single asset of - the `ContractDefinition` object (e.g. for a `ContractDefinition` containing three `Asset` objects, the connector will - generate three `ContractOffer` objects). - -### Contract negotiation - - A `ContractNegotiation` captures the current state of the negotiation of a contract (`ContractOffer` -> - `ContractAgreement`) between two parties. This process is inherently asynchronous. - -### Contract agreement - - A contract agreement represents the agreed-upon terms of access and usage of an asset's data between two data space - participants, including a start and an end date and further relevant information. - -## Policy - -Contract policies represent permitted and prohibited actions over a certain asset. These actions can be limited further -by constraints (temporal or spatial) and duties ("e.g. deletion of the data after 30 days"). - -## Transfer process - -After a successful contract negotiation, a `DataRequest` is sent from a consumer connector to a provider connector to -initiate the data transfer. It references the requested [`Asset`](#asset) and [`ContractAgreement`](#contract-agreement) -as well as information about the [data destination](#data-address). - -Similar to the `ContractNegotiation`, this object captures the current state of a data transfer. This process is -inherently asynchronous, so the `TransferProcess` objects are stored in a backing data store (`TransferProcessStore`). diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/control-plane-api/complete.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/control-plane-api/complete.api.mdx deleted file mode 100644 index bb2e59bc24a..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/control-plane-api/complete.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: complete -title: "complete" -description: "Requests completion of the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received" -sidebar_label: "complete" -hide_title: true -hide_table_of_contents: true -api: {"description":"Requests completion of the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received","operationId":"complete","parameters":[{"in":"path","name":"processId","required":true,"schema":{"type":"string","example":null}}],"responses":{"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"}},"tags":["Transfer Process Control Api"],"method":"post","path":"/transferprocess/{processId}/complete","info":{"title":"EDC Control Plane API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"complete","description":{"content":"Requests completion of the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received","type":"text/plain"},"url":{"path":["transferprocess",":processId","complete"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"processId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/control-plane-api/edc-control-plane-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## complete - - - -Requests completion of the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received - -
Path Parameters
- -Request was malformed, e.g. id was null - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/control-plane-api/fail.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/control-plane-api/fail.api.mdx deleted file mode 100644 index 07c63d1863a..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/control-plane-api/fail.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: fail -title: "fail" -description: "Requests completion of the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received" -sidebar_label: "fail" -hide_title: true -hide_table_of_contents: true -api: {"description":"Requests completion of the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received","operationId":"fail","parameters":[{"in":"path","name":"processId","required":true,"schema":{"type":"string","example":null}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"errorMessage":{"type":"string","example":null}},"required":["errorMessage"]}}},"required":true},"responses":{"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"}},"tags":["Transfer Process Control Api"],"method":"post","path":"/transferprocess/{processId}/fail","jsonRequestBodyExample":null,"info":{"title":"EDC Control Plane API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"fail","description":{"content":"Requests completion of the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received","type":"text/plain"},"url":{"path":["transferprocess",":processId","fail"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"processId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/control-plane-api/edc-control-plane-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## fail - - - -Requests completion of the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received - -
Path Parameters
Request Body required
- -Request was malformed, e.g. id was null - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/control-plane-api/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/control-plane-api/sidebar.js deleted file mode 100644 index 2b71ece9aa4..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/control-plane-api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"category","label":"Transfer Process Control Api","link":{"type":"generated-index","title":"Transfer Process Control Api","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/control-plane-api/transfer-process-control-api"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/control-plane-api/complete","label":"complete","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/control-plane-api/fail","label":"fail","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/delete.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/delete.api.mdx deleted file mode 100644 index bdf35c4e07f..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/delete.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: delete -title: "delete" -description: "Send `DELETE` data query to the Data Plane." -sidebar_label: "delete" -hide_title: true -hide_table_of_contents: true -api: {"description":"Send `DELETE` data query to the Data Plane.","operationId":"delete","responses":{"400":{"description":"Missing access token"},"403":{"description":"Access token is expired or invalid"},"500":{"description":"Failed to transfer data"}},"tags":["Data Plane public API"],"method":"delete","path":"/{any}","info":{"title":"EDC Data Plane API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"delete","description":{"content":"Send `DELETE` data query to the Data Plane.","type":"text/plain"},"url":{"path":[":any"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"DELETE"}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/edc-data-plane-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## delete - - - -Send `DELETE` data query to the Data Plane. - -
- -Missing access token - -
- -Access token is expired or invalid - -
- -Failed to transfer data - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/get-transfer-state.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/get-transfer-state.api.mdx deleted file mode 100644 index fba5cef7401..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/get-transfer-state.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-transfer-state -title: "getTransferState" -description: "Get the current state of a data transfer." -sidebar_label: "getTransferState" -hide_title: true -hide_table_of_contents: true -api: {"description":"Get the current state of a data transfer.","operationId":"getTransferState","parameters":[{"in":"path","name":"processId","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Missing access token"}},"tags":["Data Plane control API"],"method":"get","path":"/transfer/{processId}","info":{"title":"EDC Data Plane API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Transfer State","description":{"content":"Get the current state of a data transfer.","type":"text/plain"},"url":{"path":["transfer",":processId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"processId"}]},"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/edc-data-plane-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getTransferState - - - -Get the current state of a data transfer. - -
Path Parameters
- -Missing access token - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/get.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/get.api.mdx deleted file mode 100644 index f704354e587..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/get.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get -title: "get" -description: "Send `GET` data query to the Data Plane." -sidebar_label: "get" -hide_title: true -hide_table_of_contents: true -api: {"description":"Send `GET` data query to the Data Plane.","operationId":"get","responses":{"400":{"description":"Missing access token"},"403":{"description":"Access token is expired or invalid"},"500":{"description":"Failed to transfer data"}},"tags":["Data Plane public API"],"method":"get","path":"/{any}","info":{"title":"EDC Data Plane API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get","description":{"content":"Send `GET` data query to the Data Plane.","type":"text/plain"},"url":{"path":[":any"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/edc-data-plane-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## get - - - -Send `GET` data query to the Data Plane. - -
- -Missing access token - -
- -Access token is expired or invalid - -
- -Failed to transfer data - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/initiate-transfer.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/initiate-transfer.api.mdx deleted file mode 100644 index dc2c42b40f8..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/initiate-transfer.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: initiate-transfer -title: "initiateTransfer" -description: "Initiates a data transfer for the given request. The transfer will be performed asynchronously." -sidebar_label: "initiateTransfer" -hide_title: true -hide_table_of_contents: true -api: {"description":"Initiates a data transfer for the given request. The transfer will be performed asynchronously.","operationId":"initiateTransfer","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"callbackAddress":{"type":"string","format":"url","example":null},"destinationDataAddress":{"type":"object","example":null,"properties":{"properties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null}}},"id":{"type":"string","example":null},"processId":{"type":"string","example":null},"properties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null},"sourceDataAddress":{"type":"object","example":null,"properties":{"properties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null}}},"traceContext":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null},"trackable":{"type":"boolean","example":null}}}}}},"responses":{"200":{"description":"Data transfer initiated"},"400":{"description":"Failed to validate request"}},"tags":["Data Plane control API"],"method":"post","path":"/transfer","jsonRequestBodyExample":null,"info":{"title":"EDC Data Plane API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"initiate Transfer","description":{"content":"Initiates a data transfer for the given request. The transfer will be performed asynchronously.","type":"text/plain"},"url":{"path":["transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/edc-data-plane-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## initiateTransfer - - - -Initiates a data transfer for the given request. The transfer will be performed asynchronously. - -
Request Body
    destinationDataAddress object
    properties object
  • property name* string
    • properties object
  • property name* string
    • sourceDataAddress object
    properties object
  • property name* string
    • traceContext object
  • property name* string
- -Data transfer initiated - -
- -Failed to validate request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/patch.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/patch.api.mdx deleted file mode 100644 index 3894a0b65c6..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/patch.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: patch -title: "patch" -description: "Send `PATCH` data query to the Data Plane." -sidebar_label: "patch" -hide_title: true -hide_table_of_contents: true -api: {"description":"Send `PATCH` data query to the Data Plane.","operationId":"patch","responses":{"400":{"description":"Missing access token"},"403":{"description":"Access token is expired or invalid"},"500":{"description":"Failed to transfer data"}},"tags":["Data Plane public API"],"method":"patch","path":"/{any}","info":{"title":"EDC Data Plane API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"patch","description":{"content":"Send `PATCH` data query to the Data Plane.","type":"text/plain"},"url":{"path":[":any"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"PATCH"}} -sidebar_class_name: "patch api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/edc-data-plane-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## patch - - - -Send `PATCH` data query to the Data Plane. - -
- -Missing access token - -
- -Access token is expired or invalid - -
- -Failed to transfer data - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/post.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/post.api.mdx deleted file mode 100644 index baaaa93016d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/post.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: post -title: "post" -description: "Send `POST` data query to the Data Plane." -sidebar_label: "post" -hide_title: true -hide_table_of_contents: true -api: {"description":"Send `POST` data query to the Data Plane.","operationId":"post","responses":{"400":{"description":"Missing access token"},"403":{"description":"Access token is expired or invalid"},"500":{"description":"Failed to transfer data"}},"tags":["Data Plane public API"],"method":"post","path":"/{any}","info":{"title":"EDC Data Plane API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"post","description":{"content":"Send `POST` data query to the Data Plane.","type":"text/plain"},"url":{"path":[":any"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/edc-data-plane-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## post - - - -Send `POST` data query to the Data Plane. - -
- -Missing access token - -
- -Access token is expired or invalid - -
- -Failed to transfer data - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/put.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/put.api.mdx deleted file mode 100644 index 8f7f8869897..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/put.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: put -title: "put" -description: "Send `PUT` data query to the Data Plane." -sidebar_label: "put" -hide_title: true -hide_table_of_contents: true -api: {"description":"Send `PUT` data query to the Data Plane.","operationId":"put","responses":{"400":{"description":"Missing access token"},"403":{"description":"Access token is expired or invalid"},"500":{"description":"Failed to transfer data"}},"tags":["Data Plane public API"],"method":"put","path":"/{any}","info":{"title":"EDC Data Plane API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"put","description":{"content":"Send `PUT` data query to the Data Plane.","type":"text/plain"},"url":{"path":[":any"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"PUT"}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/edc-data-plane-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## put - - - -Send `PUT` data query to the Data Plane. - -
- -Missing access token - -
- -Access token is expired or invalid - -
- -Failed to transfer data - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/sidebar.js deleted file mode 100644 index 71a40110a67..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"category","label":"Data Plane control API","link":{"type":"generated-index","title":"Data Plane control API","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/data-plane-control-api"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/initiate-transfer","label":"initiateTransfer","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/get-transfer-state","label":"getTransferState","className":"api-method get"}]},{"type":"category","label":"Data Plane public API","link":{"type":"generated-index","title":"Data Plane public API","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/data-plane-public-api"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/delete","label":"delete","className":"api-method delete"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/get","label":"get","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/patch","label":"patch","className":"api-method patch"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/post","label":"post","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/data-plane-api/put","label":"put","className":"api-method put"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/transfer-data-plane/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/transfer-data-plane/sidebar.js deleted file mode 100644 index 789d12eb669..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/transfer-data-plane/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"category","label":"Consumer Pull Token Validation","link":{"type":"generated-index","title":"Consumer Pull Token Validation","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/transfer-data-plane/consumer-pull-token-validation"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/transfer-data-plane/validate","label":"validate","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/transfer-data-plane/validate.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/transfer-data-plane/validate.api.mdx deleted file mode 100644 index 0d954b210fc..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/transfer-data-plane/validate.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: validate -title: "validate" -description: "Checks that the provided token has been signed by the present entity and asserts its validity. If token is valid, then the data address contained in its claims is decrypted and returned back to the caller." -sidebar_label: "validate" -hide_title: true -hide_table_of_contents: true -api: {"description":"Checks that the provided token has been signed by the present entity and asserts its validity. If token is valid, then the data address contained in its claims is decrypted and returned back to the caller.","operationId":"validate","parameters":[{"in":"header","name":"Authorization","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Token is valid"},"400":{"description":"Request was malformed"},"403":{"description":"Token is invalid"}},"tags":["Consumer Pull Token Validation"],"method":"get","path":"/token","info":{"title":"EDC Transfer Data Plane API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"validate","description":{"content":"Checks that the provided token has been signed by the present entity and asserts its validity. If token is valid, then the data address contained in its claims is decrypted and returned back to the caller.","type":"text/plain"},"url":{"path":["token"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/control-api/transfer-data-plane/edc-transfer-data-plane-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## validate - - - -Checks that the provided token has been signed by the present entity and asserts its validity. If token is valid, then the data address contained in its claims is decrypted and returned back to the caller. - -
Header Parameters
- -Token is valid - -
- -Request was malformed - -
- -Token is invalid - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/extensions/control-plane-adapter/get-asset-synchronous.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/extensions/control-plane-adapter/get-asset-synchronous.api.mdx deleted file mode 100644 index 564cb6015be..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/extensions/control-plane-adapter/get-asset-synchronous.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-asset-synchronous -title: "getAssetSynchronous" -description: "getAssetSynchronous" -sidebar_label: "getAssetSynchronous" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"getAssetSynchronous","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string","example":null}},{"in":"query","name":"providerUrl","schema":{"type":"string","example":null}},{"in":"query","name":"contractAgreementId","schema":{"type":"string","example":null}},{"in":"query","name":"contractAgreementReuse","schema":{"type":"boolean","default":true,"example":null}},{"in":"query","name":"timeout","schema":{"type":"string","example":null}}],"responses":{"default":{"description":"default response"}},"tags":["Control Plane Adapter"],"description":"getAssetSynchronous","method":"get","path":"/adapter/asset/sync/{assetId}","info":{"title":"EDC Control Plane Adapter API","description":null,"license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Asset Synchronous","description":{"type":"text/plain"},"url":{"path":["adapter","asset","sync",":assetId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"providerUrl","value":""},{"disabled":false,"key":"contractAgreementId","value":""},{"disabled":false,"key":"contractAgreementReuse","value":""},{"disabled":false,"key":"timeout","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"assetId"}]},"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/extensions/control-plane-adapter/edc-control-plane-adapter-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getAssetSynchronous - - - -getAssetSynchronous - -
Path Parameters
Query Parameters
- -default response - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/extensions/control-plane-adapter/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/extensions/control-plane-adapter/sidebar.js deleted file mode 100644 index fa6e38ea9da..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/extensions/control-plane-adapter/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"category","label":"Control Plane Adapter","link":{"type":"generated-index","title":"Control Plane Adapter","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/extensions/control-plane-adapter/control-plane-adapter"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/extensions/control-plane-adapter/get-asset-synchronous","label":"getAssetSynchronous","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/check-health.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/check-health.api.mdx deleted file mode 100644 index 8c585ca764f..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/check-health.api.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: check-health -title: "checkHealth" -description: "Performs a liveness probe to determine whether the runtime is working properly." -sidebar_label: "checkHealth" -hide_title: true -hide_table_of_contents: true -api: {"description":"Performs a liveness probe to determine whether the runtime is working properly.","operationId":"checkHealth","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"componentResults":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"component":{"type":"string","example":null},"failure":{"type":"object","example":null,"properties":{"failureDetail":{"type":"string","example":null},"messages":{"type":"array","example":null,"items":{"type":"string","example":null}}}},"isHealthy":{"type":"boolean","example":null}}}},"isSystemHealthy":{"type":"boolean","example":null}}}}}}}},"tags":["Application Observability"],"method":"get","path":"/check/health","info":{"title":"EDC Observability API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"check Health","description":{"content":"Performs a liveness probe to determine whether the runtime is working properly.","type":"text/plain"},"url":{"path":["check","health"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/edc-observability-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## checkHealth - - - -Performs a liveness probe to determine whether the runtime is working properly. - -
Schema array
    componentResults object[]
    failure object
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/get-liveness.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/get-liveness.api.mdx deleted file mode 100644 index 5f81b469955..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/get-liveness.api.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: get-liveness -title: "getLiveness" -description: "Performs a liveness probe to determine whether the runtime is working properly." -sidebar_label: "getLiveness" -hide_title: true -hide_table_of_contents: true -api: {"description":"Performs a liveness probe to determine whether the runtime is working properly.","operationId":"getLiveness","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"componentResults":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"component":{"type":"string","example":null},"failure":{"type":"object","example":null,"properties":{"failureDetail":{"type":"string","example":null},"messages":{"type":"array","example":null,"items":{"type":"string","example":null}}}},"isHealthy":{"type":"boolean","example":null}}}},"isSystemHealthy":{"type":"boolean","example":null}}}}}}}},"tags":["Application Observability"],"method":"get","path":"/check/liveness","info":{"title":"EDC Observability API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Liveness","description":{"content":"Performs a liveness probe to determine whether the runtime is working properly.","type":"text/plain"},"url":{"path":["check","liveness"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/edc-observability-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getLiveness - - - -Performs a liveness probe to determine whether the runtime is working properly. - -
Schema array
    componentResults object[]
    failure object
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/get-readiness.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/get-readiness.api.mdx deleted file mode 100644 index 19afde6603f..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/get-readiness.api.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: get-readiness -title: "getReadiness" -description: "Performs a readiness probe to determine whether the runtime is able to accept requests." -sidebar_label: "getReadiness" -hide_title: true -hide_table_of_contents: true -api: {"description":"Performs a readiness probe to determine whether the runtime is able to accept requests.","operationId":"getReadiness","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"componentResults":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"component":{"type":"string","example":null},"failure":{"type":"object","example":null,"properties":{"failureDetail":{"type":"string","example":null},"messages":{"type":"array","example":null,"items":{"type":"string","example":null}}}},"isHealthy":{"type":"boolean","example":null}}}},"isSystemHealthy":{"type":"boolean","example":null}}}}}}}},"tags":["Application Observability"],"method":"get","path":"/check/readiness","info":{"title":"EDC Observability API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Readiness","description":{"content":"Performs a readiness probe to determine whether the runtime is able to accept requests.","type":"text/plain"},"url":{"path":["check","readiness"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/edc-observability-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getReadiness - - - -Performs a readiness probe to determine whether the runtime is able to accept requests. - -
Schema array
    componentResults object[]
    failure object
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/get-startup.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/get-startup.api.mdx deleted file mode 100644 index c12f388aa35..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/get-startup.api.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: get-startup -title: "getStartup" -description: "Performs a startup probe to determine whether the runtime has completed startup." -sidebar_label: "getStartup" -hide_title: true -hide_table_of_contents: true -api: {"description":"Performs a startup probe to determine whether the runtime has completed startup.","operationId":"getStartup","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"componentResults":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"component":{"type":"string","example":null},"failure":{"type":"object","example":null,"properties":{"failureDetail":{"type":"string","example":null},"messages":{"type":"array","example":null,"items":{"type":"string","example":null}}}},"isHealthy":{"type":"boolean","example":null}}}},"isSystemHealthy":{"type":"boolean","example":null}}}}}}}},"tags":["Application Observability"],"method":"get","path":"/check/startup","info":{"title":"EDC Observability API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Startup","description":{"content":"Performs a startup probe to determine whether the runtime has completed startup.","type":"text/plain"},"url":{"path":["check","startup"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/edc-observability-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getStartup - - - -Performs a startup probe to determine whether the runtime has completed startup. - -
Schema array
    componentResults object[]
    failure object
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/sidebar.js deleted file mode 100644 index 26dc5c20f1c..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"category","label":"Application Observability","link":{"type":"generated-index","title":"Application Observability","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/application-observability"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/check-health","label":"checkHealth","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/get-liveness","label":"getLiveness","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/get-readiness","label":"getReadiness","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/api-observability/get-startup","label":"getStartup","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/create-asset.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/create-asset.api.mdx deleted file mode 100644 index 78be0362031..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/create-asset.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-asset -title: "createAsset" -description: "Creates a new asset together with a data address" -sidebar_label: "createAsset" -hide_title: true -hide_table_of_contents: true -api: {"description":"Creates a new asset together with a data address","operationId":"createAsset","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"asset":{"type":"object","example":null,"properties":{"id":{"type":"string","example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}},"required":["properties"]},"dataAddress":{"type":"object","example":null,"properties":{"properties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null}},"required":["properties"]}},"required":["asset","dataAddress"]}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"createdAt":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null}}}}},"description":"Asset was created successfully. Returns the asset Id and created timestamp"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request body was malformed"},"409":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Could not create asset, because an asset with that ID already exists"}},"tags":["Asset"],"method":"post","path":"/assets","jsonRequestBodyExample":null,"info":{"title":"EDC Asset API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"create Asset","description":{"content":"Creates a new asset together with a data address","type":"text/plain"},"url":{"path":["assets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/edc-asset-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## createAsset - - - -Creates a new asset together with a data address - -
Request Body
    asset object required
    properties object required
  • property name* object
    • dataAddress object required
    properties object required
  • property name* string
- -Asset was created successfully. Returns the asset Id and created timestamp - -
Schema
- -Request body was malformed - -
Schema array
- -Could not create asset, because an asset with that ID already exists - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/get-all-assets.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/get-all-assets.api.mdx deleted file mode 100644 index 1d02900714f..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/get-all-assets.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-all-assets -title: "getAllAssets" -description: "Gets all assets according to a particular query" -sidebar_label: "getAllAssets" -hide_title: true -hide_table_of_contents: true -api: {"deprecated":true,"description":"Gets all assets according to a particular query","operationId":"getAllAssets","parameters":[{"in":"query","name":"offset","schema":{"type":"integer","format":"int32","example":null}},{"in":"query","name":"limit","schema":{"type":"integer","format":"int32","example":null}},{"in":"query","name":"filter","schema":{"type":"string","example":null}},{"in":"query","name":"sort","schema":{"type":"string","enum":["ASC","DESC"],"example":null}},{"in":"query","name":"sortField","schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"createdAt":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}}}}}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request body was malformed"}},"tags":["Asset"],"method":"get","path":"/assets","info":{"title":"EDC Asset API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get All Assets","description":{"content":"Gets all assets according to a particular query","type":"text/plain"},"url":{"path":["assets"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"offset","value":""},{"disabled":false,"key":"limit","value":""},{"disabled":false,"key":"filter","value":""},{"disabled":false,"key":"sort","value":""},{"disabled":false,"key":"sortField","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/edc-asset-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getAllAssets - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Gets all assets according to a particular query - -
Query Parameters
Schema array
    properties object
  • property name* object
- -Request body was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/get-asset-data-address.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/get-asset-data-address.api.mdx deleted file mode 100644 index d8d78cf7bc9..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/get-asset-data-address.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-asset-data-address -title: "getAssetDataAddress" -description: "Gets a data address of an asset with the given ID" -sidebar_label: "getAssetDataAddress" -hide_title: true -hide_table_of_contents: true -api: {"description":"Gets a data address of an asset with the given ID","operationId":"getAssetDataAddress","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"properties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null}},"required":["properties"]}}},"description":"The data address"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"An asset with the given ID does not exist"}},"tags":["Asset"],"method":"get","path":"/assets/{id}/address","info":{"title":"EDC Asset API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Asset Data Address","description":{"content":"Gets a data address of an asset with the given ID","type":"text/plain"},"url":{"path":["assets",":id","address"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/edc-asset-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getAssetDataAddress - - - -Gets a data address of an asset with the given ID - -
Path Parameters
- -The data address - -
Schema
    properties object
  • property name* string
- -Request was malformed, e.g. id was null - -
Schema array
- -An asset with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/get-asset.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/get-asset.api.mdx deleted file mode 100644 index 75107745d96..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/get-asset.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-asset -title: "getAsset" -description: "Gets an asset with the given ID" -sidebar_label: "getAsset" -hide_title: true -hide_table_of_contents: true -api: {"description":"Gets an asset with the given ID","operationId":"getAsset","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"createdAt":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}}}}},"description":"The asset"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"An asset with the given ID does not exist"}},"tags":["Asset"],"method":"get","path":"/assets/{id}","info":{"title":"EDC Asset API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Asset","description":{"content":"Gets an asset with the given ID","type":"text/plain"},"url":{"path":["assets",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/edc-asset-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getAsset - - - -Gets an asset with the given ID - -
Path Parameters
- -The asset - -
Schema
    properties object
  • property name* object
- -Request was malformed, e.g. id was null - -
Schema array
- -An asset with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/remove-asset.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/remove-asset.api.mdx deleted file mode 100644 index 8b1a01a38b2..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/remove-asset.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: remove-asset -title: "removeAsset" -description: "Removes an asset with the given ID if possible. Deleting an asset is only possible if that asset is not yet referenced by a contract agreement, in which case an error is returned. DANGER ZONE: Note that deleting assets can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations." -sidebar_label: "removeAsset" -hide_title: true -hide_table_of_contents: true -api: {"description":"Removes an asset with the given ID if possible. Deleting an asset is only possible if that asset is not yet referenced by a contract agreement, in which case an error is returned. DANGER ZONE: Note that deleting assets can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations.","operationId":"removeAsset","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Asset was deleted successfully"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"An asset with the given ID does not exist"},"409":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"The asset cannot be deleted, because it is referenced by a contract agreement"}},"tags":["Asset"],"method":"delete","path":"/assets/{id}","info":{"title":"EDC Asset API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"remove Asset","description":{"content":"Removes an asset with the given ID if possible. Deleting an asset is only possible if that asset is not yet referenced by a contract agreement, in which case an error is returned. DANGER ZONE: Note that deleting assets can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations.","type":"text/plain"},"url":{"path":["assets",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/edc-asset-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## removeAsset - - - -Removes an asset with the given ID if possible. Deleting an asset is only possible if that asset is not yet referenced by a contract agreement, in which case an error is returned. DANGER ZONE: Note that deleting assets can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations. - -
Path Parameters
- -Asset was deleted successfully - -
- -Request was malformed, e.g. id was null - -
Schema array
- -An asset with the given ID does not exist - -
Schema array
- -The asset cannot be deleted, because it is referenced by a contract agreement - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/request-assets.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/request-assets.api.mdx deleted file mode 100644 index 9310ed61f06..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/request-assets.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: request-assets -title: "requestAssets" -description: " all assets according to a particular query" -sidebar_label: "requestAssets" -hide_title: true -hide_table_of_contents: true -api: {"description":" all assets according to a particular query","operationId":"requestAssets","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"filter":{"type":"string","example":null},"filterExpression":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"required":["operandLeft","operator"]}},"limit":{"type":"integer","format":"int32","example":null},"offset":{"type":"integer","format":"int32","example":null},"sortField":{"type":"string","example":null},"sortOrder":{"type":"string","enum":["ASC","DESC"],"example":null}}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"createdAt":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}}}}}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request body was malformed"}},"tags":["Asset"],"method":"post","path":"/assets/request","jsonRequestBodyExample":null,"info":{"title":"EDC Asset API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"request Assets","description":{"content":" all assets according to a particular query","type":"text/plain"},"url":{"path":["assets","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/edc-asset-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## requestAssets - - - - all assets according to a particular query - -
Request Body
    filterExpression object[]
Schema array
    properties object
  • property name* object
- -Request body was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/sidebar.js deleted file mode 100644 index 92eb1df479f..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"category","label":"Asset","link":{"type":"generated-index","title":"Asset","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/asset"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/get-all-assets","label":"getAllAssets","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/create-asset","label":"createAsset","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/request-assets","label":"requestAssets","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/update-asset","label":"updateAsset","className":"api-method put"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/update-data-address","label":"updateDataAddress","className":"api-method put"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/remove-asset","label":"removeAsset","className":"api-method delete"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/get-asset","label":"getAsset","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/get-asset-data-address","label":"getAssetDataAddress","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/update-asset.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/update-asset.api.mdx deleted file mode 100644 index 585f1636473..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/update-asset.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: update-asset -title: "updateAsset" -description: "Updates an asset with the given ID if it exists. If the asset is not found, no further action is taken. DANGER ZONE: Note that updating assets can have unexpected results, especially for contract offers that have been sent out or are ongoing in contract negotiations." -sidebar_label: "updateAsset" -hide_title: true -hide_table_of_contents: true -api: {"description":"Updates an asset with the given ID if it exists. If the asset is not found, no further action is taken. DANGER ZONE: Note that updating assets can have unexpected results, especially for contract offers that have been sent out or are ongoing in contract negotiations.","operationId":"updateAsset","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string","example":null}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}},"required":["properties"]}}}},"responses":{"200":{"description":"Asset was updated successfully"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"description":"Asset could not be updated, because it does not exist."}},"tags":["Asset"],"method":"put","path":"/assets/{assetId}","jsonRequestBodyExample":null,"info":{"title":"EDC Asset API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"update Asset","description":{"content":"Updates an asset with the given ID if it exists. If the asset is not found, no further action is taken. DANGER ZONE: Note that updating assets can have unexpected results, especially for contract offers that have been sent out or are ongoing in contract negotiations.","type":"text/plain"},"url":{"path":["assets",":assetId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"assetId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/edc-asset-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## updateAsset - - - -Updates an asset with the given ID if it exists. If the asset is not found, no further action is taken. DANGER ZONE: Note that updating assets can have unexpected results, especially for contract offers that have been sent out or are ongoing in contract negotiations. - -
Path Parameters
Request Body
    properties object required
  • property name* object
- -Asset was updated successfully - -
- -Request was malformed, e.g. id was null - -
Schema array
- -Asset could not be updated, because it does not exist. - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/update-data-address.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/update-data-address.api.mdx deleted file mode 100644 index 1421b167f40..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/update-data-address.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: update-data-address -title: "updateDataAddress" -description: "Updates a DataAddress for an asset with the given ID." -sidebar_label: "updateDataAddress" -hide_title: true -hide_table_of_contents: true -api: {"description":"Updates a DataAddress for an asset with the given ID.","operationId":"updateDataAddress","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string","example":null}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"properties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null}},"required":["properties"]}}}},"responses":{"200":{"description":"Asset was updated successfully"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"An asset with the given ID does not exist"}},"tags":["Asset"],"method":"put","path":"/assets/{assetId}/dataaddress","jsonRequestBodyExample":null,"info":{"title":"EDC Asset API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"update Data Address","description":{"content":"Updates a DataAddress for an asset with the given ID.","type":"text/plain"},"url":{"path":["assets",":assetId","dataaddress"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"assetId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/asset-api/edc-asset-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## updateDataAddress - - - -Updates a DataAddress for an asset with the given ID. - -
Path Parameters
Request Body
    properties object required
  • property name* string
- -Asset was updated successfully - -
- -Request was malformed, e.g. id was null - -
Schema array
- -An asset with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/catalog-api/get-catalog.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/catalog-api/get-catalog.api.mdx deleted file mode 100644 index af837acae37..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/catalog-api/get-catalog.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-catalog -title: "getCatalog" -description: "getCatalog" -sidebar_label: "getCatalog" -hide_title: true -hide_table_of_contents: true -api: {"deprecated":true,"operationId":"getCatalog","parameters":[{"in":"query","name":"providerUrl","required":true,"schema":{"type":"string","example":null}},{"in":"query","name":"offset","schema":{"type":"integer","format":"int32","example":null}},{"in":"query","name":"limit","schema":{"type":"integer","format":"int32","example":null}},{"in":"query","name":"filter","schema":{"type":"string","example":null}},{"in":"query","name":"sort","schema":{"type":"string","enum":["ASC","DESC"],"example":null}},{"in":"query","name":"sortField","schema":{"type":"string","example":null}}],"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"contractOffers":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"asset":{"type":"object","example":null,"properties":{"createdAt":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}}},"consumer":{"type":"string","format":"uri","example":null},"contractEnd":{"type":"string","format":"date-time","example":null},"contractStart":{"type":"string","format":"date-time","example":null},"id":{"type":"string","example":null},"offerEnd":{"type":"string","format":"date-time","example":null},"offerStart":{"type":"string","format":"date-time","example":null},"policy":{"type":"object","example":null,"properties":{"@type":{"type":"string","enum":["SET","OFFER","CONTRACT"],"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"permissions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":"circular()","target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null}}},"provider":{"type":"string","format":"uri","example":null}}}},"dataServices":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"endpointUrl":{"type":"string","example":null},"id":{"type":"string","example":null},"terms":{"type":"string","example":null}}}},"datasets":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"distributions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"dataService":{"type":"object","example":null,"properties":{"endpointUrl":{"type":"string","example":null},"id":{"type":"string","example":null},"terms":{"type":"string","example":null}}},"format":{"type":"string","example":null}}}},"id":{"type":"string","example":null},"offers":{"type":"object","additionalProperties":{"type":"object","example":null,"properties":{"@type":{"type":"string","enum":["SET","OFFER","CONTRACT"],"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"permissions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":"circular()","target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null}}},"example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}}}},"id":{"type":"string","example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}}}}},"description":"Gets contract offers (=catalog) of a single connector"}},"tags":["Catalog"],"description":"getCatalog","method":"get","path":"/catalog","info":{"title":"EDC Catalog API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Catalog","description":{"type":"text/plain"},"url":{"path":["catalog"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"providerUrl","value":""},{"disabled":false,"key":"offset","value":""},{"disabled":false,"key":"limit","value":""},{"disabled":false,"key":"filter","value":""},{"disabled":false,"key":"sort","value":""},{"disabled":false,"key":"sortField","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/catalog-api/edc-catalog-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getCatalog - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -getCatalog - -
Query Parameters
- -Gets contract offers (=catalog) of a single connector - -
Schema
    contractOffers object[]
    asset object
    properties object
  • property name* object
    • policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
    dataServices object[]
    datasets object[]
    distributions object[]
    dataService object
    offers object
  • property name* object
    • properties object
  • property name* object
    • properties object
  • property name* object
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/catalog-api/request-catalog.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/catalog-api/request-catalog.api.mdx deleted file mode 100644 index c46e5c6f7ea..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/catalog-api/request-catalog.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: request-catalog -title: "requestCatalog" -description: "requestCatalog" -sidebar_label: "requestCatalog" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"requestCatalog","requestBody":{"content":{"*/*":{"schema":{"type":"object","example":null,"properties":{"providerUrl":{"type":"string","example":null},"querySpec":{"type":"object","example":null,"properties":{"filter":{"type":"string","example":null},"filterExpression":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"required":["operandLeft","operator"]}},"limit":{"type":"integer","format":"int32","example":null},"offset":{"type":"integer","format":"int32","example":null},"sortField":{"type":"string","example":null},"sortOrder":{"type":"string","enum":["ASC","DESC"],"example":null}}}},"required":["providerUrl"]}}},"required":true},"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"contractOffers":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"asset":{"type":"object","example":null,"properties":{"createdAt":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}}},"consumer":{"type":"string","format":"uri","example":null},"contractEnd":{"type":"string","format":"date-time","example":null},"contractStart":{"type":"string","format":"date-time","example":null},"id":{"type":"string","example":null},"offerEnd":{"type":"string","format":"date-time","example":null},"offerStart":{"type":"string","format":"date-time","example":null},"policy":{"type":"object","example":null,"properties":{"@type":{"type":"string","enum":["SET","OFFER","CONTRACT"],"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"permissions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":"circular()","target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null}}},"provider":{"type":"string","format":"uri","example":null}}}},"dataServices":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"endpointUrl":{"type":"string","example":null},"id":{"type":"string","example":null},"terms":{"type":"string","example":null}}}},"datasets":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"distributions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"dataService":{"type":"object","example":null,"properties":{"endpointUrl":{"type":"string","example":null},"id":{"type":"string","example":null},"terms":{"type":"string","example":null}}},"format":{"type":"string","example":null}}}},"id":{"type":"string","example":null},"offers":{"type":"object","additionalProperties":{"type":"object","example":null,"properties":{"@type":{"type":"string","enum":["SET","OFFER","CONTRACT"],"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"permissions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":"circular()","target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null}}},"example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}}}},"id":{"type":"string","example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null}}}}},"description":"Gets contract offers (=catalog) of a single connector"}},"tags":["Catalog"],"description":"requestCatalog","method":"post","path":"/catalog/request","info":{"title":"EDC Catalog API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"request Catalog","description":{"type":"text/plain"},"url":{"path":["catalog","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"*/*"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\""}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/catalog-api/edc-catalog-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## requestCatalog - - - -requestCatalog - -
Request Body required
    querySpec object
    filterExpression object[]
- -Gets contract offers (=catalog) of a single connector - -
Schema
    contractOffers object[]
    asset object
    properties object
  • property name* object
    • policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
    dataServices object[]
    datasets object[]
    distributions object[]
    dataService object
    offers object
  • property name* object
    • properties object
  • property name* object
    • properties object
  • property name* object
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/catalog-api/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/catalog-api/sidebar.js deleted file mode 100644 index 8c8c5cb1b5c..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/catalog-api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"category","label":"Catalog","link":{"type":"generated-index","title":"Catalog","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/catalog-api/catalog"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/catalog-api/get-catalog","label":"getCatalog","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/catalog-api/request-catalog","label":"requestCatalog","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/get-all-agreements.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/get-all-agreements.api.mdx deleted file mode 100644 index 54b4a5aae0e..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/get-all-agreements.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-all-agreements -title: "getAllAgreements" -description: "Gets all contract agreements according to a particular query" -sidebar_label: "getAllAgreements" -hide_title: true -hide_table_of_contents: true -api: {"deprecated":true,"description":"Gets all contract agreements according to a particular query","operationId":"getAllAgreements","parameters":[{"in":"query","name":"offset","schema":{"type":"integer","format":"int32","example":null}},{"in":"query","name":"limit","schema":{"type":"integer","format":"int32","example":null}},{"in":"query","name":"filter","schema":{"type":"string","example":null}},{"in":"query","name":"sort","schema":{"type":"string","enum":["ASC","DESC"],"example":null}},{"in":"query","name":"sortField","schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"assetId":{"type":"string","example":null},"consumerAgentId":{"type":"string","example":null},"contractEndDate":{"type":"integer","format":"int64","example":null},"contractSigningDate":{"type":"integer","format":"int64","example":null},"contractStartDate":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null},"policy":{"type":"object","example":null,"properties":{"@type":{"type":"string","enum":["SET","OFFER","CONTRACT"],"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"permissions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":"circular()","target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null}}},"providerAgentId":{"type":"string","example":null}},"required":["assetId","consumerAgentId","id","policy","providerAgentId"]}}}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request body was malformed"}},"tags":["Contract Agreement"],"method":"get","path":"/contractagreements","info":{"title":"EDC Contract Agreement API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get All Agreements","description":{"content":"Gets all contract agreements according to a particular query","type":"text/plain"},"url":{"path":["contractagreements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"offset","value":""},{"disabled":false,"key":"limit","value":""},{"disabled":false,"key":"filter","value":""},{"disabled":false,"key":"sort","value":""},{"disabled":false,"key":"sortField","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/edc-contract-agreement-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getAllAgreements - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Gets all contract agreements according to a particular query - -
Query Parameters
Schema array
    policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -Request body was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/get-contract-agreement.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/get-contract-agreement.api.mdx deleted file mode 100644 index 0b91cbcf8bb..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/get-contract-agreement.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-contract-agreement -title: "getContractAgreement" -description: "Gets an contract agreement with the given ID" -sidebar_label: "getContractAgreement" -hide_title: true -hide_table_of_contents: true -api: {"description":"Gets an contract agreement with the given ID","operationId":"getContractAgreement","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"assetId":{"type":"string","example":null},"consumerAgentId":{"type":"string","example":null},"contractEndDate":{"type":"integer","format":"int64","example":null},"contractSigningDate":{"type":"integer","format":"int64","example":null},"contractStartDate":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null},"policy":{"type":"object","example":null,"properties":{"@type":{"type":"string","enum":["SET","OFFER","CONTRACT"],"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"permissions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":"circular()","target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null}}},"providerAgentId":{"type":"string","example":null}},"required":["assetId","consumerAgentId","id","policy","providerAgentId"]}}},"description":"The contract agreement"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"An contract agreement with the given ID does not exist"}},"tags":["Contract Agreement"],"method":"get","path":"/contractagreements/{id}","info":{"title":"EDC Contract Agreement API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Contract Agreement","description":{"content":"Gets an contract agreement with the given ID","type":"text/plain"},"url":{"path":["contractagreements",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/edc-contract-agreement-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getContractAgreement - - - -Gets an contract agreement with the given ID - -
Path Parameters
- -The contract agreement - -
Schema
    policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -Request was malformed, e.g. id was null - -
Schema array
- -An contract agreement with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/query-all-agreements.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/query-all-agreements.api.mdx deleted file mode 100644 index 052d661773d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/query-all-agreements.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: query-all-agreements -title: "queryAllAgreements" -description: "Gets all contract agreements according to a particular query" -sidebar_label: "queryAllAgreements" -hide_title: true -hide_table_of_contents: true -api: {"description":"Gets all contract agreements according to a particular query","operationId":"queryAllAgreements","requestBody":{"content":{"*/*":{"schema":{"type":"object","example":null,"properties":{"filter":{"type":"string","example":null},"filterExpression":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"required":["operandLeft","operator"]}},"limit":{"type":"integer","format":"int32","example":null},"offset":{"type":"integer","format":"int32","example":null},"sortField":{"type":"string","example":null},"sortOrder":{"type":"string","enum":["ASC","DESC"],"example":null}}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"assetId":{"type":"string","example":null},"consumerAgentId":{"type":"string","example":null},"contractEndDate":{"type":"integer","format":"int64","example":null},"contractSigningDate":{"type":"integer","format":"int64","example":null},"contractStartDate":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null},"policy":{"type":"object","example":null,"properties":{"@type":{"type":"string","enum":["SET","OFFER","CONTRACT"],"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"permissions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":"circular()","target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null}}},"providerAgentId":{"type":"string","example":null}},"required":["assetId","consumerAgentId","id","policy","providerAgentId"]}}}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request body was malformed"}},"tags":["Contract Agreement"],"method":"post","path":"/contractagreements/request","info":{"title":"EDC Contract Agreement API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"query All Agreements","description":{"content":"Gets all contract agreements according to a particular query","type":"text/plain"},"url":{"path":["contractagreements","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"*/*"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\""}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/edc-contract-agreement-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## queryAllAgreements - - - -Gets all contract agreements according to a particular query - -
Request Body
    filterExpression object[]
Schema array
    policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -Request body was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/sidebar.js deleted file mode 100644 index 2889de411ff..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"category","label":"Contract Agreement","link":{"type":"generated-index","title":"Contract Agreement","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/contract-agreement"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/get-all-agreements","label":"getAllAgreements","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/query-all-agreements","label":"queryAllAgreements","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-agreement-api/get-contract-agreement","label":"getContractAgreement","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/create-contract-definition.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/create-contract-definition.api.mdx deleted file mode 100644 index fb73a38867e..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/create-contract-definition.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-contract-definition -title: "createContractDefinition" -description: "Creates a new contract definition" -sidebar_label: "createContractDefinition" -hide_title: true -hide_table_of_contents: true -api: {"description":"Creates a new contract definition","operationId":"createContractDefinition","requestBody":{"content":{"*/*":{"schema":{"type":"object","example":null,"properties":{"accessPolicyId":{"type":"string","example":null},"contractPolicyId":{"type":"string","example":null},"criteria":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"required":["operandLeft","operator"]}},"id":{"type":"string","example":null},"validity":{"type":"integer","format":"int64","example":null}},"required":["accessPolicyId","contractPolicyId","criteria"]}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"createdAt":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null}}}}},"description":"contract definition was created successfully. Returns the Contract Definition Id and created timestamp"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request body was malformed"},"409":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Could not create contract definition, because a contract definition with that ID already exists"}},"tags":["Contract Definition"],"method":"post","path":"/contractdefinitions","info":{"title":"EDC Contract Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"create Contract Definition","description":{"content":"Creates a new contract definition","type":"text/plain"},"url":{"path":["contractdefinitions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"*/*"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\""}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/edc-contract-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## createContractDefinition - - - -Creates a new contract definition - -
Request Body
    criteria object[] required
- -contract definition was created successfully. Returns the Contract Definition Id and created timestamp - -
Schema
- -Request body was malformed - -
Schema array
- -Could not create contract definition, because a contract definition with that ID already exists - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/delete-contract-definition.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/delete-contract-definition.api.mdx deleted file mode 100644 index 14a94b7e4d1..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/delete-contract-definition.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: delete-contract-definition -title: "deleteContractDefinition" -description: "Removes a contract definition with the given ID if possible. DANGER ZONE: Note that deleting contract definitions can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations." -sidebar_label: "deleteContractDefinition" -hide_title: true -hide_table_of_contents: true -api: {"description":"Removes a contract definition with the given ID if possible. DANGER ZONE: Note that deleting contract definitions can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations.","operationId":"deleteContractDefinition","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Contract definition was deleted successfully"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"A contract definition with the given ID does not exist"}},"tags":["Contract Definition"],"method":"delete","path":"/contractdefinitions/{id}","info":{"title":"EDC Contract Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"delete Contract Definition","description":{"content":"Removes a contract definition with the given ID if possible. DANGER ZONE: Note that deleting contract definitions can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations.","type":"text/plain"},"url":{"path":["contractdefinitions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/edc-contract-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## deleteContractDefinition - - - -Removes a contract definition with the given ID if possible. DANGER ZONE: Note that deleting contract definitions can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations. - -
Path Parameters
- -Contract definition was deleted successfully - -
- -Request was malformed, e.g. id was null - -
Schema array
- -A contract definition with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/get-all-contract-definitions.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/get-all-contract-definitions.api.mdx deleted file mode 100644 index cc33c3cfc7d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/get-all-contract-definitions.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-all-contract-definitions -title: "getAllContractDefinitions" -description: "Returns all contract definitions according to a query" -sidebar_label: "getAllContractDefinitions" -hide_title: true -hide_table_of_contents: true -api: {"deprecated":true,"description":"Returns all contract definitions according to a query","operationId":"getAllContractDefinitions","parameters":[{"in":"query","name":"offset","schema":{"type":"integer","format":"int32","example":null}},{"in":"query","name":"limit","schema":{"type":"integer","format":"int32","example":null}},{"in":"query","name":"filter","schema":{"type":"string","example":null}},{"in":"query","name":"sort","schema":{"type":"string","enum":["ASC","DESC"],"example":null}},{"in":"query","name":"sortField","schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"accessPolicyId":{"type":"string","example":null},"contractPolicyId":{"type":"string","example":null},"createdAt":{"type":"integer","format":"int64","example":null},"criteria":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"required":["operandLeft","operator"]}},"id":{"type":"string","example":null},"validity":{"type":"integer","format":"int64","example":null}}}}}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed"}},"tags":["Contract Definition"],"method":"get","path":"/contractdefinitions","info":{"title":"EDC Contract Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get All Contract Definitions","description":{"content":"Returns all contract definitions according to a query","type":"text/plain"},"url":{"path":["contractdefinitions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"offset","value":""},{"disabled":false,"key":"limit","value":""},{"disabled":false,"key":"filter","value":""},{"disabled":false,"key":"sort","value":""},{"disabled":false,"key":"sortField","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/edc-contract-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getAllContractDefinitions - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Returns all contract definitions according to a query - -
Query Parameters
Schema array
    criteria object[]
- -Request was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/get-contract-definition.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/get-contract-definition.api.mdx deleted file mode 100644 index 191701737ef..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/get-contract-definition.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-contract-definition -title: "getContractDefinition" -description: "Gets an contract definition with the given ID" -sidebar_label: "getContractDefinition" -hide_title: true -hide_table_of_contents: true -api: {"description":"Gets an contract definition with the given ID","operationId":"getContractDefinition","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"accessPolicyId":{"type":"string","example":null},"contractPolicyId":{"type":"string","example":null},"createdAt":{"type":"integer","format":"int64","example":null},"criteria":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"required":["operandLeft","operator"]}},"id":{"type":"string","example":null},"validity":{"type":"integer","format":"int64","example":null}}}}},"description":"The contract definition"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"An contract agreement with the given ID does not exist"}},"tags":["Contract Definition"],"method":"get","path":"/contractdefinitions/{id}","info":{"title":"EDC Contract Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Contract Definition","description":{"content":"Gets an contract definition with the given ID","type":"text/plain"},"url":{"path":["contractdefinitions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/edc-contract-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getContractDefinition - - - -Gets an contract definition with the given ID - -
Path Parameters
- -The contract definition - -
Schema
    criteria object[]
- -Request was malformed, e.g. id was null - -
Schema array
- -An contract agreement with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/query-all-contract-definitions.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/query-all-contract-definitions.api.mdx deleted file mode 100644 index 26dbdc1e8c4..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/query-all-contract-definitions.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: query-all-contract-definitions -title: "queryAllContractDefinitions" -description: "Returns all contract definitions according to a query" -sidebar_label: "queryAllContractDefinitions" -hide_title: true -hide_table_of_contents: true -api: {"description":"Returns all contract definitions according to a query","operationId":"queryAllContractDefinitions","requestBody":{"content":{"*/*":{"schema":{"type":"object","example":null,"properties":{"filter":{"type":"string","example":null},"filterExpression":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"required":["operandLeft","operator"]}},"limit":{"type":"integer","format":"int32","example":null},"offset":{"type":"integer","format":"int32","example":null},"sortField":{"type":"string","example":null},"sortOrder":{"type":"string","enum":["ASC","DESC"],"example":null}}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"accessPolicyId":{"type":"string","example":null},"contractPolicyId":{"type":"string","example":null},"createdAt":{"type":"integer","format":"int64","example":null},"criteria":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"required":["operandLeft","operator"]}},"id":{"type":"string","example":null},"validity":{"type":"integer","format":"int64","example":null}}}}}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed"}},"tags":["Contract Definition"],"method":"post","path":"/contractdefinitions/request","info":{"title":"EDC Contract Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"query All Contract Definitions","description":{"content":"Returns all contract definitions according to a query","type":"text/plain"},"url":{"path":["contractdefinitions","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"*/*"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\""}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/edc-contract-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## queryAllContractDefinitions - - - -Returns all contract definitions according to a query - -
Request Body
    filterExpression object[]
Schema array
    criteria object[]
- -Request was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/sidebar.js deleted file mode 100644 index c8329ee886e..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"category","label":"Contract Definition","link":{"type":"generated-index","title":"Contract Definition","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/contract-definition"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/get-all-contract-definitions","label":"getAllContractDefinitions","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/create-contract-definition","label":"createContractDefinition","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/query-all-contract-definitions","label":"queryAllContractDefinitions","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/update-contract-definition","label":"updateContractDefinition","className":"api-method put"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/delete-contract-definition","label":"deleteContractDefinition","className":"api-method delete"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/get-contract-definition","label":"getContractDefinition","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/update-contract-definition.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/update-contract-definition.api.mdx deleted file mode 100644 index 9b033e16419..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/update-contract-definition.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: update-contract-definition -title: "updateContractDefinition" -description: "Updated a contract definition with the given ID" -sidebar_label: "updateContractDefinition" -hide_title: true -hide_table_of_contents: true -api: {"description":"Updated a contract definition with the given ID","operationId":"updateContractDefinition","parameters":[{"in":"path","name":"contractDefinitionId","required":true,"schema":{"type":"string","example":null}}],"requestBody":{"content":{"*/*":{"schema":{"type":"object","example":null,"properties":{"accessPolicyId":{"type":"string","example":null},"contractPolicyId":{"type":"string","example":null},"criteria":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"required":["operandLeft","operator"]}},"validity":{"type":"integer","format":"int64","example":null}},"required":["accessPolicyId","contractPolicyId","criteria"]}}}},"responses":{"204":{"description":"Contract definition was updated successfully"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"A contract definition with the given ID does not exist"}},"tags":["Contract Definition"],"method":"put","path":"/contractdefinitions/{contractDefinitionId}","info":{"title":"EDC Contract Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"update Contract Definition","description":{"content":"Updated a contract definition with the given ID","type":"text/plain"},"url":{"path":["contractdefinitions",":contractDefinitionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contractDefinitionId"}]},"header":[{"key":"Content-Type","value":"*/*"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\""}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-definition-api/edc-contract-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## updateContractDefinition - - - -Updated a contract definition with the given ID - -
Path Parameters
Request Body
    criteria object[] required
- -Contract definition was updated successfully - -
- -Request was malformed, e.g. id was null - -
Schema array
- -A contract definition with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/cancel-negotiation.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/cancel-negotiation.api.mdx deleted file mode 100644 index 14211030efd..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/cancel-negotiation.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: cancel-negotiation -title: "cancelNegotiation" -description: "Requests aborting the contract negotiation. Due to the asynchronous nature of contract negotiations, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state." -sidebar_label: "cancelNegotiation" -hide_title: true -hide_table_of_contents: true -api: {"description":"Requests aborting the contract negotiation. Due to the asynchronous nature of contract negotiations, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state.","operationId":"cancelNegotiation","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Request to cancel the Contract negotiation was successfully received","links":{"poll-state":{"operationId":"getNegotiationState"}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"A contract negotiation with the given ID does not exist"}},"tags":["Contract Negotiation"],"method":"post","path":"/contractnegotiations/{id}/cancel","info":{"title":"EDC Contract Negotiation API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"cancel Negotiation","description":{"content":"Requests aborting the contract negotiation. Due to the asynchronous nature of contract negotiations, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state.","type":"text/plain"},"url":{"path":["contractnegotiations",":id","cancel"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/edc-contract-negotiation-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## cancelNegotiation - - - -Requests aborting the contract negotiation. Due to the asynchronous nature of contract negotiations, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state. - -
Path Parameters
- -Request to cancel the Contract negotiation was successfully received - -
- -Request was malformed, e.g. id was null - -
Schema array
- -A contract negotiation with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/decline-negotiation.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/decline-negotiation.api.mdx deleted file mode 100644 index 7e9e4b68c10..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/decline-negotiation.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: decline-negotiation -title: "declineNegotiation" -description: "Requests cancelling the contract negotiation. Due to the asynchronous nature of contract negotiations, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state." -sidebar_label: "declineNegotiation" -hide_title: true -hide_table_of_contents: true -api: {"description":"Requests cancelling the contract negotiation. Due to the asynchronous nature of contract negotiations, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state.","operationId":"declineNegotiation","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Request to decline the Contract negotiation was successfully received","links":{"poll-state":{"operationId":"getNegotiationState"}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"A contract negotiation with the given ID does not exist"}},"tags":["Contract Negotiation"],"method":"post","path":"/contractnegotiations/{id}/decline","info":{"title":"EDC Contract Negotiation API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"decline Negotiation","description":{"content":"Requests cancelling the contract negotiation. Due to the asynchronous nature of contract negotiations, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state.","type":"text/plain"},"url":{"path":["contractnegotiations",":id","decline"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/edc-contract-negotiation-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## declineNegotiation - - - -Requests cancelling the contract negotiation. Due to the asynchronous nature of contract negotiations, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state. - -
Path Parameters
- -Request to decline the Contract negotiation was successfully received - -
- -Request was malformed, e.g. id was null - -
Schema array
- -A contract negotiation with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/get-agreement-for-negotiation.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/get-agreement-for-negotiation.api.mdx deleted file mode 100644 index 98f48af154b..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/get-agreement-for-negotiation.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-agreement-for-negotiation -title: "getAgreementForNegotiation" -description: "Gets a contract agreement for a contract negotiation with the given ID" -sidebar_label: "getAgreementForNegotiation" -hide_title: true -hide_table_of_contents: true -api: {"description":"Gets a contract agreement for a contract negotiation with the given ID","operationId":"getAgreementForNegotiation","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"assetId":{"type":"string","example":null},"consumerAgentId":{"type":"string","example":null},"contractEndDate":{"type":"integer","format":"int64","example":null},"contractSigningDate":{"type":"integer","format":"int64","example":null},"contractStartDate":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null},"policy":{"type":"object","example":null,"properties":{"@type":{"type":"string","enum":["SET","OFFER","CONTRACT"],"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"permissions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":"circular()","target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null}}},"providerAgentId":{"type":"string","example":null}},"required":["assetId","consumerAgentId","id","policy","providerAgentId"]}}},"description":"The contract agreement that is attached to the negotiation, or null"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"An contract negotiation with the given ID does not exist"}},"tags":["Contract Negotiation"],"method":"get","path":"/contractnegotiations/{id}/agreement","info":{"title":"EDC Contract Negotiation API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Agreement For Negotiation","description":{"content":"Gets a contract agreement for a contract negotiation with the given ID","type":"text/plain"},"url":{"path":["contractnegotiations",":id","agreement"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/edc-contract-negotiation-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getAgreementForNegotiation - - - -Gets a contract agreement for a contract negotiation with the given ID - -
Path Parameters
- -The contract agreement that is attached to the negotiation, or null - -
Schema
    policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -Request was malformed, e.g. id was null - -
Schema array
- -An contract negotiation with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/get-negotiation-state.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/get-negotiation-state.api.mdx deleted file mode 100644 index 5c67fb6e317..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/get-negotiation-state.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-negotiation-state -title: "getNegotiationState" -description: "Gets the state of a contract negotiation with the given ID" -sidebar_label: "getNegotiationState" -hide_title: true -hide_table_of_contents: true -api: {"description":"Gets the state of a contract negotiation with the given ID","operationId":"getNegotiationState","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"state":{"type":"string","example":null}}}}},"description":"The contract negotiation's state"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"An contract negotiation with the given ID does not exist"}},"tags":["Contract Negotiation"],"method":"get","path":"/contractnegotiations/{id}/state","info":{"title":"EDC Contract Negotiation API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Negotiation State","description":{"content":"Gets the state of a contract negotiation with the given ID","type":"text/plain"},"url":{"path":["contractnegotiations",":id","state"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/edc-contract-negotiation-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getNegotiationState - - - -Gets the state of a contract negotiation with the given ID - -
Path Parameters
- -The contract negotiation's state - -
Schema
- -Request was malformed, e.g. id was null - -
Schema array
- -An contract negotiation with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/get-negotiation.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/get-negotiation.api.mdx deleted file mode 100644 index 79b9290ef07..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/get-negotiation.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-negotiation -title: "getNegotiation" -description: "Gets an contract negotiation with the given ID" -sidebar_label: "getNegotiation" -hide_title: true -hide_table_of_contents: true -api: {"description":"Gets an contract negotiation with the given ID","operationId":"getNegotiation","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"callbackAddresses":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"events":{"type":"array","example":null,"items":{"type":"string","example":null},"uniqueItems":true},"transactional":{"type":"boolean","example":null},"uri":{"type":"string","example":null}}}},"contractAgreementId":{"type":"string","example":null},"counterPartyAddress":{"type":"string","example":null},"createdAt":{"type":"integer","format":"int64","example":null},"errorDetail":{"type":"string","example":null},"id":{"type":"string","example":null},"protocol":{"type":"string","example":null},"state":{"type":"string","example":null},"type":{"type":"string","enum":["CONSUMER","PROVIDER"],"example":null},"updatedAt":{"type":"integer","format":"int64","example":null}}}}},"description":"The contract negotiation"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"An contract negotiation with the given ID does not exist"}},"tags":["Contract Negotiation"],"method":"get","path":"/contractnegotiations/{id}","info":{"title":"EDC Contract Negotiation API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Negotiation","description":{"content":"Gets an contract negotiation with the given ID","type":"text/plain"},"url":{"path":["contractnegotiations",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/edc-contract-negotiation-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getNegotiation - - - -Gets an contract negotiation with the given ID - -
Path Parameters
- -The contract negotiation - -
Schema
    callbackAddresses object[]
- -Request was malformed, e.g. id was null - -
Schema array
- -An contract negotiation with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/get-negotiations.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/get-negotiations.api.mdx deleted file mode 100644 index 94e127175a4..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/get-negotiations.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-negotiations -title: "getNegotiations" -description: "Returns all contract negotiations according to a query" -sidebar_label: "getNegotiations" -hide_title: true -hide_table_of_contents: true -api: {"deprecated":true,"description":"Returns all contract negotiations according to a query","operationId":"getNegotiations","parameters":[{"in":"query","name":"offset","schema":{"type":"integer","format":"int32","example":null}},{"in":"query","name":"limit","schema":{"type":"integer","format":"int32","example":null}},{"in":"query","name":"filter","schema":{"type":"string","example":null}},{"in":"query","name":"sort","schema":{"type":"string","enum":["ASC","DESC"],"example":null}},{"in":"query","name":"sortField","schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"callbackAddresses":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"events":{"type":"array","example":null,"items":{"type":"string","example":null},"uniqueItems":true},"transactional":{"type":"boolean","example":null},"uri":{"type":"string","example":null}}}},"contractAgreementId":{"type":"string","example":null},"counterPartyAddress":{"type":"string","example":null},"createdAt":{"type":"integer","format":"int64","example":null},"errorDetail":{"type":"string","example":null},"id":{"type":"string","example":null},"protocol":{"type":"string","example":null},"state":{"type":"string","example":null},"type":{"type":"string","enum":["CONSUMER","PROVIDER"],"example":null},"updatedAt":{"type":"integer","format":"int64","example":null}}}}}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed"}},"tags":["Contract Negotiation"],"method":"get","path":"/contractnegotiations","info":{"title":"EDC Contract Negotiation API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Negotiations","description":{"content":"Returns all contract negotiations according to a query","type":"text/plain"},"url":{"path":["contractnegotiations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"offset","value":""},{"disabled":false,"key":"limit","value":""},{"disabled":false,"key":"filter","value":""},{"disabled":false,"key":"sort","value":""},{"disabled":false,"key":"sortField","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/edc-contract-negotiation-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getNegotiations - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Returns all contract negotiations according to a query - -
Query Parameters
Schema array
    callbackAddresses object[]
- -Request was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/initiate-contract-negotiation.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/initiate-contract-negotiation.api.mdx deleted file mode 100644 index 8fc1e7560f7..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/initiate-contract-negotiation.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: initiate-contract-negotiation -title: "initiateContractNegotiation" -description: "Initiates a contract negotiation for a given offer and with the given counter part. Please note that successfully invoking this endpoint only means that the negotiation was initiated. Clients must poll the /{id}/state endpoint to track the state" -sidebar_label: "initiateContractNegotiation" -hide_title: true -hide_table_of_contents: true -api: {"description":"Initiates a contract negotiation for a given offer and with the given counter part. Please note that successfully invoking this endpoint only means that the negotiation was initiated. Clients must poll the /{id}/state endpoint to track the state","operationId":"initiateContractNegotiation","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"callbackAddresses":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"events":{"type":"array","example":null,"items":{"type":"string","example":null},"uniqueItems":true},"transactional":{"type":"boolean","example":null},"uri":{"type":"string","example":null}},"required":["events","uri"]}},"connectorAddress":{"type":"string","example":null},"connectorId":{"type":"string","example":null},"consumerId":{"type":"string","example":null},"offer":{"type":"object","example":null,"properties":{"assetId":{"type":"string","example":null},"offerId":{"type":"string","example":null},"policy":{"type":"object","example":null,"properties":{"@type":{"type":"string","enum":["SET","OFFER","CONTRACT"],"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"permissions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":"circular()","target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null}}},"validity":{"type":"integer","format":"int64","example":null}},"required":["assetId","offerId","policy"]},"protocol":{"type":"string","example":null},"providerId":{"type":"string","example":null}},"required":["connectorAddress","connectorId","offer","protocol"]}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"createdAt":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null}}}}},"description":"The negotiation was successfully initiated. Returns the contract negotiation ID and created timestamp","links":{"poll-state":{"operationId":"getNegotiationState","parameters":{"id":"$response.body#/id"}}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request body was malformed"}},"tags":["Contract Negotiation"],"method":"post","path":"/contractnegotiations","jsonRequestBodyExample":null,"info":{"title":"EDC Contract Negotiation API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"initiate Contract Negotiation","description":{"content":"Initiates a contract negotiation for a given offer and with the given counter part. Please note that successfully invoking this endpoint only means that the negotiation was initiated. Clients must poll the /{id}/state endpoint to track the state","type":"text/plain"},"url":{"path":["contractnegotiations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/edc-contract-negotiation-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## initiateContractNegotiation - - - -Initiates a contract negotiation for a given offer and with the given counter part. Please note that successfully invoking this endpoint only means that the negotiation was initiated. Clients must poll the /{id}/state endpoint to track the state - -
Request Body
    callbackAddresses object[]
    offer object required
    policy object required
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -The negotiation was successfully initiated. Returns the contract negotiation ID and created timestamp - -
Schema
- -Request body was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/query-negotiations.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/query-negotiations.api.mdx deleted file mode 100644 index f6b1efc5508..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/query-negotiations.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: query-negotiations -title: "queryNegotiations" -description: "Returns all contract negotiations according to a query" -sidebar_label: "queryNegotiations" -hide_title: true -hide_table_of_contents: true -api: {"description":"Returns all contract negotiations according to a query","operationId":"queryNegotiations","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"filter":{"type":"string","example":null},"filterExpression":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"required":["operandLeft","operator"]}},"limit":{"type":"integer","format":"int32","example":null},"offset":{"type":"integer","format":"int32","example":null},"sortField":{"type":"string","example":null},"sortOrder":{"type":"string","enum":["ASC","DESC"],"example":null}}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"callbackAddresses":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"events":{"type":"array","example":null,"items":{"type":"string","example":null},"uniqueItems":true},"transactional":{"type":"boolean","example":null},"uri":{"type":"string","example":null}}}},"contractAgreementId":{"type":"string","example":null},"counterPartyAddress":{"type":"string","example":null},"createdAt":{"type":"integer","format":"int64","example":null},"errorDetail":{"type":"string","example":null},"id":{"type":"string","example":null},"protocol":{"type":"string","example":null},"state":{"type":"string","example":null},"type":{"type":"string","enum":["CONSUMER","PROVIDER"],"example":null},"updatedAt":{"type":"integer","format":"int64","example":null}}}}}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed"}},"tags":["Contract Negotiation"],"method":"post","path":"/contractnegotiations/request","jsonRequestBodyExample":null,"info":{"title":"EDC Contract Negotiation API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"query Negotiations","description":{"content":"Returns all contract negotiations according to a query","type":"text/plain"},"url":{"path":["contractnegotiations","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/edc-contract-negotiation-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## queryNegotiations - - - -Returns all contract negotiations according to a query - -
Request Body
    filterExpression object[]
Schema array
    callbackAddresses object[]
- -Request was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/sidebar.js deleted file mode 100644 index 20e63b45778..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"category","label":"Contract Negotiation","link":{"type":"generated-index","title":"Contract Negotiation","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/contract-negotiation"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/get-negotiations","label":"getNegotiations","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/initiate-contract-negotiation","label":"initiateContractNegotiation","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/query-negotiations","label":"queryNegotiations","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/get-negotiation","label":"getNegotiation","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/get-agreement-for-negotiation","label":"getAgreementForNegotiation","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/cancel-negotiation","label":"cancelNegotiation","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/decline-negotiation","label":"declineNegotiation","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/contract-negotiation-api/get-negotiation-state","label":"getNegotiationState","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/add-entry.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/add-entry.api.mdx deleted file mode 100644 index d1e46ee8f8c..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/add-entry.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: add-entry -title: "addEntry" -description: "addEntry" -sidebar_label: "addEntry" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"addEntry","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"allowedDestTypes":{"type":"array","example":null,"items":{"type":"string","example":null},"uniqueItems":true},"allowedSourceTypes":{"type":"array","example":null,"items":{"type":"string","example":null},"uniqueItems":true},"id":{"type":"string","example":null},"lastActive":{"type":"integer","format":"int64","example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"turnCount":{"type":"integer","format":"int32","example":null},"url":{"type":"string","format":"url","example":null}}}}}},"responses":{"default":{"description":"default response"}},"tags":["Dataplane Selector"],"description":"addEntry","method":"post","path":"/instances","jsonRequestBodyExample":null,"info":{"title":"EDC Data Plane Selector API","description":null,"license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.0.1-SNAPSHOT"},"postman":{"name":"add Entry","description":{"type":"text/plain"},"url":{"path":["instances"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/edc-data-plane-selector-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## addEntry - - - -addEntry - -
Request Body
    properties object
  • property name* object
- -default response - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/find.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/find.api.mdx deleted file mode 100644 index 7939c4c35d3..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/find.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: find -title: "find" -description: "find" -sidebar_label: "find" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"find","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"destination":{"type":"object","example":null,"properties":{"properties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null}}},"source":{"type":"object","example":null,"properties":{"properties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null}}},"strategy":{"type":"string","example":null}}}}}},"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"allowedDestTypes":{"type":"array","example":null,"items":{"type":"string","example":null},"uniqueItems":true},"allowedSourceTypes":{"type":"array","example":null,"items":{"type":"string","example":null},"uniqueItems":true},"id":{"type":"string","example":null},"lastActive":{"type":"integer","format":"int64","example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"turnCount":{"type":"integer","format":"int32","example":null},"url":{"type":"string","format":"url","example":null}}}}},"description":"default response"}},"tags":["Dataplane Selector"],"description":"find","method":"post","path":"/instances/select","jsonRequestBodyExample":null,"info":{"title":"EDC Data Plane Selector API","description":null,"license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.0.1-SNAPSHOT"},"postman":{"name":"find","description":{"type":"text/plain"},"url":{"path":["instances","select"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/edc-data-plane-selector-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## find - - - -find - -
Request Body
    destination object
    properties object
  • property name* string
    • source object
    properties object
  • property name* string
- -default response - -
Schema
    properties object
  • property name* object
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/get-all.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/get-all.api.mdx deleted file mode 100644 index 087fe2967d1..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/get-all.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-all -title: "getAll" -description: "getAll" -sidebar_label: "getAll" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"getAll","responses":{"default":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"allowedDestTypes":{"type":"array","example":null,"items":{"type":"string","example":null},"uniqueItems":true},"allowedSourceTypes":{"type":"array","example":null,"items":{"type":"string","example":null},"uniqueItems":true},"id":{"type":"string","example":null},"lastActive":{"type":"integer","format":"int64","example":null},"properties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"turnCount":{"type":"integer","format":"int32","example":null},"url":{"type":"string","format":"url","example":null}}}}}},"description":"default response"}},"tags":["Dataplane Selector"],"description":"getAll","method":"get","path":"/instances","info":{"title":"EDC Data Plane Selector API","description":null,"license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get All","description":{"type":"text/plain"},"url":{"path":["instances"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/edc-data-plane-selector-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getAll - - - -getAll - -
- -default response - -
Schema array
    properties object
  • property name* object
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/sidebar.js deleted file mode 100644 index 61fa4c2f215..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"category","label":"Dataplane Selector","link":{"type":"generated-index","title":"Dataplane Selector","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/dataplane-selector"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/get-all","label":"getAll","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/add-entry","label":"addEntry","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/data-plane-selector-api/find","label":"find","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/create-policy-definition.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/create-policy-definition.api.mdx deleted file mode 100644 index 46d1175fa01..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/create-policy-definition.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-policy-definition -title: "createPolicyDefinition" -description: "Creates a new policy definition" -sidebar_label: "createPolicyDefinition" -hide_title: true -hide_table_of_contents: true -api: {"description":"Creates a new policy definition","operationId":"createPolicyDefinition","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"id":{"type":"string","example":null},"policy":{"type":"object","additionalProperties":{"type":"object","example":null,"properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"],"example":null}}},"example":null,"properties":{"empty":{"type":"boolean","example":null},"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"],"example":null}}}},"required":["policy"]}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"createdAt":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null}}}}},"description":"policy definition was created successfully. Returns the Policy Definition Id and created timestamp"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request body was malformed"},"409":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Could not create policy definition, because a contract definition with that ID already exists"}},"tags":["Policy Definition"],"method":"post","path":"/v2/policydefinitions","jsonRequestBodyExample":null,"info":{"title":"EDC Policy Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"create Policy Definition","description":{"content":"Creates a new policy definition","type":"text/plain"},"url":{"path":["v2","policydefinitions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/edc-policy-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## createPolicyDefinition - - - -Creates a new policy definition - -
Request Body
    policy object required
- -policy definition was created successfully. Returns the Policy Definition Id and created timestamp - -
Schema
- -Request body was malformed - -
Schema array
- -Could not create policy definition, because a contract definition with that ID already exists - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/create-policy.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/create-policy.api.mdx deleted file mode 100644 index 4819b826f8c..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/create-policy.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: create-policy -title: "createPolicy" -description: "Creates a new policy definition" -sidebar_label: "createPolicy" -hide_title: true -hide_table_of_contents: true -api: {"deprecated":true,"description":"Creates a new policy definition","operationId":"createPolicy","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"id":{"type":"string","example":null},"policy":{"type":"object","example":null,"properties":{"@type":{"type":"string","enum":["SET","OFFER","CONTRACT"],"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"permissions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":"circular()","target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null}}}},"required":["policy"]}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"createdAt":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null}}}}},"description":"policy definition was created successfully. Returns the Policy Definition Id and created timestamp"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request body was malformed"},"409":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Could not create policy definition, because a contract definition with that ID already exists"}},"tags":["Policy"],"method":"post","path":"/policydefinitions","jsonRequestBodyExample":null,"info":{"title":"EDC Policy Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"create Policy","description":{"content":"Creates a new policy definition","type":"text/plain"},"url":{"path":["policydefinitions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/edc-policy-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## createPolicy - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Creates a new policy definition - -
Request Body
    policy object required
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -policy definition was created successfully. Returns the Policy Definition Id and created timestamp - -
Schema
- -Request body was malformed - -
Schema array
- -Could not create policy definition, because a contract definition with that ID already exists - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/delete-policy-definition.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/delete-policy-definition.api.mdx deleted file mode 100644 index 2490f7233de..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/delete-policy-definition.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: delete-policy-definition -title: "deletePolicyDefinition" -description: "Removes a policy definition with the given ID if possible. Deleting a policy definition is only possible if that policy definition is not yet referenced by a contract definition, in which case an error is returned. DANGER ZONE: Note that deleting policy definitions can have unexpected results, do this at your own risk!" -sidebar_label: "deletePolicyDefinition" -hide_title: true -hide_table_of_contents: true -api: {"description":"Removes a policy definition with the given ID if possible. Deleting a policy definition is only possible if that policy definition is not yet referenced by a contract definition, in which case an error is returned. DANGER ZONE: Note that deleting policy definitions can have unexpected results, do this at your own risk!","operationId":"deletePolicyDefinition","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Policy definition was deleted successfully"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"An policy definition with the given ID does not exist"},"409":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"The policy definition cannot be deleted, because it is referenced by a contract definition"}},"tags":["Policy Definition"],"method":"delete","path":"/v2/policydefinitions/{id}","info":{"title":"EDC Policy Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"delete Policy Definition","description":{"content":"Removes a policy definition with the given ID if possible. Deleting a policy definition is only possible if that policy definition is not yet referenced by a contract definition, in which case an error is returned. DANGER ZONE: Note that deleting policy definitions can have unexpected results, do this at your own risk!","type":"text/plain"},"url":{"path":["v2","policydefinitions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/edc-policy-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## deletePolicyDefinition - - - -Removes a policy definition with the given ID if possible. Deleting a policy definition is only possible if that policy definition is not yet referenced by a contract definition, in which case an error is returned. DANGER ZONE: Note that deleting policy definitions can have unexpected results, do this at your own risk! - -
Path Parameters
- -Policy definition was deleted successfully - -
- -Request was malformed, e.g. id was null - -
Schema array
- -An policy definition with the given ID does not exist - -
Schema array
- -The policy definition cannot be deleted, because it is referenced by a contract definition - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/delete-policy.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/delete-policy.api.mdx deleted file mode 100644 index a9df8d8719d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/delete-policy.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: delete-policy -title: "deletePolicy" -description: "Removes a policy definition with the given ID if possible. Deleting a policy definition is only possible if that policy definition is not yet referenced by a contract definition, in which case an error is returned. DANGER ZONE: Note that deleting policy definitions can have unexpected results, do this at your own risk!" -sidebar_label: "deletePolicy" -hide_title: true -hide_table_of_contents: true -api: {"deprecated":true,"description":"Removes a policy definition with the given ID if possible. Deleting a policy definition is only possible if that policy definition is not yet referenced by a contract definition, in which case an error is returned. DANGER ZONE: Note that deleting policy definitions can have unexpected results, do this at your own risk!","operationId":"deletePolicy","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Policy definition was deleted successfully"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"An policy definition with the given ID does not exist"},"409":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"The policy definition cannot be deleted, because it is referenced by a contract definition"}},"tags":["Policy"],"method":"delete","path":"/policydefinitions/{id}","info":{"title":"EDC Policy Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"delete Policy","description":{"content":"Removes a policy definition with the given ID if possible. Deleting a policy definition is only possible if that policy definition is not yet referenced by a contract definition, in which case an error is returned. DANGER ZONE: Note that deleting policy definitions can have unexpected results, do this at your own risk!","type":"text/plain"},"url":{"path":["policydefinitions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/edc-policy-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## deletePolicy - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Removes a policy definition with the given ID if possible. Deleting a policy definition is only possible if that policy definition is not yet referenced by a contract definition, in which case an error is returned. DANGER ZONE: Note that deleting policy definitions can have unexpected results, do this at your own risk! - -
Path Parameters
- -Policy definition was deleted successfully - -
- -Request was malformed, e.g. id was null - -
Schema array
- -An policy definition with the given ID does not exist - -
Schema array
- -The policy definition cannot be deleted, because it is referenced by a contract definition - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/get-all-policies.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/get-all-policies.api.mdx deleted file mode 100644 index 28ccd04d0a6..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/get-all-policies.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-all-policies -title: "getAllPolicies" -description: "Returns all policy definitions according to a query" -sidebar_label: "getAllPolicies" -hide_title: true -hide_table_of_contents: true -api: {"deprecated":true,"description":"Returns all policy definitions according to a query","operationId":"getAllPolicies","parameters":[{"in":"query","name":"offset","schema":{"type":"integer","format":"int32","example":null}},{"in":"query","name":"limit","schema":{"type":"integer","format":"int32","example":null}},{"in":"query","name":"filter","schema":{"type":"string","example":null}},{"in":"query","name":"sort","schema":{"type":"string","enum":["ASC","DESC"],"example":null}},{"in":"query","name":"sortField","schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"createdAt":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null},"policy":{"type":"object","example":null,"properties":{"@type":{"type":"string","enum":["SET","OFFER","CONTRACT"],"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"permissions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":"circular()","target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null}}}},"required":["policy"]}}}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed"}},"tags":["Policy"],"method":"get","path":"/policydefinitions","info":{"title":"EDC Policy Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get All Policies","description":{"content":"Returns all policy definitions according to a query","type":"text/plain"},"url":{"path":["policydefinitions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"offset","value":""},{"disabled":false,"key":"limit","value":""},{"disabled":false,"key":"filter","value":""},{"disabled":false,"key":"sort","value":""},{"disabled":false,"key":"sortField","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/edc-policy-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getAllPolicies - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Returns all policy definitions according to a query - -
Query Parameters
Schema array
    policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -Request was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/get-policy-definition.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/get-policy-definition.api.mdx deleted file mode 100644 index 235ac03d85b..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/get-policy-definition.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-policy-definition -title: "getPolicyDefinition" -description: "Gets a policy definition with the given ID" -sidebar_label: "getPolicyDefinition" -hide_title: true -hide_table_of_contents: true -api: {"description":"Gets a policy definition with the given ID","operationId":"getPolicyDefinition","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"createdAt":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null},"policy":{"type":"object","additionalProperties":{"type":"object","example":null,"properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"],"example":null}}},"example":null,"properties":{"empty":{"type":"boolean","example":null},"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"],"example":null}}}},"required":["policy"]}}},"description":"The policy definition"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"An policy definition with the given ID does not exist"}},"tags":["Policy Definition"],"method":"get","path":"/v2/policydefinitions/{id}","info":{"title":"EDC Policy Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Policy Definition","description":{"content":"Gets a policy definition with the given ID","type":"text/plain"},"url":{"path":["v2","policydefinitions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/edc-policy-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getPolicyDefinition - - - -Gets a policy definition with the given ID - -
Path Parameters
- -The policy definition - -
Schema
    policy object
- -Request was malformed, e.g. id was null - -
Schema array
- -An policy definition with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/get-policy.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/get-policy.api.mdx deleted file mode 100644 index 80ef9c62fbe..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/get-policy.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-policy -title: "getPolicy" -description: "Gets a policy definition with the given ID" -sidebar_label: "getPolicy" -hide_title: true -hide_table_of_contents: true -api: {"deprecated":true,"description":"Gets a policy definition with the given ID","operationId":"getPolicy","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"createdAt":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null},"policy":{"type":"object","example":null,"properties":{"@type":{"type":"string","enum":["SET","OFFER","CONTRACT"],"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"permissions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":"circular()","target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null}}}},"required":["policy"]}}},"description":"The policy definition"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"An policy definition with the given ID does not exist"}},"tags":["Policy"],"method":"get","path":"/policydefinitions/{id}","info":{"title":"EDC Policy Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Policy","description":{"content":"Gets a policy definition with the given ID","type":"text/plain"},"url":{"path":["policydefinitions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/edc-policy-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getPolicy - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Gets a policy definition with the given ID - -
Path Parameters
- -The policy definition - -
Schema
    policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -Request was malformed, e.g. id was null - -
Schema array
- -An policy definition with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/query-all-policies.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/query-all-policies.api.mdx deleted file mode 100644 index a445a2c553b..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/query-all-policies.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: query-all-policies -title: "queryAllPolicies" -description: "Returns all policy definitions according to a query" -sidebar_label: "queryAllPolicies" -hide_title: true -hide_table_of_contents: true -api: {"deprecated":true,"description":"Returns all policy definitions according to a query","operationId":"queryAllPolicies","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"filter":{"type":"string","example":null},"filterExpression":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"required":["operandLeft","operator"]}},"limit":{"type":"integer","format":"int32","example":null},"offset":{"type":"integer","format":"int32","example":null},"sortField":{"type":"string","example":null},"sortOrder":{"type":"string","enum":["ASC","DESC"],"example":null}}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"createdAt":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null},"policy":{"type":"object","example":null,"properties":{"@type":{"type":"string","enum":["SET","OFFER","CONTRACT"],"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"permissions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":"circular()","target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null}}}},"required":["policy"]}}}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed"}},"tags":["Policy"],"method":"post","path":"/policydefinitions/request","jsonRequestBodyExample":null,"info":{"title":"EDC Policy Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"query All Policies","description":{"content":"Returns all policy definitions according to a query","type":"text/plain"},"url":{"path":["policydefinitions","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/edc-policy-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## queryAllPolicies - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Returns all policy definitions according to a query - -
Request Body
    filterExpression object[]
Schema array
    policy object
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -Request was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/query-policy-definitions.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/query-policy-definitions.api.mdx deleted file mode 100644 index 77f8a458ebd..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/query-policy-definitions.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: query-policy-definitions -title: "queryPolicyDefinitions" -description: "Returns all policy definitions according to a query" -sidebar_label: "queryPolicyDefinitions" -hide_title: true -hide_table_of_contents: true -api: {"description":"Returns all policy definitions according to a query","operationId":"queryPolicyDefinitions","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"filter":{"type":"string","example":null},"filterExpression":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"required":["operandLeft","operator"]}},"limit":{"type":"integer","format":"int32","example":null},"offset":{"type":"integer","format":"int32","example":null},"sortField":{"type":"string","example":null},"sortOrder":{"type":"string","enum":["ASC","DESC"],"example":null}}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"createdAt":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null},"policy":{"type":"object","additionalProperties":{"type":"object","example":null,"properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"],"example":null}}},"example":null,"properties":{"empty":{"type":"boolean","example":null},"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"],"example":null}}}},"required":["policy"]}}}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed"}},"tags":["Policy Definition"],"method":"post","path":"/v2/policydefinitions/request","jsonRequestBodyExample":null,"info":{"title":"EDC Policy Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"query Policy Definitions","description":{"content":"Returns all policy definitions according to a query","type":"text/plain"},"url":{"path":["v2","policydefinitions","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/edc-policy-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## queryPolicyDefinitions - - - -Returns all policy definitions according to a query - -
Request Body
    filterExpression object[]
Schema array
    policy object
- -Request was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/sidebar.js deleted file mode 100644 index 7076fca8062..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"category","label":"Policy","link":{"type":"generated-index","title":"Policy","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/policy"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/get-all-policies","label":"getAllPolicies","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/create-policy","label":"createPolicy","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/query-all-policies","label":"queryAllPolicies","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/delete-policy","label":"deletePolicy","className":"menu__list-item--deprecated api-method delete"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/get-policy","label":"getPolicy","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/update-policy","label":"updatePolicy","className":"menu__list-item--deprecated api-method put"}]},{"type":"category","label":"Policy Definition","link":{"type":"generated-index","title":"Policy Definition","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/policy-definition"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/create-policy-definition","label":"createPolicyDefinition","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/query-policy-definitions","label":"queryPolicyDefinitions","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/delete-policy-definition","label":"deletePolicyDefinition","className":"api-method delete"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/get-policy-definition","label":"getPolicyDefinition","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/update-policy-definition","label":"updatePolicyDefinition","className":"api-method put"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/update-policy-definition.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/update-policy-definition.api.mdx deleted file mode 100644 index 6c70d7cac4d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/update-policy-definition.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: update-policy-definition -title: "updatePolicyDefinition" -description: "Updates an existing Policy, If the Policy is not found, an error is reported" -sidebar_label: "updatePolicyDefinition" -hide_title: true -hide_table_of_contents: true -api: {"description":"Updates an existing Policy, If the Policy is not found, an error is reported","operationId":"updatePolicyDefinition","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"policy":{"type":"object","additionalProperties":{"type":"object","example":null,"properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"],"example":null}}},"example":null,"properties":{"empty":{"type":"boolean","example":null},"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"],"example":null}}}},"required":["policy"]}}}},"responses":{"200":{"description":"policy definition was updated successfully. Returns the Policy Definition Id and updated timestamp"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request body was malformed"},"404":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}},"description":"policy definition could not be updated, because it does not exists"}},"tags":["Policy Definition"],"method":"put","path":"/v2/policydefinitions/{id}","jsonRequestBodyExample":null,"info":{"title":"EDC Policy Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"update Policy Definition","description":{"content":"Updates an existing Policy, If the Policy is not found, an error is reported","type":"text/plain"},"url":{"path":["v2","policydefinitions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/edc-policy-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## updatePolicyDefinition - - - -Updates an existing Policy, If the Policy is not found, an error is reported - -
Path Parameters
Request Body
    policy object required
- -policy definition was updated successfully. Returns the Policy Definition Id and updated timestamp - -
- -Request body was malformed - -
Schema array
- -policy definition could not be updated, because it does not exists - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/update-policy.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/update-policy.api.mdx deleted file mode 100644 index 1399d946ae3..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/update-policy.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: update-policy -title: "updatePolicy" -description: "Updates an existing Policy, If the Policy is not found, an error is reported" -sidebar_label: "updatePolicy" -hide_title: true -hide_table_of_contents: true -api: {"deprecated":true,"description":"Updates an existing Policy, If the Policy is not found, an error is reported","operationId":"updatePolicy","parameters":[{"in":"path","name":"policyId","required":true,"schema":{"type":"string","example":null}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"policy":{"type":"object","example":null,"properties":{"@type":{"type":"string","enum":["SET","OFFER","CONTRACT"],"example":null},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"extensibleProperties":{"type":"object","additionalProperties":{"type":"object","example":null},"example":null},"inheritsFrom":{"type":"string","example":null},"obligations":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":"circular()"},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"permissions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"duties":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"consequence":"circular()","constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"parentPermission":"circular()","target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"prohibitions":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"action":{"type":"object","example":null,"properties":{"constraint":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]},"includedIn":{"type":"string","example":null},"type":{"type":"string","example":null}}},"assignee":{"type":"string","example":null},"assigner":{"type":"string","example":null},"constraints":{"type":"array","example":null,"items":{"type":"object","discriminator":{"propertyName":"edctype"},"example":null,"properties":{"edctype":{"type":"string","example":null}},"required":["edctype"]}},"target":{"type":"string","example":null},"uid":{"type":"string","example":null}}}},"target":{"type":"string","example":null}}}},"required":["policy"]}}}},"responses":{"200":{"description":"policy definition was updated successfully. Returns the Policy Definition Id and updated timestamp"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request body was malformed"},"404":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}},"description":"policy definition could not be updated, because it does not exists"}},"tags":["Policy"],"method":"put","path":"/policydefinitions/{policyId}","jsonRequestBodyExample":null,"info":{"title":"EDC Policy Definition API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"update Policy","description":{"content":"Updates an existing Policy, If the Policy is not found, an error is reported","type":"text/plain"},"url":{"path":["policydefinitions",":policyId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"policyId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/policy-definition-api/edc-policy-definition-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## updatePolicy - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Updates an existing Policy, If the Policy is not found, an error is reported - -
Path Parameters
Request Body
    policy object required
    extensibleProperties object
  • property name* object
    • obligations object[]
    action object
    constraint object
    constraints object[]
    parentPermission object
    action object
    constraint object
    constraints object[]
    permissions object[]
    action object
    constraint object
    constraints object[]
    duties object[]
    action object
    constraint object
    constraints object[]
    prohibitions object[]
    action object
    constraint object
    constraints object[]
- -policy definition was updated successfully. Returns the Policy Definition Id and updated timestamp - -
- -Request body was malformed - -
Schema array
- -policy definition could not be updated, because it does not exists - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/provision-http/call-deprovision-webhook.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/provision-http/call-deprovision-webhook.api.mdx deleted file mode 100644 index cf1d6712c1e..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/provision-http/call-deprovision-webhook.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: call-deprovision-webhook -title: "callDeprovisionWebhook" -description: "callDeprovisionWebhook" -sidebar_label: "callDeprovisionWebhook" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"callDeprovisionWebhook","parameters":[{"in":"path","name":"processId","required":true,"schema":{"type":"string","example":null}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"error":{"type":"boolean","example":null},"errorMessage":{"type":"string","example":null},"inProcess":{"type":"boolean","example":null},"provisionedResourceId":{"type":"string","example":null}}}}}},"responses":{"default":{"description":"default response"}},"tags":["HTTP Provisioner Webhook"],"description":"callDeprovisionWebhook","method":"post","path":"/callback/{processId}/deprovision","jsonRequestBodyExample":null,"info":{"title":"EDC Provision HTTP","description":null,"license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.0.1-SNAPSHOT"},"postman":{"name":"call Deprovision Webhook","description":{"type":"text/plain"},"url":{"path":["callback",":processId","deprovision"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"processId"}]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/provision-http/edc-provision-http -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"; - -## callDeprovisionWebhook - - - -callDeprovisionWebhook - -
Path Parameters
Request Body
- -default response - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/provision-http/call-provision-webhook.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/provision-http/call-provision-webhook.api.mdx deleted file mode 100644 index a3c96e51fc5..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/provision-http/call-provision-webhook.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: call-provision-webhook -title: "callProvisionWebhook" -description: "callProvisionWebhook" -sidebar_label: "callProvisionWebhook" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"callProvisionWebhook","parameters":[{"in":"path","name":"processId","required":true,"schema":{"type":"string","example":null}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"apiKeyJwt":{"type":"string","example":null},"assetId":{"type":"string","example":null},"contentDataAddress":{"type":"object","example":null,"properties":{"properties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null}}},"hasToken":{"type":"boolean","example":null},"resourceDefinitionId":{"type":"string","example":null},"resourceName":{"type":"string","example":null}},"required":["apiKeyJwt","assetId","contentDataAddress","resourceDefinitionId","resourceName"]}}}},"responses":{"default":{"description":"default response"}},"tags":["HTTP Provisioner Webhook"],"description":"callProvisionWebhook","method":"post","path":"/callback/{processId}/provision","jsonRequestBodyExample":null,"info":{"title":"EDC Provision HTTP","description":null,"license":{"name":"Apache License v2.0","url":"http://apache.org/v2"},"version":"0.0.1-SNAPSHOT"},"postman":{"name":"call Provision Webhook","description":{"type":"text/plain"},"url":{"path":["callback",":processId","provision"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"processId"}]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/provision-http/edc-provision-http -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"; - -## callProvisionWebhook - - - -callProvisionWebhook - -
Path Parameters
Request Body
    contentDataAddress object required
    properties object
  • property name* string
- -default response - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/provision-http/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/provision-http/sidebar.js deleted file mode 100644 index 82ee11f6372..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/provision-http/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"category","label":"HTTP Provisioner Webhook","link":{"type":"generated-index","title":"HTTP Provisioner Webhook","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/provision-http/http-provisioner-webhook"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/provision-http/call-deprovision-webhook","label":"callDeprovisionWebhook","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/management-api/provision-http/call-provision-webhook","label":"callProvisionWebhook","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/cancel-transfer-process.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/cancel-transfer-process.api.mdx deleted file mode 100644 index d8434d807fb..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/cancel-transfer-process.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: cancel-transfer-process -title: "cancelTransferProcess" -description: "Requests aborting the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state." -sidebar_label: "cancelTransferProcess" -hide_title: true -hide_table_of_contents: true -api: {"deprecated":true,"description":"Requests aborting the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state.","operationId":"cancelTransferProcess","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Request to cancel the transfer process was successfully received","links":{"poll-state":{"operationId":"getTransferProcessState"}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"A contract negotiation with the given ID does not exist"}},"tags":["Transfer Process"],"method":"post","path":"/transferprocess/{id}/cancel","info":{"title":"EDC Transfer Process API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"cancel Transfer Process","description":{"content":"Requests aborting the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state.","type":"text/plain"},"url":{"path":["transferprocess",":id","cancel"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/edc-transfer-process-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## cancelTransferProcess - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Requests aborting the transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state. - -
Path Parameters
- -Request to cancel the transfer process was successfully received - -
- -Request was malformed, e.g. id was null - -
Schema array
- -A contract negotiation with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/deprovision-transfer-process.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/deprovision-transfer-process.api.mdx deleted file mode 100644 index e741238ae31..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/deprovision-transfer-process.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: deprovision-transfer-process -title: "deprovisionTransferProcess" -description: "Requests the deprovisioning of resources associated with a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. This may take a long time, so clients must poll the /{id}/state endpoint to track the state." -sidebar_label: "deprovisionTransferProcess" -hide_title: true -hide_table_of_contents: true -api: {"description":"Requests the deprovisioning of resources associated with a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. This may take a long time, so clients must poll the /{id}/state endpoint to track the state.","operationId":"deprovisionTransferProcess","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"description":"Request to deprovision the transfer process was successfully received","links":{"poll-state":{"operationId":"getTransferProcessState"}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"A contract negotiation with the given ID does not exist"}},"tags":["Transfer Process"],"method":"post","path":"/transferprocess/{id}/deprovision","info":{"title":"EDC Transfer Process API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"deprovision Transfer Process","description":{"content":"Requests the deprovisioning of resources associated with a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. This may take a long time, so clients must poll the /{id}/state endpoint to track the state.","type":"text/plain"},"url":{"path":["transferprocess",":id","deprovision"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/edc-transfer-process-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## deprovisionTransferProcess - - - -Requests the deprovisioning of resources associated with a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. This may take a long time, so clients must poll the /{id}/state endpoint to track the state. - -
Path Parameters
- -Request to deprovision the transfer process was successfully received - -
- -Request was malformed, e.g. id was null - -
Schema array
- -A contract negotiation with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/get-all-transfer-processes.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/get-all-transfer-processes.api.mdx deleted file mode 100644 index 02f28387152..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/get-all-transfer-processes.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-all-transfer-processes -title: "getAllTransferProcesses" -description: "Returns all transfer process according to a query" -sidebar_label: "getAllTransferProcesses" -hide_title: true -hide_table_of_contents: true -api: {"deprecated":true,"description":"Returns all transfer process according to a query","operationId":"getAllTransferProcesses","parameters":[{"in":"query","name":"offset","schema":{"type":"integer","format":"int32","example":null}},{"in":"query","name":"limit","schema":{"type":"integer","format":"int32","example":null}},{"in":"query","name":"filter","schema":{"type":"string","example":null}},{"in":"query","name":"sort","schema":{"type":"string","enum":["ASC","DESC"],"example":null}},{"in":"query","name":"sortField","schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"callbackAddresses":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"events":{"type":"array","example":null,"items":{"type":"string","example":null},"uniqueItems":true},"transactional":{"type":"boolean","example":null},"uri":{"type":"string","example":null}}}},"createdAt":{"type":"integer","format":"int64","example":null},"dataDestination":{"type":"object","example":null,"properties":{"properties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null}}},"dataRequest":{"type":"object","example":null,"properties":{"assetId":{"type":"string","example":null},"connectorId":{"type":"string","example":null},"contractId":{"type":"string","example":null},"id":{"type":"string","example":null}}},"errorDetail":{"type":"string","example":null},"id":{"type":"string","example":null},"state":{"type":"string","example":null},"stateTimestamp":{"type":"integer","format":"int64","example":null},"type":{"type":"string","example":null},"updatedAt":{"type":"integer","format":"int64","example":null}}}}}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed"}},"tags":["Transfer Process"],"method":"get","path":"/transferprocess","info":{"title":"EDC Transfer Process API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get All Transfer Processes","description":{"content":"Returns all transfer process according to a query","type":"text/plain"},"url":{"path":["transferprocess"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"offset","value":""},{"disabled":false,"key":"limit","value":""},{"disabled":false,"key":"filter","value":""},{"disabled":false,"key":"sort","value":""},{"disabled":false,"key":"sortField","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/edc-transfer-process-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getAllTransferProcesses - -:::caution deprecated - -This endpoint has been deprecated and may be removed in future versions of the API. - -::: - -Returns all transfer process according to a query - -
Query Parameters
Schema array
    callbackAddresses object[]
    dataDestination object
    properties object
  • property name* string
    • dataRequest object
- -Request was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/get-transfer-process-state.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/get-transfer-process-state.api.mdx deleted file mode 100644 index d01ecb9ac80..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/get-transfer-process-state.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-transfer-process-state -title: "getTransferProcessState" -description: "Gets the state of a transfer process with the given ID" -sidebar_label: "getTransferProcessState" -hide_title: true -hide_table_of_contents: true -api: {"description":"Gets the state of a transfer process with the given ID","operationId":"getTransferProcessState","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"state":{"type":"string","example":null}}}}},"description":"The transfer process's state"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"An transfer process with the given ID does not exist"}},"tags":["Transfer Process"],"method":"get","path":"/transferprocess/{id}/state","info":{"title":"EDC Transfer Process API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Transfer Process State","description":{"content":"Gets the state of a transfer process with the given ID","type":"text/plain"},"url":{"path":["transferprocess",":id","state"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/edc-transfer-process-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getTransferProcessState - - - -Gets the state of a transfer process with the given ID - -
Path Parameters
- -The transfer process's state - -
Schema
- -Request was malformed, e.g. id was null - -
Schema array
- -An transfer process with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/get-transfer-process.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/get-transfer-process.api.mdx deleted file mode 100644 index 37be3625985..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/get-transfer-process.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-transfer-process -title: "getTransferProcess" -description: "Gets an transfer process with the given ID" -sidebar_label: "getTransferProcess" -hide_title: true -hide_table_of_contents: true -api: {"description":"Gets an transfer process with the given ID","operationId":"getTransferProcess","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"callbackAddresses":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"events":{"type":"array","example":null,"items":{"type":"string","example":null},"uniqueItems":true},"transactional":{"type":"boolean","example":null},"uri":{"type":"string","example":null}}}},"createdAt":{"type":"integer","format":"int64","example":null},"dataDestination":{"type":"object","example":null,"properties":{"properties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null}}},"dataRequest":{"type":"object","example":null,"properties":{"assetId":{"type":"string","example":null},"connectorId":{"type":"string","example":null},"contractId":{"type":"string","example":null},"id":{"type":"string","example":null}}},"errorDetail":{"type":"string","example":null},"id":{"type":"string","example":null},"state":{"type":"string","example":null},"stateTimestamp":{"type":"integer","format":"int64","example":null},"type":{"type":"string","example":null},"updatedAt":{"type":"integer","format":"int64","example":null}}}}},"description":"The transfer process"},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"A transfer process with the given ID does not exist"}},"tags":["Transfer Process"],"method":"get","path":"/transferprocess/{id}","info":{"title":"EDC Transfer Process API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"get Transfer Process","description":{"content":"Gets an transfer process with the given ID","type":"text/plain"},"url":{"path":["transferprocess",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/edc-transfer-process-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getTransferProcess - - - -Gets an transfer process with the given ID - -
Path Parameters
- -The transfer process - -
Schema
    callbackAddresses object[]
    dataDestination object
    properties object
  • property name* string
    • dataRequest object
- -Request was malformed, e.g. id was null - -
Schema array
- -A transfer process with the given ID does not exist - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/initiate-transfer.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/initiate-transfer.api.mdx deleted file mode 100644 index 2d901473212..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/initiate-transfer.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: initiate-transfer -title: "initiateTransfer" -description: "Initiates a data transfer with the given parameters. Please note that successfully invoking this endpoint only means that the transfer was initiated. Clients must poll the /{id}/state endpoint to track the state" -sidebar_label: "initiateTransfer" -hide_title: true -hide_table_of_contents: true -api: {"description":"Initiates a data transfer with the given parameters. Please note that successfully invoking this endpoint only means that the transfer was initiated. Clients must poll the /{id}/state endpoint to track the state","operationId":"initiateTransfer","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"assetId":{"type":"string","example":null},"callbackAddresses":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"events":{"type":"array","example":null,"items":{"type":"string","example":null},"uniqueItems":true},"transactional":{"type":"boolean","example":null},"uri":{"type":"string","example":null}},"required":["events","uri"]}},"connectorAddress":{"type":"string","example":null},"connectorId":{"type":"string","example":null},"contractId":{"type":"string","example":null},"dataDestination":{"type":"object","example":null,"properties":{"properties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null}}},"id":{"type":"string","example":null},"managedResources":{"type":"boolean","example":null},"properties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null},"protocol":{"type":"string","example":null},"transferType":{"type":"object","example":null,"properties":{"contentType":{"type":"string","example":null},"isFinite":{"type":"boolean","example":null}}}},"required":["assetId","connectorAddress","connectorId","contractId","dataDestination","protocol","transferType"]}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"createdAt":{"type":"integer","format":"int64","example":null},"id":{"type":"string","example":null}}}}},"description":"The transfer was successfully initiated. Returns the transfer process ID and created timestamp","links":{"poll-state":{"operationId":"getTransferProcessState","parameters":{"id":"$response.body#/id"}}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request body was malformed"}},"tags":["Transfer Process"],"method":"post","path":"/transferprocess","jsonRequestBodyExample":null,"info":{"title":"EDC Transfer Process API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"initiate Transfer","description":{"content":"Initiates a data transfer with the given parameters. Please note that successfully invoking this endpoint only means that the transfer was initiated. Clients must poll the /{id}/state endpoint to track the state","type":"text/plain"},"url":{"path":["transferprocess"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/edc-transfer-process-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## initiateTransfer - - - -Initiates a data transfer with the given parameters. Please note that successfully invoking this endpoint only means that the transfer was initiated. Clients must poll the /{id}/state endpoint to track the state - -
Request Body
    callbackAddresses object[]
    dataDestination object required
    properties object
  • property name* string
    • properties object
  • property name* string
    • transferType object required
- -The transfer was successfully initiated. Returns the transfer process ID and created timestamp - -
Schema
- -Request body was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/query-all-transfer-processes.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/query-all-transfer-processes.api.mdx deleted file mode 100644 index ff8d2826d6c..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/query-all-transfer-processes.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: query-all-transfer-processes -title: "queryAllTransferProcesses" -description: "Returns all transfer process according to a query" -sidebar_label: "queryAllTransferProcesses" -hide_title: true -hide_table_of_contents: true -api: {"description":"Returns all transfer process according to a query","operationId":"queryAllTransferProcesses","requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"filter":{"type":"string","example":null},"filterExpression":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"operandLeft":{"type":"object","example":null},"operandRight":{"type":"object","example":null},"operator":{"type":"string","example":null}},"required":["operandLeft","operator"]}},"limit":{"type":"integer","format":"int32","example":null},"offset":{"type":"integer","format":"int32","example":null},"sortField":{"type":"string","example":null},"sortOrder":{"type":"string","enum":["ASC","DESC"],"example":null}}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"callbackAddresses":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"events":{"type":"array","example":null,"items":{"type":"string","example":null},"uniqueItems":true},"transactional":{"type":"boolean","example":null},"uri":{"type":"string","example":null}}}},"createdAt":{"type":"integer","format":"int64","example":null},"dataDestination":{"type":"object","example":null,"properties":{"properties":{"type":"object","additionalProperties":{"type":"string","example":null},"example":null}}},"dataRequest":{"type":"object","example":null,"properties":{"assetId":{"type":"string","example":null},"connectorId":{"type":"string","example":null},"contractId":{"type":"string","example":null},"id":{"type":"string","example":null}}},"errorDetail":{"type":"string","example":null},"id":{"type":"string","example":null},"state":{"type":"string","example":null},"stateTimestamp":{"type":"integer","format":"int64","example":null},"type":{"type":"string","example":null},"updatedAt":{"type":"integer","format":"int64","example":null}}}}}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed"}},"tags":["Transfer Process"],"method":"post","path":"/transferprocess/request","jsonRequestBodyExample":null,"info":{"title":"EDC Transfer Process API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"query All Transfer Processes","description":{"content":"Returns all transfer process according to a query","type":"text/plain"},"url":{"path":["transferprocess","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/edc-transfer-process-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## queryAllTransferProcesses - - - -Returns all transfer process according to a query - -
Request Body
    filterExpression object[]
Schema array
    callbackAddresses object[]
    dataDestination object
    properties object
  • property name* string
    • dataRequest object
- -Request was malformed - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/sidebar.js b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/sidebar.js deleted file mode 100644 index 9544143d05e..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"category","label":"Transfer Process","link":{"type":"generated-index","title":"Transfer Process","slug":"/category/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/transfer-process"},"items":[{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/get-all-transfer-processes","label":"getAllTransferProcesses","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/initiate-transfer","label":"initiateTransfer","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/query-all-transfer-processes","label":"queryAllTransferProcesses","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/get-transfer-process","label":"getTransferProcess","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/cancel-transfer-process","label":"cancelTransferProcess","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/deprovision-transfer-process","label":"deprovisionTransferProcess","className":"api-method post"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/get-transfer-process-state","label":"getTransferProcessState","className":"api-method get"},{"type":"doc","id":"kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/terminate-transfer-process","label":"terminateTransferProcess","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/terminate-transfer-process.api.mdx b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/terminate-transfer-process.api.mdx deleted file mode 100644 index f3de3da9040..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/terminate-transfer-process.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: terminate-transfer-process -title: "terminateTransferProcess" -description: "Requests the termination of a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state." -sidebar_label: "terminateTransferProcess" -hide_title: true -hide_table_of_contents: true -api: {"description":"Requests the termination of a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state.","operationId":"terminateTransferProcess","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","example":null}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","example":null,"properties":{"reason":{"type":"string","example":null}},"required":["reason"]}}}},"responses":{"200":{"description":"Request to cancel the transfer process was successfully received","links":{"poll-state":{"operationId":"getTransferProcessState"}}},"400":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Request was malformed, e.g. id was null"},"404":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"A contract negotiation with the given ID does not exist"},"409":{"content":{"application/json":{"schema":{"type":"array","example":null,"items":{"type":"object","example":null,"properties":{"invalidValue":{"type":"string","example":null},"message":{"type":"string","example":null},"path":{"type":"string","example":null},"type":{"type":"string","example":null}}}}}},"description":"Could not terminate transfer process, because it is already completed or terminated."}},"tags":["Transfer Process"],"method":"post","path":"/transferprocess/{id}/terminate","jsonRequestBodyExample":null,"info":{"title":"EDC Transfer Process API","description":null,"version":"0.0.1-SNAPSHOT"},"postman":{"name":"terminate Transfer Process","description":{"content":"Requests the termination of a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state.","type":"text/plain"},"url":{"path":["transferprocess",":id","terminate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/tractusx-edc/docs/kit/development-view/openAPI/transfer-process-api/edc-transfer-process-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## terminateTransferProcess - - - -Requests the termination of a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. Clients must poll the /{id}/state endpoint to track the state. - -
Path Parameters
Request Body
- -Request to cancel the transfer process was successfully received - -
- -Request was malformed, e.g. id was null - -
Schema array
- -A contract negotiation with the given ID does not exist - -
Schema array
- -Could not terminate transfer process, because it is already completed or terminated. - -
Schema array
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/page00_development_view.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/page00_development_view.md deleted file mode 100644 index 831f8b2423d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/page00_development_view.md +++ /dev/null @@ -1,28 +0,0 @@ -# Development View - -![Connector kit banner](@site/static/img/ConnectorKitIcon.png) - -## Connector KIT - -## Project Overview - -TractusX is an initiative of companies under the umbrella of the Eclipse Foundation. -It is a pilot for the larger initiative of CatenaX. -A broader overview of the project can be found on the initiative's [Github page][tractusx-edc-link] -or the homepage of the [Eclipse Foundation](https://projects.eclipse.org/projects/automotive.tractusx). - -## The EDC - -The Eclipse Dataspace Connector is one of the core components facilitating TractusX. - -:::note TractusX EDC or Core EDC? - -This documentation is for TractusX EDC. -It includes the Core EDC with all of its functionality. -However, this core is supplemented by extensions that allow for the use of additional backends and connection types. -Furthermore, the provided Helm charts, build configuration and tests allow for a smoother deployment. -::: - -You can find the repository for the TractusX EDC [here][tractusx-edc-link]. - -[tractusx-edc-link]: https://github.com/eclipse-tractusx/tractusx-edc diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/page01_eclipse_foundation.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/page01_eclipse_foundation.md deleted file mode 100644 index 5d865ff7687..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/page01_eclipse_foundation.md +++ /dev/null @@ -1,35 +0,0 @@ -# The Eclipse Foundation - -## Eclipse Development Process - -This Eclipse Foundation open project is governed by the Eclipse Foundation -Development Process and operates under the terms of the Eclipse IP Policy. - -* -* - -## Eclipse Contributor Agreement - -In order to be able to contribute to Eclipse Foundation projects you must -electronically sign the Eclipse Contributor Agreement (ECA). - -* - -The ECA provides the Eclipse Foundation with a permanent record that you agree -that each of your contributions will comply with the commitments documented in -the Developer Certificate of Origin (DCO). Having an ECA on file associated with -the email address matching the "Author" field of your contribution's Git commits -fulfills the DCO's requirement that you sign-off on your contributions. - -For more information, please see the Eclipse Committer Handbook: - - -## License - -Code in TractusX EDC is published under the [Apache License](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE). - -## Contact - -Contact the project developers via the project's "dev" list. - -* diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/page02_repository_structure.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/page02_repository_structure.md deleted file mode 100644 index 7ac6b20d9db..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/page02_repository_structure.md +++ /dev/null @@ -1,26 +0,0 @@ -# Repository Structure - -The repository for TractusX EDC can be found [here](https://github.com/eclipse-tractusx/tractusx-edc). -It contains the following components: - -## EDC Extensions - -The core EDC is extensible by design. -TractusX EDC provides such extensions. -These extensions and their documentation are available -[here](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-extensions/README.md). - -## Gradle Files for EDC Builds - -Builds of TractusX EDC are performed via Gradle. -To allow for different configurations, different builds are provided. -For example separate secrets backends are supported, but require separate builds of EDC. -Therefor, different builds are available for both -[data plane](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-dataplane/README.md) -and [control plane](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-controlplane/README.md), - -## Helm Charts for EDC Deployment - -To facilitate deployment of these different builds and their prerequisites, -Helm charts are provided. The charts and their documentation can be found -[here](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/charts/README.md). diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/page03_project_structure.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/page03_project_structure.md deleted file mode 100644 index 43de0123350..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/page03_project_structure.md +++ /dev/null @@ -1,21 +0,0 @@ -# Project Structure - -## Issue Tracking - -Issues are maintained in [GitHub Issues](https://github.com/eclipse-tractusx/tractusx-edc/issues). - -## Reporting Vulnerabilities - -Vulnerabilities in the TractusX code base are best reported directly to the -[Eclipse Foundation](https://www.eclipse.org/security/). - -## Git Flow - -The TractusX EDC repository uses a Git Flow, with `main` as the development branch and `releases` as the release branch. -Other branches should follow the naming conventions of `feature/x` or `hotfix/x`, though this is not strictly enforced. - -## Tooling - -We use Java 11 with Gradle for dependencies and builds. -We use [Spotless](https://github.com/diffplug/spotless) for code formatting. -Releases are in the form of Docker containers and Helm charts. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/page10_extensions.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/page10_extensions.md deleted file mode 100644 index dce82d15393..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/development-view/page10_extensions.md +++ /dev/null @@ -1,44 +0,0 @@ -# EDC Extensions - -The following extensions provide additional functionality to the core EDC. -They are currently only available in TractusX EDC. - -## Business Partner Validation - -This extension allows for validation of business partners within the access policy. - -## Control Plane Adapter - -The goal of this extension is to simplify the process of retrieving data out of EDC. -It returns `EndpointDataReference` object, hiding all the communication details for contract offers, -contract negotiation, transfer process and retrieving the underlying data through the data-planes. - -## CX OAuth2 - -This extension enables OAuth2 authentication between EDC connectors, -instead of the more complex authentication flow used by core EDC. - -## Data Encryption - -The EDC encrypts sensitive information inside a token it sends to other applications (potentially cross-company). -This extension implements the encryption of this data and should be used with secure keys and algorithms at all times. - -## Data Plane Selector - -This control plane extension makes it possible to configure one or more data plane instances. -During a transfer the control plane will look for an instance with matching capabilities to transfer data. - -## Hashicorp Vault - -This extension allows for usage of Hashicorp Vault for secret storage. -It is the default used in TractusX EDC. - -## PostrgreSQL Migration - -While the core EDC is able to interact with PostgreSQL databases, -it does not automate migrations between schema versions. -This extension adds that functionality. - -## Transfer Process SFTP - -This extension allows for the use of SFTP backends for the data plane (but is not included in the provided control- and data plane). diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page00_operation_view.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page00_operation_view.md deleted file mode 100644 index 14e1eef9b9a..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page00_operation_view.md +++ /dev/null @@ -1,28 +0,0 @@ -# Software Operation View - -![Connector kit banner](@site/static/img/ConnectorKitIcon.png) - -## Connector KIT - -## Introduction - -The following documentation will guide you through the TractusX EDC deployment. -You will be setting up multiple controllers and enabling communication between them. - -:::note TractusX EDC or Core EDC? - -The following guide assumes the use of the TractusX EDC. -It includes the Core EDC with all of its functionality. -However, this core is supplemented by extensions that allow for the use of additional backends and connection types. -Furthermore, the provided Helm charts, build configuration and tests allow for a smoother deployment. -::: - -## Connector Components - -In a usual EDC environment, each participant would operate at least one connector. -Each of these connectors consists of a control plane and a data plane. -The control plane functions as administration layer and is responsible for resource management, contract negotiation and administering data transfer. -The data plane does the heavy lifting of transferring and receiving data streams. - -Each of these planes comes in several variants, allowing for example secrets to be stored in Azure Vault or a Hashicorp Vault. -The setup on the following pages assumes the use of Hashicorp Vault for secrets and PostgreSQL for data storage. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page02_technical_prerequisites.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page02_technical_prerequisites.md deleted file mode 100644 index 83ed7e76bc5..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page02_technical_prerequisites.md +++ /dev/null @@ -1,43 +0,0 @@ -# Technical Prerequisites - -## Obtaining Releases - -The most recent release of TractusX EDC can be obtained under `https://github.com/eclipse-tractusx/tractusx-edc/releases`. -To create your own build, you can clone the repository at `https://github.com/eclipse-tractusx/tractusx-edc` and consult the provided README.md. -This can be useful if you want to use non-standard extensions or configuration. - -## Container Environment - -TractusX releases come in the form of Docker containers and corresponding Helm charts. -As such, recent versions of the following are required. - -- Docker -- Kubernetes -- Helm - -Seeing as these are standard tools, TractusX EDC will run on any cloud environment that can accept Helm charts. - -## Backend Dependencies - -The EDC requires backend services for persistence of data and secrets. The following backends are currently supported. - -Data Storage: - -- PostgreSQL database -- In memory database - -Secret Storage: - -- Hashicorp Vault -- Azure Vault - -The default setup assumes data storage via PostgreSQL database. -In memory storage is only recommended for running tests. -Hashicorp Vault is the default secret provider, because it is platform-agnostic. - -Helm charts are provided to set up these services locally. -**These are not suited for production environments.** - -## All-in-one deployment - -An all-in-one deployment is no longer in scope and will not be provided. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page03_local_setup_controlplane.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page03_local_setup_controlplane.md deleted file mode 100644 index 93c52606f57..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page03_local_setup_controlplane.md +++ /dev/null @@ -1,141 +0,0 @@ -# Setting up a local EDC Control Plane - -## Basics - -The EDC is split into control and data plane. -The data plane handles the actual data transfer between parties. -The control plane manages the following: - -- Resource Management (e.g. Assets, Policies & Contract Definitions CRUD) -- Contract Offering & Contract Negotiation -- Data Transfer Coordination / Management - -The EDC control plane can run as a single container on your local machine. -The following is a short overview of the necessary steps to start up the default configuration. - -## Building - -TractusX EDC is build with Gradle. The following command creates the default control plane as a docker container: - -```shell -./gardlew :edc-controlplane:edc-controlplane-postgresql-hashicorp-vault:dockerize -``` - -## Example Configuration - -The following commands can be used to create the necessary configuration files for the EDC container. -They assume sane - but unsafe - defaults. An explanation of the respective parameters can be found [here](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/README.md). - -:::danger -The following configuration is for testing purposes only. Do not use it in production. -::: - -### Example configuration.properties - -```shell -# Create configuration.properties -export CONFIGURATION_PROPERTIES_FILE=$(mktemp /tmp/configuration.properties.XXXXXX) -cat << 'EOF' > ${CONFIGURATION_PROPERTIES_FILE} - -web.http.default.port=8080 -web.http.default.path=/api -web.http.management.port=8181 -web.http.management.path=/data -web.http.control.port=9999 -web.http.control.path=/api/controlplane/control -web.http.protocol.port=8282 -web.http.protocol.path=/api/v1/ids - -edc.receiver.http.dynamic.endpoint=http://backend-service - -edc.ids.title=Eclipse Dataspace Connector -edc.ids.description=Eclipse Dataspace Connector -edc.ids.id=urn:connector:edc -edc.ids.security.profile=base -edc.ids.endpoint=http://localhost:8282/api/v1/ids -edc.ids.maintainer=http://localhost -edc.ids.curator=http://localhost -edc.ids.catalog.id=urn:catalog:default -ids.webhook.address=http://localhost:8282/api/v1/ids - -edc.hostname=localhost - -edc.api.auth.key=password - -# OAuth / DAPS related configuration -edc.oauth.token.url=https://daps.catena-x.net -edc.oauth.certificate.alias=key-to-daps-certificate-in-keyvault -edc.oauth.private.key.alias=key-to-private-key-in-keyvault -edc.oauth.client.id=daps-oauth-client-id - -# HashiCorp vault related configuration -edc.vault.hashicorp.url=http://vault -edc.vault.hashicorp.token=55555555-6666-7777-8888-999999999999 -edc.vault.hashicorp.timeout.seconds=30 - -# Control- / Data- Plane configuration -edc.transfer.proxy.endpoint=http://dataplane-public-endpoint/public -edc.transfer.proxy.token.signer.privatekey.alias=token-signer-private-key - -# Postgresql related configuration -edc.datasource.asset.name=asset -edc.datasource.asset.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_asset -edc.datasource.asset.user=user -edc.datasource.asset.password=pass -edc.datasource.contractdefinition.name=contractdefinition -edc.datasource.contractdefinition.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractdefinition -edc.datasource.contractdefinition.user=user -edc.datasource.contractdefinition.password=pass -edc.datasource.contractnegotiation.name=contractnegotiation -edc.datasource.contractnegotiation.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractnegotiation -edc.datasource.contractnegotiation.user=user -edc.datasource.contractnegotiation.password=pass -edc.datasource.policy.name=policy -edc.datasource.policy.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_policy -edc.datasource.policy.user=user -edc.datasource.policy.password=pass -edc.datasource.transferprocess.name=transferprocess -edc.datasource.transferprocess.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_transferprocess -edc.datasource.transferprocess.user=user -edc.datasource.transferprocess.password=pass -EOF -``` - -### Example logging.properties - -```shell -# Create logging.properties -export LOGGING_PROPERTIES_FILE=$(mktemp /tmp/logging.properties.XXXXXX) -cat << 'EOF' > ${LOGGING_PROPERTIES_FILE} -.level=INFO -org.eclipse.edc.level=ALL -handlers=java.util.logging.ConsoleHandler -java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter -java.util.logging.ConsoleHandler.level=ALL -java.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n -EOF -``` - -### Example opentelemetry.properties - -```shell -# Create opentelemetry.properties -export OPENTELEMETRY_PROPERTIES_FILE=$(mktemp /tmp/opentelemetry.properties.XXXXXX) -cat << 'EOF' > ${OPENTELEMETRY_PROPERTIES_FILE} -otel.javaagent.enabled=false -otel.javaagent.debug=false -EOF -``` - -## Running the Control Plane - -Once the configuration is created, the container can be run directly via docker. - -```shell -docker run \ - -p 8080:8080 -p 8181:8181 -p 8182:8182 -p 8282:8282 -p 9090:9090 -p 9999:9999 \ - -v ${CONFIGURATION_PROPERTIES_FILE:-/dev/null}:/app/configuration.properties \ - -v ${LOGGING_PROPERTIES_FILE:-/dev/null}:/app/logging.properties \ - -v ${OPENTELEMETRY_PROPERTIES_FILE:-/dev/null}:/app/opentelemetry.properties \ - -i edc-controlplane-postgresql-hashicorp-vault:latest -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page04_local_setup_dataplane.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page04_local_setup_dataplane.md deleted file mode 100644 index 729a2371b77..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page04_local_setup_dataplane.md +++ /dev/null @@ -1,98 +0,0 @@ -# Setting up a local EDC Data Plane - -## Basics - -The EDC is split into control and data plane. -The data plane handles the actual data transfer between parties. -The control plane manages the following: - -- Resource Management (e.g. Assets, Policies & Contract Definitions CRUD) -- Contract Offering & Contract Negotiation -- Data Transfer Coordination / Management - -The EDC data plane can run as a single container on your local machine. -The following is a short overview of the necessary steps to start up the default configuration. - -## Building - -TractusX EDC is build with Gradle. The following command creates the default data plane as a docker container: - -```shell -./gardlew :edc-dataplane:edc-dataplane-hashicorp-vault:dockerize -``` - -## Example Configuration - -The following commands can be used to create the necessary configuration files for the EDC container. -They assume sane - but unsafe - defaults. An explanation of the respective parameters can be found [here](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-dataplane/edc-dataplane-hashicorp-vault/README.md). - -:::danger - -The following configuration is for testing purposes only. Do not use it in production. -::: - -### Example configuration.properties - -```shell -# Create configuration.properties -export CONFIGURATION_PROPERTIES_FILE=$(mktemp /tmp/configuration.properties.XXXXXX) -cat << 'EOF' > ${CONFIGURATION_PROPERTIES_FILE} - -web.http.default.port=8080 -web.http.default.path=/api -web.http.public.port=8185 -web.http.public.path=/public -web.http.control.port=9999 -web.http.control.path=/api/dataplane/control - -# Validation endpoint of controlplane -edc.dataplane.token.validation.endpoint=http://controlplane:9999/api/controlplane/control/token - -# EDC hostname -edc.hostname=localhost - -# HashiCorp vault related configuration -edc.vault.hashicorp.url=http://vault -edc.vault.hashicorp.token=55555555-6666-7777-8888-999999999999 -edc.vault.hashicorp.timeout.seconds=30 -EOF -``` - -### Example logging.properties - -```shell -# Create logging.properties -export LOGGING_PROPERTIES_FILE=$(mktemp /tmp/logging.properties.XXXXXX) -cat << 'EOF' > ${LOGGING_PROPERTIES_FILE} -.level=INFO -org.eclipse.edc.level=ALL -handlers=java.util.logging.ConsoleHandler -java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter -java.util.logging.ConsoleHandler.level=ALL -java.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n -EOF -``` - -### Example opentelemetry.properties - -```shell -# Create opentelemetry.properties -export OPENTELEMETRY_PROPERTIES_FILE=$(mktemp /tmp/opentelemetry.properties.XXXXXX) -cat << 'EOF' > ${OPENTELEMETRY_PROPERTIES_FILE} -otel.javaagent.enabled=true -otel.javaagent.debug=false -EOF -``` - -## Running - -Once the configuration is created, the container can be run directly via docker. - -```shell -docker run \ - -p 8080:8080 -p 8185:8185 -p 9999:9999 -p 9090:9090 \ - -v ${CONFIGURATION_PROPERTIES_FILE:-/dev/null}:/app/configuration.properties \ - -v ${LOGGING_PROPERTIES_FILE:-/dev/null}:/app/logging.properties \ - -v ${OPENTELEMETRY_PROPERTIES_FILE:-/dev/null}:/app/opentelemetry.properties \ - -i edc-dataplane-hashicorp-vault:latest -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page08_api.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page08_api.md deleted file mode 100644 index ae65fadea71..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page08_api.md +++ /dev/null @@ -1,64 +0,0 @@ -# EDC API Examples - -## API Spec - -The API spec of the EDC is constantly evolving. -The full API documentation for each release can be viewed on the openAPI section, e.g [api-observability](../development-view/openAPI/management-api/api-observability/check-health.api.mdx). -The following are some example API calls for common use cases. -They assume the default parameters from the previous local setup. - -## Create an Asset - -All objects in EDC are created by posting their JSON-serialized representation to the respective API input. -Since most EDC objects are rather openly defined, most of the properties provided depend on the need of the individual user. -Assets are no exception here. - -URL - -```http request -POST http://localhost:8080/api/v1/assets/ -``` - -Body - -```json -{ - "asset": { - "id": "asset1", - "properties": { - "exampleProperty": "exampleValue" - } - }, - "dataAddress": { - "properties": { - "baseUrl": "https://path.to/the_asset", - "type": "HttpData" - } - } -} -``` - -## Request an Asset Catalog - -To inspect the assets available to an EDC connector, we request its catalog. - -URL - -```http request -POST http://localhost:8080/api/v1/catalog/request -``` - -Body - -```json -{ - "providerUrl": "www.example.provider", - "querySpec": { - "filter": "AvailableWithPolicyXYZ", - "limit": 0, - "offset": 0, - "sortField": "id", - "sortOrder": "ASC" - } -} -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page09_upgrading.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page09_upgrading.md deleted file mode 100644 index e63a555269b..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/kit/operation-view/page09_upgrading.md +++ /dev/null @@ -1,20 +0,0 @@ -# Upgrading TractusX EDC - -Among the goals of TractusX EDC is making EDC upgrades as painless as possible. -The changes in each release are documented [here](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/docs/migration). -Usually there are only three steps to each upgrade. - -## Database Migration - -Database migration is simple to accomplish with a PostgreSQL backend. -The [PostgreSQL Migration Extension](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/edc-extensions/postgresql-migration) is the preferred approach. -Alternatively, the `.sql` files therein can be used to manually update the database schema. - -## Updating EDC - -The easy part of the upgrade process is to simply switch the outdated EDC containers with their newer counterparts. - -## Updating Settings - -Check the newest [Migration Documents](https://github.com/eclipse-tractusx/tractusx-edc/tree/develop/docs/migration) -for any changes to the settings structure and apply them to your settings. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.0.x_0.1.x.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.0.x_0.1.x.md deleted file mode 100644 index 07ea746d9b5..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.0.x_0.1.x.md +++ /dev/null @@ -1,304 +0,0 @@ -# Migration Version 0.0.x to 0.1.x - -This document contains a list of breaking changes that are introduced in version 0.1.x. - -## 0. Summary - -1. PostgreSQL Database - 1. Criteria in Policy & Contract Definitions Table - 2. Delete Contract Agreements -2. Data Management API - 1. Policy Path - 2. Policy Payload - 3. Criteria in Payload of Contract Definitions and Policies - 4. Data Address -3. Connector Configuration - 1. Token Validation Endpoint Setting - 2. DataPlane Selector - -## 1. PostgreSQL Database - -The Tractus-X EDC [PostgreSQL Migration Extension](../../edc-extensions/postgresql-migration/README.md) is able to run -normal migrations. But the extension will never cause a data loss automatically, therefore part of this migration must -be done by the user itself. - -### 1.1 Criteria in Policy & Contract Definitions Table - -Criteria in Policies and Contract Definitions are serialized as JSON and put into the database. The Criteria schema -changed and already existing database entries will cause _NullPointerExceptions_. - -#### Example Exception - -```plain -[2022-08-02 09:32:37] [SEVERE ] Could not handle multipart request: null -org.eclipse.dataspaceconnector.spi.EdcException - at org.eclipse.dataspaceconnector.transaction.local.LocalTransactionContext.execute(LocalTransactionContext.java:70) - at org.eclipse.dataspaceconnector.sql.assetindex.SqlAssetIndex.queryAssets(SqlAssetIndex.java:141) - at org.eclipse.dataspaceconnector.sql.assetindex.SqlAssetIndex.queryAssets(SqlAssetIndex.java:134) - at org.eclipse.dataspaceconnector.contract.offer.ContractOfferServiceImpl.lambda$queryContractOffers$2(ContractOfferServiceImpl.java:61) - at java.base/java.util.stream.ReferencePipeline$7$1.accept(ReferencePipeline.java:271) - at java.base/java.util.stream.ReferencePipeline$2$1.accept(ReferencePipeline.java:177) - at java.base/java.util.LinkedList$LLSpliterator.forEachRemaining(LinkedList.java:1239) - at java.base/java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:484) - at java.base/java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:474) - at java.base/java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:913) - at java.base/java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) - at java.base/java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:578) - at org.eclipse.dataspaceconnector.ids.core.service.CatalogServiceImpl.getDataCatalog(CatalogServiceImpl.java:55) - at org.eclipse.dataspaceconnector.ids.core.service.ConnectorServiceImpl.getConnector(ConnectorServiceImpl.java:51) - at org.eclipse.dataspaceconnector.ids.api.multipart.handler.description.ConnectorDescriptionRequestHandler.handle(ConnectorDescriptionRequestHandler.java:74) - at org.eclipse.dataspaceconnector.ids.api.multipart.handler.DescriptionHandler.handleRequestInternal(DescriptionHandler.java:117) - at org.eclipse.dataspaceconnector.ids.api.multipart.handler.DescriptionHandler.handleRequest(DescriptionHandler.java:82) - at org.eclipse.dataspaceconnector.ids.api.multipart.controller.MultipartController.request(MultipartController.java:146) - at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method) - at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) - at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) - at java.base/java.lang.reflect.Method.invoke(Method.java:566) - at org.glassfish.jersey.server.model.internal.ResourceMethodInvocationHandlerFactory.lambda$static$0(ResourceMethodInvocationHandlerFactory.java:52) - at org.glassfish.jersey.server.model.internal.AbstractJavaResourceMethodDispatcher$1.run(AbstractJavaResourceMethodDispatcher.java:124) - at org.glassfish.jersey.server.model.internal.AbstractJavaResourceMethodDispatcher.invoke(AbstractJavaResourceMethodDispatcher.java:167) - at org.glassfish.jersey.server.model.internal.JavaResourceMethodDispatcherProvider$ResponseOutInvoker.doDispatch(JavaResourceMethodDispatcherProvider.java:176) - at org.glassfish.jersey.server.model.internal.AbstractJavaResourceMethodDispatcher.dispatch(AbstractJavaResourceMethodDispatcher.java:79) - at org.glassfish.jersey.server.model.ResourceMethodInvoker.invoke(ResourceMethodInvoker.java:475) - at org.glassfish.jersey.server.model.ResourceMethodInvoker.apply(ResourceMethodInvoker.java:397) - at org.glassfish.jersey.server.model.ResourceMethodInvoker.apply(ResourceMethodInvoker.java:81) - at org.glassfish.jersey.server.ServerRuntime$1.run(ServerRuntime.java:255) - at org.glassfish.jersey.internal.Errors$1.call(Errors.java:248) - at org.glassfish.jersey.internal.Errors$1.call(Errors.java:244) - at org.glassfish.jersey.internal.Errors.process(Errors.java:292) - at org.glassfish.jersey.internal.Errors.process(Errors.java:274) - at org.glassfish.jersey.internal.Errors.process(Errors.java:244) - at org.glassfish.jersey.process.internal.RequestScope.runInScope(RequestScope.java:265) - at org.glassfish.jersey.server.ServerRuntime.process(ServerRuntime.java:234) - at org.glassfish.jersey.server.ApplicationHandler.handle(ApplicationHandler.java:684) - at org.glassfish.jersey.servlet.WebComponent.serviceImpl(WebComponent.java:394) - at org.glassfish.jersey.servlet.WebComponent.service(WebComponent.java:346) - at org.glassfish.jersey.servlet.ServletContainer.service(ServletContainer.java:358) - at org.glassfish.jersey.servlet.ServletContainer.service(ServletContainer.java:311) - at org.glassfish.jersey.servlet.ServletContainer.service(ServletContainer.java:205) - at org.eclipse.jetty.servlet.ServletHolder.handle(ServletHolder.java:764) - at org.eclipse.jetty.servlet.ServletHandler.doHandle(ServletHandler.java:508) - at org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:221) - at org.eclipse.jetty.server.handler.ContextHandler.doHandle(ContextHandler.java:1375) - at org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:176) - at org.eclipse.jetty.servlet.ServletHandler.doScope(ServletHandler.java:463) - at org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:174) - at org.eclipse.jetty.server.handler.ContextHandler.doScope(ContextHandler.java:1297) - at org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:129) - at org.eclipse.jetty.server.handler.ContextHandlerCollection.handle(ContextHandlerCollection.java:192) - at org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:122) - at org.eclipse.jetty.server.Server.handle(Server.java:562) - at org.eclipse.jetty.server.HttpChannel.lambda$handle$0(HttpChannel.java:505) - at org.eclipse.jetty.server.HttpChannel.dispatch(HttpChannel.java:762) - at org.eclipse.jetty.server.HttpChannel.handle(HttpChannel.java:497) - at org.eclipse.jetty.server.HttpConnection.onFillable(HttpConnection.java:282) - at org.eclipse.jetty.io.AbstractConnection$ReadCallback.succeeded(AbstractConnection.java:319) - at org.eclipse.jetty.io.FillInterest.fillable(FillInterest.java:100) - at org.eclipse.jetty.io.SelectableChannelEndPoint$1.run(SelectableChannelEndPoint.java:53) - at org.eclipse.jetty.util.thread.strategy.AdaptiveExecutionStrategy.runTask(AdaptiveExecutionStrategy.java:412) - at org.eclipse.jetty.util.thread.strategy.AdaptiveExecutionStrategy.consumeTask(AdaptiveExecutionStrategy.java:381) - at org.eclipse.jetty.util.thread.strategy.AdaptiveExecutionStrategy.tryProduce(AdaptiveExecutionStrategy.java:268) - at org.eclipse.jetty.util.thread.strategy.AdaptiveExecutionStrategy.produce(AdaptiveExecutionStrategy.java:190) - at org.eclipse.jetty.util.thread.QueuedThreadPool.runJob(QueuedThreadPool.java:894) - at org.eclipse.jetty.util.thread.QueuedThreadPool$Runner.run(QueuedThreadPool.java:1038) - at java.base/java.lang.Thread.run(Thread.java:829) -Caused by: java.lang.NullPointerException - at org.eclipse.dataspaceconnector.sql.translation.SqlConditionExpression.isValidExpression(SqlConditionExpression.java:53) - at java.base/java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:195) - at java.base/java.util.ArrayList$ArrayListSpliterator.forEachRemaining(ArrayList.java:1655) - at java.base/java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:484) - at java.base/java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:474) - at java.base/java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:913) - at java.base/java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) - at java.base/java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:578) - at org.eclipse.dataspaceconnector.sql.assetindex.schema.BaseSqlDialectStatements.createQuery(BaseSqlDialectStatements.java:108) - at org.eclipse.dataspaceconnector.sql.assetindex.SqlAssetIndex.lambda$queryAssets$2(SqlAssetIndex.java:144) - at org.eclipse.dataspaceconnector.transaction.local.LocalTransactionContext.execute(LocalTransactionContext.java:63) - ... 69 more -``` - -#### Solution 1: Update all Criteria manually - -Root of this issue is that the operator, left- and right-operand Criteria field names changed. - -| Old | New | -|:----------|:-------------| -| left | operandLeft | -| right | operandRight | -| op | operator | - -It is possible to resolve this issue by updating the content of the column, that contain JSON serialized constraints, -from - -```json -{"criteria":[{"left":"asset:prop:id","op":"=","right":"asset-1"}]} -``` - -to - -```json -{"criteria":[{"operandLeft":"asset:prop:id","operator":"=","operandRight":"asset-1"}]} -``` - -#### Solution 2: Delete all rows containing Constraints - -Instead of updating each row in the database it's also possible to delete all Contract Definitions and Policies. -Additionally it's necessary to delete all Negotiations, as they might reference existing Contract Definitions and/or -Policies. - -Theoretically it's also necessary to delete Contract Agreements. As their deletion is already described in another -section, we can skip them here. - -##### Required Queries - -```sql -DELETE -FROM edc_contract_negotiation; -``` - -```sql -DELETE -FROM edc_contract_definitions; -``` - -```sql -DELETE -FROM edc_policydefinitins; -``` - -### 1.2 Delete Contract Agreements - -In the new version contract agreement rows contain a serialized policy at the time, the contract was concluded. -With the EDC update all existing Contract Agreements must be deleted. - -#### Required Query - -```sql -DELETE -FROM edc_contract_agreement; -``` - -## 2. Data Management API - -It might be necessary to update applications and scripts that use the Data Management API. This section covers the most -important changes in endpoints and payloads. - -### 2.1 Policy Path - -The Data Management API Path for Policies changes from -`/policies` to `/policydefinitions`. - -#### Get All Policies - -```bash -curl -X GET "${DATA_MGMT_ENDPOINT}/data/policydefinitions" --header "X-Api-Key: " --header "Content-Type: application/json" -``` - -### 2.2 Policy Payload - -The Policy Payload now wraps the policy details in an additional policy object. - -#### New Payload - -```json -{ - "uid": "1", - "policy": { - "prohibitions": [], - "obligations": [], - "permissions": [] - } -} -``` - -#### Old Payload - -```json -{ - "uid": "1", - "prohibitions": [], - "obligations": [], - "permissions": [] -} -``` - -### 2.3 Criteria in Payload of Contract Definitions and Policies - -The payload of a Policy or a Contract Definition may contain one or more Criteria. The format of these serialized Criteria changed. -Please note that there is no input validation, that detects errors when the old Criteria format is used! - -#### Old Criterion Format - -```json -{ "left": "asset:prop:id", "op": "=", "right": "1" } -``` - -#### New Criterion Format - -```json -{ "operandLeft": "asset:prop:id", "operator": "=", "operandRight": "1" } -``` - -#### Example Call - -```bash -curl -X POST "${DATA_MGMT_ENDPOINT}/data/contractdefinitions" --header "X-Api-Key: " --header "Content-Type: application/json" --data "{ \"id\": \"1\", \"criteria\": [ { \"operandLeft\": \"asset:prop:id\", \"operator\": \"=\", \"operandRight\": \"1\" } ], \"accessPolicyId\": \"1\", \"contractPolicyId\": \"1\" }" -``` - -### 2.4 Data Address - -When using a Data Address of type `HttpData` please notice that the property `endpoint` changed to `baseUrl`. This -property is mostly used when creating assets. - -#### Old Asset format - -```json -{ - "asset": { - ... - }, - "dataAddress": { - "properties": { - "endpoint": "http://provider-backend-service:8080/data/asset-1", - "type": "HttpData" - } - } -} -``` - -#### New Asset format - -```json -{ - "asset": { - ... - }, - "dataAddress": { - "properties": { - "baseUrl": "http://provider-backend-service:8080/data/asset-1", - "type": "HttpData" - } - } -} -``` - -#### Example Call - -```bash -curl -X POST "$PLATO_DATAMGMT_URL/data/assets" --header "X-Api-Key: password" --header "Content-Type: application/json" --data "{ \"asset\": { \"properties\": { \"asset:prop:id\": \"1\", \"asset:prop:description\": \"Tractus-X EDC Demo Asset\" } }, \"dataAddress\": { \"properties\": { \"type\": \"HttpData\", \"baseUrl\": \"https://jsonplaceholder.typicode.com/todos/1\" } } }" -s -o /dev/null -w 'Response Code: %{http_code}\n' -``` - -## 3. Connector Configuration - -### 3.1 Token Validation Endpoint Setting - -In the past the token validation endpoint was configured in `edc.controlplane.validation-endpoint`. This setting key -must be renamed to `edc.dataplane.token.validation.endpoint`. - -### 3.2 DataPlane Selector - -With this version a new feature was introduced which allows to have separate DataPlane instances for different -transfer-flows (HttpProxy, S3, etc.). The Catena-X EDC team has additionally a new extension created which allows a -simpler registration of additional dataplanes. Therefor some changes needs to be applied. Further documentation can -be found in the extension folder: -[dataplane-selector-configuration](../../edc-extensions/dataplane-selector-configuration/README.md) diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.1.0_0.1.1.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.1.0_0.1.1.md deleted file mode 100644 index 528dc8c3724..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.1.0_0.1.1.md +++ /dev/null @@ -1,82 +0,0 @@ -# Migration Version 0.1.0 to 0.1.1 - -This document contains a list of breaking changes that are introduced in version 0.1.1. - ---- - -**Please Note**: -Due to a change in the DAPS authentication mechanism this version cannot exchange messages with older EDC versions! - ---- - -## 0. Summary - -1. Data Management API - 1. Policy Payload -2. Connector Configuration - 1. CX OAuth Extension - -## 1. Data Management API - -It might be necessary to update applications and scripts that use the Data Management API. This section covers the most -important changes in endpoints and payloads. - -### 1.1 Policy Payload - -The id field of the PolicyDefinition was renamed from `uid` to `id`. - -#### Old Call - -```json -{ - "uid": "1", - "policy": { - "prohibitions": [], - "obligations": [], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "USE" - }, - "constraints": [] - } - ] - } -} -``` - -#### New call - -```json -{ - "id": "1", - "policy": { - "prohibitions": [], - "obligations": [], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "USE" - }, - "constraints": [] - } - ] - } -} -``` - -## 2. Connector Configuration - -### 2.1. CX OAuth Extension - -All connectors are now shipped with a new OAuth extension. This extension has an additional mandatory setting called `edc.ids.endpoint.audience`, that must be set to the IDS path. - -[Documentation](../../edc-extensions/cx-oauth2/README.md) - -#### Example - -```properties -edc.ids.endpoint.audience=http://plato-edc-controlplane:8282/api/v1/ids/data -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.1.2_0.1.3.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.1.2_0.1.3.md deleted file mode 100644 index 787b04bfe5f..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.1.2_0.1.3.md +++ /dev/null @@ -1,23 +0,0 @@ -# Migration Version 0.1.2 to 0.1.3 - -This document contains a list of breaking changes that are introduced in version 0.1.3. - -## OAuth2 Extension - -As the images now use the official OAuth2 Extension, the audience settings need to the updated. - -Add the following settings: - -- EDC_OAUTH_PROVIDER_AUDIENCE -- EDC_OAUTH_ENDPOINT_AUDIENCE - -Remove the following setting: - -- EDC_IDS_ENDPOINT_AUDIENCE - -Example: - -```yaml -EDC_OAUTH_PROVIDER_AUDIENCE: idsc:IDS_CONNECTORS_ALL -EDC_OAUTH_ENDPOINT_AUDIENCE: http://plato-edc-controlplane:8282/api/v1/ids/data -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.1.x_0.3.x.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.1.x_0.3.x.md deleted file mode 100644 index f35d3aa5e26..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.1.x_0.3.x.md +++ /dev/null @@ -1,35 +0,0 @@ -# Migration from 0.1.x to 0.3.x - -## Deprecation - -- the `edc-controlplane` and `edc-dataplane` charts are deprecated, please use `tractusx-connector` which combines the former ones - -## Management API changes - -Details at the [official documentation on swaggerhub](https://app.swaggerhub.com/apis/eclipse-edc-bot/management-api/0.0.1-SNAPSHOT) - -- Management API for creating resources (assets, policydefinitions, contractdefinitions, ...) will return a body containing the id of the created resource -- Added a `POST /request` for every management endpoint (assets, policydefinitions, ...) to query all the resources. The existent `GET /` have been deprecated -- added `id` field in `DataRequestDTO` (`/transferprocess` management api), if not set it will use a randomly generated one. -- Removed field `assetId` from `ContractOffer`. It was always null though, so there should be nothing to do about it. -- on `POST /contractdefinitions` a `duration` field can be added to control the duration of the contract. -- added the `GET /assets/{id}/address` endpoint to being able to retrieve the stored `DataAddress` - -## Settings changes - -- refactored the HTTP server contexts (more details on the [related decision record](https://eclipse-edc.github.io/docs/#/submodule/Connector/docs/developer/decision-records/2022-11-09-api-refactoring/renaming)). They need to be refactored as: - - `web.http.data` becomes `web.http.management` - - `web.http.ids` becomes `web.http.protocol` - - `web.http.validation`, `web.http.controlplane` and `web.http.dataplane` become `web.http.control` -- Healthcheck api now it's exposed under the `management` context. -- Removed default value for setting `edc.transfer.proxy.token.verifier.publickey.alias` so it must be valued accordingly -- made the state machine settings configurable so it will be possible to tune them accordingly. More details in the [related documentation entry](https://eclipse-edc.github.io/docs/#/submodule/Connector/docs/developer/performance-tuning). -- renamed `edc.receiver.http.endpoint` to `edc.receiver.http.dynamic.endpoint` -- renamed `edc.oauth.public.key.alias` setting to `edc.oauth.certificate.alias` - -## Other changes - -- Supported `/public` data plane endpoint without trailing slash, that can be eventually removed from the configuration -- packages name changed from `org.eclipse.dataspaceconnector` to `org.eclipse.edc` -- To specify multiple BPN into Policies the operator `OR` can be used. More details in the [business-partner-validation extension documentation](../../edc-extensions/business-partner-validation) -- HTTP Dynamic Endpoint Data Reference: The URL for Endpoint Data Reference can be also provided via the call for starting the transfer process. More details [Http Dynamic EDR receiver](https://github.com/eclipse-edc/Connector/tree/main/extensions/control-plane/transfer/transfer-pull-http-dynamic-receiver) diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.3.0_0.3.1.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.3.0_0.3.1.md deleted file mode 100644 index fab476bd089..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.3.0_0.3.1.md +++ /dev/null @@ -1,15 +0,0 @@ -# Migration from 0.3.0 to 0.3.1 - -## Observability API changes - -All endpoints (`/health`, `/startup`, `/liveness`, `/readiness`) of the Observability API now support unauthenticated access, if configured. That will put the -Observability API under a new context named `"observability"`, which consequently requires proper web context -configuration for it. Note that the name of the context cannot be changed. - -## Settings changes - -- `tractusx.api.observability.allow-insecure`: boolean value that enables (`true`) the unauthenticated access. -- `web.http.observability.port`: integer value that specifies the port of the `observability` context. **Mandatory if - unauthenticated access is enabled!** -- `web.http.observability.path`: string value that specifies the path of the `observability` context. **Mandatory if - unauthenticated access is enabled!** diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.3.1_0.3.2.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.3.1_0.3.2.md deleted file mode 100644 index 4099e8c4b67..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/migration/Version_0.3.1_0.3.2.md +++ /dev/null @@ -1,9 +0,0 @@ -# Migration from 0.3.0 to 0.3.1 - -## Configuration of Azure KeyVault - -When using Helm Charts that use the Azure KeyVault (`edc-runtime-memory`, `edc-controlplane-postgres`) -it is now possible to select _either_ authentication via Client Secret (`azure.vault.secret`) or via -certificate (`azure.vault.certificate`). - -If neither of the two is configured, the runtime will fail to start issuing an error. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/Local TXDC Setup.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/Local TXDC Setup.md deleted file mode 100644 index 0a00ae0a880..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/Local TXDC Setup.md +++ /dev/null @@ -1,124 +0,0 @@ -# Local TXDC Setup - -This document describes how to set up two TXDConnector instances locally. The Supporting Infrastructure Deployment, used -by this example, must never be used productively. The deployment of the two TXDConnector instances, done by this example, -is not suitable for productive deployment scenarios. - -## Prerequisites - -[![Helm][helm-shield]][helm-url] - -[![Kubernetes][kubernets-shield]][kubernets-url] - -## Local Deployment - -The Local TXDC Setup consists of three separate deployments. The Supporting Infrastructure, that is required to -run connectors, and two different TXDC Connector instances, that can communicate with each other. - -- [TXDC Supporting Infrastructure](../../edc-tests/deployment/test-infrastructure/README.md) -- [TXDC Connector](../../charts/tractusx-connector/README.md) Plato -- [TXDC Connector](../../charts/tractusx-connector/README.md) Sokrates - -[helm-shield]: https://img.shields.io/badge/Helm-URL-lightgrey - -[helm-url]: https://helm.sh - -[kubernets-shield]: https://img.shields.io/badge/Kubernetes-URL-lightgrey - -[kubernets-url]: https://kubernetes.io/ - -### Supporting Infrastructure - -Before the connectors can be setup, the Supporting Infrastructure must be in place. It comes with pre-configured everything -to run two connectors independently. - -For this local test scenario, -the [Supporting Infrastructure](../../edc-tests/deployment/test-infrastructure/README.md) -of the TXDC Business Tests can be used. - -Install the TXDC Supporting Infrastructure by running the following command from the project root directory. The Minio -set can be skipped, as it's only used by AWS S3 Transfer Business Tests. Also, the PostgreSQL Database is not really -mandatory to try out the EDC. So it can be disabled as well. - -```sh -helm dependency update edc-tests/cucumber/src/main/resources/deployment/helm/supporting-infrastructure -``` - -```sh -helm install infrastructure edc-tests/cucumber/src/main/resources/deployment/helm/supporting-infrastructure \ - --namespace cx \ - --create-namespace \ - --set install.minio=false \ - --set install.postgresql=false -``` - -### Plato Connector - -After the supporting infrastructure is deployed the Plato Connector can be added. The Supporting Infrastructure -Deployment has a DAPS Client and Vault Secrets configured accordingly. So that the TXDConnector can use them directly. - -Install Plato by running the following command from the project root directory. - -```sh -helm install plato charts/tractusx-connector \ - --namespace cx \ - --create-namespace \ - --set fullnameOverride=plato \ - --set controlplane.image.tag=latest \ - --set controlplane.service.type=NodePort \ - --set controlplane.endpoints.management.authKey=password \ - --set vault.hashicorp.enabled=true \ - --set vault.hashicorp.url=http://vault:8200 \ - --set vault.hashicorp.token=root \ - --set vault.secretNames.transferProxyTokenSignerPublicKey=plato/daps/my-plato-daps-crt \ - --set vault.secretNames.transferProxyTokenSignerPrivateKey=plato/daps/my-plato-daps-key \ - --set vault.secretNames.transferProxyTokenEncryptionAesKey=plato/data-encryption-aes-keys \ - --set vault.secretNames.dapsPrivateKey=plato/daps/my-plato-daps-key \ - --set vault.secretNames.dapsPublicKey=plato/daps/my-plato-daps-crt \ - --set daps.url=http://ids-daps:4567 \ - --set daps.clientId=99:83:A7:17:86:FF:98:93:CE:A0:DD:A1:F1:36:FA:F6:0F:75:0A:23:keyid:99:83:A7:17:86:FF:98:93:CE:A0:DD:A1:F1:36:FA:F6:0F:75:0A:23 \ - --set backendService.httpProxyTokenReceiverUrl=http://backend:8080 -``` - -The different settings are explained in the [TXDC Connector](../../charts/tractusx-connector/README.md) documentation. -Basically this deployment overrides the full name, to avoid naming conflicts, and sets a NodePort, to access the -containers from outside the local Kubernetes cluster. Then it configures a DAPS instance and the corresponding vault, -where the DAPS secrets are persisted, so that the connector has its own identity. - -### Sokrates Connector - -After Plato is set up the same can be done for Sokrates. The main difference will be, that Sokrates uses another DAPS -Client ID with different public-/private keys. - -Install Sokrates by running the following command from the project root directory. - -```shell -helm install sokrates charts/tractusx-connector \ - --namespace cx \ - --create-namespace \ - --set fullnameOverride=sokrates \ - --set controlplane.image.tag=latest \ - --set controlplane.service.type=NodePort \ - --set controlplane.endpoints.management.authKey=password \ - --set vault.hashicorp.enabled=true \ - --set vault.hashicorp.url=http://vault:8200 \ - --set vault.hashicorp.token=root \ - --set vault.secretNames.transferProxyTokenSignerPublicKey=sokrates/daps/my-sokrates-daps-crt \ - --set vault.secretNames.transferProxyTokenSignerPrivateKey=sokrates/daps/my-sokrates-daps-key \ - --set vault.secretNames.transferProxyTokenEncryptionAesKey=sokrates/data-encryption-aes-keys \ - --set vault.secretNames.dapsPrivateKey=sokrates/daps/my-sokrates-daps-key \ - --set vault.secretNames.dapsPublicKey=sokrates/daps/my-sokrates-daps-crt \ - --set daps.url=http://ids-daps:4567 \ - --set daps.clientId=E7:07:2D:74:56:66:31:F0:7B:10:EA:B6:03:06:4C:23:7F:ED:A6:65:keyid:E7:07:2D:74:56:66:31:F0:7B:10:EA:B6:03:06:4C:23:7F:ED:A6:65 \ - --set backendService.httpProxyTokenReceiverUrl=http://backend:8080 -``` - -## Uninstall - -```shell -helm uninstall --namespace cx infrastructure -helm uninstall --namespace cx plato -helm uninstall --namespace cx sokrates -``` - -> To try out the local setup, have a look at the [Transfer Example Documentation](./Transfer%20Data.md) diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/README.md deleted file mode 100644 index fcd5fe8bd74..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Samples - -In this folder are listed some documents that will help you setting up a connector execute some use cases. - -- [Local setup](./Local%20TXDC%20Setup.md) -- [Transfer data](./Transfer%20Data.md) -- [Data Plane HTTP OAuth2](./data-plane-http-oauth2.md) diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/Transfer Data.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/Transfer Data.md deleted file mode 100644 index e50e5079652..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/Transfer Data.md +++ /dev/null @@ -1,365 +0,0 @@ -# Transfer Data - -This document will showcase a data transfer between two connectors. - -For this transfer connector **Bob** will act as data provider, and connector **Alice** will act as data -consumer. But the roles could be inverse as well. - -> Please note: Before running the examples the corresponding environment variables must be set. -> How such an environment can be setup locally is documented in [chapter 1](#1-optional---local-setup). - -## Table of Content - -1. [Optional - Local Setup](#1-optional---local-setup) -2. [Setup Data Offer](#2-setup-data-offer) -3. [Request Contract Offers](#3-request-contract-offer-catalog) -4. [Negotiate Contract](#4-negotiate-contract) -5. [Transfer Data](#5-transfer-data) -6. [Verify Data Transfer](#6-verify-data-transfer) - -## 1. Optional - Local Setup - -To create a local setup with two connectors have a look at -the [Local TXDC Setup Documentation](./Local%20TXDC%20Setup.md). -It creates two connectors (Plato & Sokrates) with exposed Node Ports. - -### See Node Ports using Minikube - -Run the following command. - -```shell -minkube service list -``` - -Minikube will then print out something like this: - -```plain -|-------------|-----------------------|-----------------|---------------------------| -| NAMESPACE | NAME | TARGET PORT | URL | -|-------------|-----------------------|-----------------|---------------------------| -| cx | backend | frontend/8080 | http://192.168.49.2:31918 | -| | | backend/8081 | http://192.168.49.2:30193 | < Transfer Backend API -| cx | ids-daps | No node port | -| cx | plato-controlplane | default/8080 | http://192.168.49.2:31016 | -| | | control/8083 | http://192.168.49.2:32510 | -| | | data/8081 | http://192.168.49.2:30423 | < Plato Data Management API -| | | validation/8082 | http://192.168.49.2:30997 | -| | | ids/8084 | http://192.168.49.2:32709 | < Plato IDS API -| | | metrics/8085 | http://192.168.49.2:31124 | -| cx | plato-dataplane | No node port | -| cx | sokrates-controlplane | default/8080 | http://192.168.49.2:32297 | -| | | control/8083 | http://192.168.49.2:32671 | -| | | data/8081 | http://192.168.49.2:31772 | < Sokrates Data Management API -| | | validation/8082 | http://192.168.49.2:30540 | -| | | ids/8084 | http://192.168.49.2:32543 | < Sokrates IDS API -| | | metrics/8085 | http://192.168.49.2:30247 | -| cx | sokrates-dataplane | No node port | -| cx | vault | No node port | -| cx | vault-internal | No node port | -| cx | vault-ui | No node port | -| default | kubernetes | No node port | -| kube-system | kube-dns | No node port | -|-------------|-----------------------|-----------------|---------------------------| -``` - -The most important APIs, used by this example, are highlighted. How they are used is described in subchapter ['Set -Environment Variables](#set-environment-variables-used-by-this-example), used by this example below. - -### See Node Ports using Kubernetes - -Using Kubernetes only the Node Ports of each Service must be checked separately. - -Run - -```shell -kubectl describe service -n cx plato-controlplane -``` - -or - -```shell -kubectl describe service -n cx sokrates-controlplane -``` - -Kubernetes will then print out something like this. - -```plain -Name: plato-controlplane -Namespace: cx -Labels: app.kubernetes.io/component=edc-controlplane - app.kubernetes.io/instance=plato-controlplane - app.kubernetes.io/managed-by=Helm - app.kubernetes.io/name=tractusx-connector-controlplane - app.kubernetes.io/part-of=edc - app.kubernetes.io/version=0.2.0 - helm.sh/chart=tractusx-connector-0.2.0 -Annotations: meta.helm.sh/release-name: plato - meta.helm.sh/release-namespace: cx -Selector: app.kubernetes.io/instance=plato-controlplane,app.kubernetes.io/name=tractusx-connector-controlplane -Type: NodePort -IP Family Policy: SingleStack -IP Families: IPv4 -IP: 10.110.180.57 -IPs: 10.110.180.57 -Port: default 8080/TCP -TargetPort: default/TCP -NodePort: default 31016/TCP -Endpoints: 172.17.0.6:8080 -Port: control 8083/TCP -TargetPort: control/TCP -NodePort: control 32510/TCP -Endpoints: 172.17.0.6:8083 -Port: data 8081/TCP -TargetPort: data/TCP -NodePort: data 30423/TCP < Plato Data Manamgent API -Endpoints: 172.17.0.6:8081 -Port: validation 8082/TCP -TargetPort: validation/TCP -NodePort: validation 30997/TCP -Endpoints: 172.17.0.6:8082 -Port: ids 8084/TCP -TargetPort: ids/TCP -NodePort: ids 32709/TCP < Plato IDS API -Endpoints: 172.17.0.6:8084 -Port: metrics 8085/TCP -TargetPort: metrics/TCP -NodePort: metrics 31124/TCP -Endpoints: 172.17.0.6:8085 -Session Affinity: None -External Traffic Policy: Cluster -Events: -``` - -The most important APIs, used by this example, are highlighted. How they are used is described in subchapter ['Set -Environment Variables](#set-environment-variables-used-by-this-example), used by this example below. -In comparison to the Minikube example this call shows only the ports. To call the ports the Kubernetes Node IP / URL is -required. Where to get the IP may vary depending on how Kubernetes is deployed. - -### Set Environment Variables, used by this example - -Environment Variables, containing a URL, used by this example are - -- BOB_DATAMGMT_URL -- ALICE_DATAMGMT_URL -- BOB_IDS_URL -- ALICE_BACKEND_URL - -Let's assume we will use Sokrates as Bob, and Plato as Alice. - -**BOB_DATAMGMT_URL** must be the Node URL. In this local setup it would be `http://192.168.49.2:31772` - -**ALICE_DATAMGMT_URL** must be the Node URL. In this local setup it would be `http://192.168.49.2:30423` - -**BOB_IDS_URL** must be internal Kubernetes URL. In this local setup `http://sokrates-controlplane:8084` - -**ALICE_BACKEND_URL** must the Node URL. In this local setup it would be `http://192.168.49.2:30193` - -## 2. Setup Data Offer - -Set up a data offer in **Bob**, so that **Alice** has something to consume. - -In case you are unfamiliar with the EDC terms `Asset`, `Policy` or `ContractDefinition` please have a look at the -official open source documentation ([link](https://github.com/eclipse-edc/Connector/blob/main/docs/developer/architecture/domain-model.md)). - -![Sequence 1](diagrams/transfer_sequence_1.png) - -The following commands will create an Asset, a Policy and a Contract Definition. -For simplicity `https://jsonplaceholder.typicode.com/todos/1` is used as data source of the asset, but could be any -other API, that is reachable from the Provider Data Plane. - -```bash -curl -X POST "${BOB_DATAMGMT_URL}/data/assets" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - --data '{ - "asset": { - "properties": { - "asset:prop:id": "1", - "asset:prop:description": "Tractus-X EDC Demo Asset" - } - }, - "dataAddress": { - "properties": { - "type": "HttpData", - "baseUrl": "https://jsonplaceholder.typicode.com/todos/1" - } - } - }' \ - -s -o /dev/null -w 'Response Code: %{http_code}\n' -``` - -```bash -curl -X POST "${BOB_DATAMGMT_URL}/data/policydefinitions" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - --data '{ - "id": "1", - "policy": { - "prohibitions": [], - "obligations": [], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { "type": "USE" }, - "constraints": [] - } - ] - } - }' \ - -s -o /dev/null -w 'Response Code: %{http_code}\n' -``` - -```bash -curl -X POST "${BOB_DATAMGMT_URL}/data/contractdefinitions" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - --data '{ - "id": "1", - "criteria": [ - { - "operandLeft": "asset:prop:id", - "operator": "=", - "operandRight": "1" - } - ], - "accessPolicyId": "1", - "contractPolicyId": "1" - }' \ - -s -o /dev/null -w 'Response Code: %{http_code}\n' -``` - -## 3. Request Contract Offer Catalog - -In this step Alice gets told to request contract offers from another connector (in this case Bob). Alice will -then request the catalog over IDS messaging. - -For IDS messaging connectors will identify each other using the configured IDS DAPS. Therefore, it is important that -connectors, that intent to send messages to each other, have the same DAPS instance configured. - -![Sequence 1](diagrams/transfer_sequence_2.png) - -Run: - -```bash -curl -G -X GET "${ALICE_DATAMGMT_URL}/data/catalog" \ - --data-urlencode "providerUrl=${BOB_IDS_URL}/api/v1/ids/data" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - -s | jq -``` - -## 4. Negotiate Contract - -Initiate a contract negotiation for the asset (from step 1). Part of the negotiation payload is the contract -offer (received in step 2). - -In the diagram the IDS contract negotiation is marked as simplified, because the EDC is exchanging multiple messages -during contract negotiation. But the inter-controlplane communication is not in the scope of this document. - -After the negotiation is initiated ensure that is has concluded. This is done by requesting the negotiation from the API -and checking whether the `contractAgreementId` is set. This might take a few seconds. - -![Sequence 1](diagrams/transfer_sequence_3.png) - -Run: - -```bash -export NEGOTIATION_ID=$( \ - curl -X POST "${ALICE_DATAMGMT_URL}/data/contractnegotiations" \ - --header "X-Api-Key: password" \ - --header "Content-Type: application/json" \ - --data "{ - \"connectorId\": \"foo\", - \"connectorAddress\": \"${BOB_IDS_URL}/api/v1/ids/data\", - \"offer\": { - \"offerId\": \"1:foo\", - \"assetId\": \"1\", - \"policy\": { - \"uid\": \"1\", - \"prohibitions\": [], - \"obligations\": [], - \"permissions\": [ - { - \"edctype\": \"dataspaceconnector:permission\", - \"action\": { \"type\": \"USE\" }, - \"target\": \"1\", - \"constraints\": [] - } - ] - } - } - }" \ - -s | jq -r '.id') -``` - -```bash -curl -X GET "${ALICE_DATAMGMT_URL}/data/contractnegotiations/${NEGOTIATION_ID}" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - -s | jq -``` - -## 5. Transfer Data - -Initiate a data transfer using the contract agreement from the negotiation (from step 3). Then wait until the state of -the transfer process is `COMPLETED`. - -![Sequence 1](diagrams/transfer_sequence_4.png) - -Run: - -```bash -export CONTRACT_AGREEMENT_ID=$( \ - curl -X GET "$ALICE_DATAMGMT_URL/data/contractnegotiations/$NEGOTIATION_ID" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - -s | jq -r '.contractAgreementId') -``` - -```bash -export TRANSFER_PROCESS_ID=$(tr -dc '[:alnum:]' < /dev/urandom | head -c20) -export TRANSFER_ID=$( \ - curl -X POST "${ALICE_DATAMGMT_URL}/data/transferprocess" \ - --header "X-Api-Key: password" \ - --header "Content-Type: application/json" \ - --data "{ - \"id\": \"${TRANSFER_PROCESS_ID}\", - \"connectorId\": \"foo\", - \"connectorAddress\": \"${BOB_IDS_URL}/api/v1/ids/data\", - \"contractId\": \"${CONTRACT_AGREEMENT_ID}\", - \"assetId\": \"1\", - \"managedResources\": \"false\", - \"dataDestination\": { \"type\": \"HttpProxy\" } - }" \ - -s | jq -r '.id') -``` - -```bash -curl -X GET "${ALICE_DATAMGMT_URL}/data/transferprocess/${TRANSFER_ID}" \ - --header 'X-Api-Key: password' \ - --header 'Content-Type: application/json' \ - -s | jq -``` - -## 6. Verify Data Transfer - -After the transfer is complete the Backend Application has downloaded the data. The Backend Application stores the data -locally. In this demo the transfer can be verified by executing a simple `cat` call in the Pod. - -![Sequence 1](diagrams/transfer_sequence_5.png) - -```bash -curl -X GET "${ALICE_BACKEND_URL}/${TRANSFER_PROCESS_ID}" \ - --header 'Accept: application/octet-stream' \ - -s | jq -``` - -## Delete All Data - -```bash -minikube kubectl -- delete pvc -n edc-all-in-one --all -``` - -```bash -minikube kubectl -- delete pv -n edc-all-in-one --all -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/data-plane-http-oauth2.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/data-plane-http-oauth2.md deleted file mode 100644 index 63b99319fbc..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/data-plane-http-oauth2.md +++ /dev/null @@ -1,7 +0,0 @@ -# Data Plane HTTP OAuth2 - -The Data Plane HTTP OAuth2 extension permits the data-plane to fetch the data requested from a consumer from an HTTP server -with an OAuth2 authentication layer. - -For further documentation, please refer to the extension README: - diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_1.png b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_1.png deleted file mode 100644 index 22500abc3cf..00000000000 Binary files a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_1.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_1.puml b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_1.puml deleted file mode 100644 index b49733a0197..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_1.puml +++ /dev/null @@ -1,34 +0,0 @@ -@startuml - -!define aliceColor 66CCFF -!define bobColor CCFF99 -!define dapsColor FFFF99 -!define noteColor 9999FF - -actor User as "User" - -box Alice - participant AliceControlPlane as "Control Plane" #aliceColor - participant AliceBackendService as "Backend Application" #aliceColor - participant AliceDataPlane as "Data Plane" #aliceColor -end box - -box Bob - participant BobControlPlane as "Control Plane" #bobColor - participant BobDataPlane as "Data Plane" #bobColor -end box - -participant JsonPlaceHolder as "JsonPlaceHolder" - - -User -> BobControlPlane ++ : Create Asset -return 204 - -User -> BobControlPlane ++ : Create Policy -return 204 - -User -> BobControlPlane ++ : Create Contract Definition -return 204 - - -@enduml diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_2.png b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_2.png deleted file mode 100644 index 95b6eeced3a..00000000000 Binary files a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_2.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_2.puml b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_2.puml deleted file mode 100644 index 2d078607d02..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_2.puml +++ /dev/null @@ -1,28 +0,0 @@ -@startuml - -!define aliceColor 66CCFF -!define bobColor CCFF99 -!define dapsColor FFFF99 -!define noteColor 9999FF - -actor User as "User" - -box Alice - participant AliceControlPlane as "Control Plane" #aliceColor - participant AliceBackendService as "Backend Application" #aliceColor - participant AliceDataPlane as "Data Plane" #aliceColor -end box - -box Bob - participant BobControlPlane as "Control Plane" #bobColor - participant BobDataPlane as "Data Plane" #bobColor -end box - -participant JsonPlaceHolder as "JsonPlaceHolder" - -User -> AliceControlPlane ++ : Request Contract Offers from Bob - AliceControlPlane -> BobControlPlane ++ : IDS Description Request Message - return Description -return Contract Offers - -@enduml diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_3.png b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_3.png deleted file mode 100644 index 14a30c9a915..00000000000 Binary files a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_3.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_3.puml b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_3.puml deleted file mode 100644 index 7bec9eadb87..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_3.puml +++ /dev/null @@ -1,33 +0,0 @@ -@startuml - -!define aliceColor 66CCFF -!define bobColor CCFF99 -!define dapsColor FFFF99 -!define noteColor 9999FF - -actor User as "User" - -box Alice - participant AliceControlPlane as "Control Plane" #aliceColor - participant AliceBackendService as "Backend Application" #aliceColor - participant AliceDataPlane as "Data Plane" #aliceColor -end box - -box Bob - participant BobControlPlane as "Control Plane" #bobColor - participant BobDataPlane as "Data Plane" #bobColor -end box - -participant JsonPlaceHolder as "JsonPlaceHolder" - - -User -> AliceControlPlane ++ : Negotiate Contract for Offer X -AliceControlPlane --> User: Negotiation ID - AliceControlPlane -> BobControlPlane ++ : IDS Contract Negotiation (simplified) - return Contract Agreement -deactivate AliceControlPlane - -User -> AliceControlPlane ++ : Request Negotiation by ID -return Contract Negotiation - -@enduml diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_4.png b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_4.png deleted file mode 100644 index e3630e70aff..00000000000 Binary files a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_4.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_4.puml b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_4.puml deleted file mode 100644 index 6d4e936ed78..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_4.puml +++ /dev/null @@ -1,44 +0,0 @@ -@startuml - -!define aliceColor 66CCFF -!define bobColor CCFF99 -!define dapsColor FFFF99 -!define noteColor 9999FF - -actor User as "User" - -box Alice - participant AliceControlPlane as "Control Plane" #aliceColor - participant AliceBackendService as "Backend Application" #aliceColor - participant AliceDataPlane as "Data Plane" #aliceColor -end box - -box Bob - participant BobControlPlane as "Control Plane" #bobColor - participant BobDataPlane as "Data Plane" #bobColor -end box - -participant JsonPlaceHolder as "JsonPlaceHolder" - -User -> AliceControlPlane ++ : Request Negotiation by ID -return Contract Negotiation\n(containing Contract Agreement ID) - -User -> AliceControlPlane ++ : Initiate Transfer with Agreement ID -AliceControlPlane --> User : Transfer Process ID - AliceControlPlane -> BobControlPlane ++ : IDS Data Transfer (simplified) -return -AliceControlPlane -> AliceBackendService ++ : Data Plane Endpoint + Token - AliceBackendService -> AliceDataPlane ++ : Request Data with Token - AliceDataPlane -> BobDataPlane ++ : Request Data - BobDataPlane -> JsonPlaceHolder ++ : Request Data - return data - return data - return data - AliceBackendService -> AliceBackendService : Write Data to File -return ok -deactivate AliceControlPlane - -User -> AliceControlPlane ++ : Request Transfer Process by ID -return Transfer Process - -@enduml diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_5.png b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_5.png deleted file mode 100644 index 1a18b5be2d9..00000000000 Binary files a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_5.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_5.puml b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_5.puml deleted file mode 100644 index 598b747b6fa..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/docs/samples/diagrams/transfer_sequence_5.puml +++ /dev/null @@ -1,27 +0,0 @@ -@startuml - -!define aliceColor 66CCFF -!define bobColor CCFF99 -!define dapsColor FFFF99 -!define noteColor 9999FF - -actor User as "User" - -box Alice - participant AliceControlPlane as "Control Plane" #aliceColor - participant AliceBackendService as "Backend Application" #aliceColor - participant AliceDataPlane as "Data Plane" #aliceColor -end box - -box Bob - participant BobControlPlane as "Control Plane" #bobColor - participant BobDataPlane as "Data Plane" #bobColor -end box - -participant JsonPlaceHolder as "JsonPlaceHolder" - -User -> AliceBackendService ++ : Get File Content -return data - - -@enduml diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/README.md deleted file mode 100644 index 3f59218d5d2..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/README.md +++ /dev/null @@ -1,53 +0,0 @@ -# Control Plane - -The Eclipse Dataspace Connector consists of a **Control Plan** and a **Data Plane** Application. -While the **Data Plane** handles the actual Data Transfer, the **Control Plane** is responsible for: - -- Resource Management (e.g. Assets, Policies & Contract Definitions CRUD) -- Contract Offering & Contract Negotiation -- Data Transfer Coordination / Management - -The only API that is protected by some kind of security mechanism is the Data Management API. At the time of writing this is done by a simple API key. -The key value must be configured in `edc.api.auth.key`. All requests to the Data Management API must have `X-Api-Key` header with the key value. - -Example: - -```bash -curl -X GET --header "X-Api-Key: " -``` - -## Security - -### Confidential Settings - -Please be aware that there are several confidential settings, that should not be part of the actual EDC configuration file. - -Some of these confidential settings are - -- Vault credentials -- Data Management API key -- Database credentials - -As it is possible to configure EDC settings via environment variables, one way to do it would be via Kubernetes Secrets. For other deployment scenarios than Kubernetes equivalent measures should be taken. - -## Known Control Plane Issues - -Please have a look at the open issues in the open source repository. The list below might not be maintained well and -only contains the most important issues. -EDC GitHub Repository - ---- - -**Please note** that some of these issues might already be fixed on the EDC main branch, but are not part of the specific -EDC commit the Tractus-X-EDC uses. - ---- - -### Persistence - -- ContractDefinition-AssetSelector of InMemory Connector selects 50 Asset max.([issue](https://github.com/eclipse-edc/Connector/issues/1779)) - -### Other - -- Non-IDS-Transformable-ContractDefinition causes connector to be unable to send out self-descriptions/catalogs([issue](https://github.com/eclipse-edc/Connector/issues/1265)) - - **Workaround:** Delete non-transformable ContractDefinition or Policy. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-base/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-base/README.md deleted file mode 100644 index 269de27ca36..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-base/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# EDC Control-Plane Base Module - -## Building - -```shell -./gradlew edc-controlplane:edc-controlplane-base:build -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-memory-hashicorp-vault/notice.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-memory-hashicorp-vault/notice.md deleted file mode 100644 index 1bee54f025b..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-memory-hashicorp-vault/notice.md +++ /dev/null @@ -1,28 +0,0 @@ -# Notice for Docker image - -An EDC Control Plane using memory-based storage, and HashiCorp Vault as secret store. - -DockerHub: - -Eclipse Tractus-X product(s) installed within the image: - -## TractusX-EDC Control Plane - -- GitHub: -- Project home: -- Dockerfile: -- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE) - -## Used base image - -- [eclipse-temurin:17.0.6_10-jre-alpine](https://github.com/adoptium/containers) -- Official Eclipse Temurin DockerHub page: -- Eclipse Temurin Project: -- Additional information about the Eclipse Temurin - images: - -As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc -from the base distribution, along with any direct or indirect dependencies of the primary software being contained). - -As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies -with any relevant licenses for all software contained within. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/README.md deleted file mode 100644 index 6bf4fac0c0e..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/README.md +++ /dev/null @@ -1,183 +0,0 @@ -# EDC Control-Plane backed by Postgresql and HashiCorp vault - -## Used Components - -- [Postgresql](https://www.postgresql.org/) -- [HashiCorp vault](https://www.vaultproject.io/docs) - -## Building - -```shell -./gardlew :edc-controlplane:edc-controlplane-postgresql-hashicorp-vault:dockerize -``` - -## Configuration - -Listed below are configuration keys needed to get the `edc-controlplane-postgresql-hashicorp-vault` up and running. -Details regarding each configuration property can be found at the [documentary section of the EDC](https://github.com/eclipse-edc/Connector/tree/main/docs). - -| Key | Required | Example | Description | -|--------------------------------------------------|----------|------------------------------------------------------------------------------|----------------------------| -| edc.api.auth.key | | password | default value: random UUID | -| web.http.default.port | X | 8080 | | -| web.http.default.path | X | /api | | -| web.http.data.port | X | 8181 | | -| web.http.data.path | X | /data | | -| web.http.validation.port | X | 8182 | | -| web.http.validation.path | X | /validation | | -| web.http.control.port | X | 9999 | | -| web.http.control.path | X | /api/controlplane/control | | -| web.http.ids.port | X | 8282 | | -| web.http.ids.path | X | /api/v1/ids | | -| edc.receiver.http.endpoint | X | | | -| edc.ids.title | | Eclipse Dataspace Connector | | -| edc.ids.description | | Eclipse Dataspace Connector | | -| edc.ids.id | | urn:connector:edc | | -| edc.ids.security.profile | | base | | -| edc.ids.endpoint | | | | -| edc.ids.maintainer | | | | -| edc.ids.curator | | | | -| edc.ids.catalog.id | | urn:catalog:default | | -| ids.webhook.address | | | | -| edc.hostname | | localhost | | -| edc.oauth.token.url | X | | | -| edc.oauth.public.key.alias | X | key-to-daps-certificate-in-keyvault | | -| edc.oauth.private.key.alias | X | key-to-private-key-in-keyvault | | -| edc.oauth.client.id | X | daps-oauth-client-id | | -| edc.vault.hashicorp.url | X | | | -| edc.vault.hashicorp.token | X | 55555555-6666-7777-8888-999999999999 | | -| edc.vault.hashicorp.timeout.seconds | | 30 | | -| edc.datasource.asset.name | X | asset | | -| edc.datasource.asset.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_asset_db | | -| edc.datasource.asset.user | X | username | | -| edc.datasource.asset.password | X | password | | -| edc.datasource.contractdefinition.name | X | contractdefinition | | -| edc.datasource.contractdefinition.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractdefinition_db | | -| edc.datasource.contractdefinition.user | X | username | | -| edc.datasource.contractdefinition.password | X | password | | -| edc.datasource.contractnegotiation.name | X | contractnegotiation | | -| edc.datasource.contractnegotiation.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractnegotiation_db | | -| edc.datasource.contractnegotiation.user | X | username | | -| edc.datasource.contractnegotiation.password | X | password | | -| edc.datasource.policy.name | X | policy | | -| edc.datasource.policy.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_policy_db | | -| edc.datasource.policy.user | X | username | | -| edc.datasource.policy.password | X | password | | -| edc.datasource.transferprocess.name | X | transferprocess | | -| edc.datasource.transferprocess.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_transferprocess_db | | -| edc.datasource.transferprocess.user | X | username | | -| edc.datasource.transferprocess.password | X | password | | -| edc.transfer.proxy.endpoint | X | | | -| edc.transfer.proxy.token.signer.privatekey.alias | X | | | - -### Example configuration.properties - -JDK properties-style configuration of the EDC Control-Plane is expected to be mounted to `/app/configuration.properties` within the container. - -```shell -# Create configuration.properties -export CONFIGURATION_PROPERTIES_FILE=$(mktemp /tmp/configuration.properties.XXXXXX) -cat << 'EOF' > ${CONFIGURATION_PROPERTIES_FILE} - -web.http.default.port=8080 -web.http.default.path=/api -web.http.data.port=8181 -web.http.data.path=/data -web.http.validation.port=8182 -web.http.validation.path=/validation -web.http.control.port=9999 -web.http.control.path=/api/controlplane/control -web.http.ids.port=8282 -web.http.ids.path=/api/v1/ids - -edc.receiver.http.endpoint=http://backend-service - -edc.ids.title=Eclipse Dataspace Connector -edc.ids.description=Eclipse Dataspace Connector -edc.ids.id=urn:connector:edc -edc.ids.security.profile=base -edc.ids.endpoint=http://localhost:8282/api/v1/ids -edc.ids.maintainer=http://localhost -edc.ids.curator=http://localhost -edc.ids.catalog.id=urn:catalog:default -ids.webhook.address=http://localhost:8282/api/v1/ids - -edc.hostname=localhost - -edc.api.auth.key=password - -# OAuth / DAPS related configuration -edc.oauth.token.url=https://daps.catena-x.net -edc.oauth.public.key.alias=key-to-daps-certificate-in-keyvault -edc.oauth.private.key.alias=key-to-private-key-in-keyvault -edc.oauth.client.id=daps-oauth-client-id - -# HashiCorp vault related configuration -edc.vault.hashicorp.url=http://vault -edc.vault.hashicorp.token=55555555-6666-7777-8888-999999999999 -edc.vault.hashicorp.timeout.seconds=30 - -# Control- / Data- Plane configuration -edc.transfer.proxy.endpoint=http://dataplane-public-endpoint/public -edc.transfer.proxy.token.signer.privatekey.alias=token-signer-private-key - -# Postgresql related configuration -edc.datasource.asset.name=asset -edc.datasource.asset.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_asset -edc.datasource.asset.user=user -edc.datasource.asset.password=pass -edc.datasource.contractdefinition.name=contractdefinition -edc.datasource.contractdefinition.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractdefinition -edc.datasource.contractdefinition.user=user -edc.datasource.contractdefinition.password=pass -edc.datasource.contractnegotiation.name=contractnegotiation -edc.datasource.contractnegotiation.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractnegotiation -edc.datasource.contractnegotiation.user=user -edc.datasource.contractnegotiation.password=pass -edc.datasource.policy.name=policy -edc.datasource.policy.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_policy -edc.datasource.policy.user=user -edc.datasource.policy.password=pass -edc.datasource.transferprocess.name=transferprocess -edc.datasource.transferprocess.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_transferprocess -edc.datasource.transferprocess.user=user -edc.datasource.transferprocess.password=pass -EOF -``` - -### Example logging.properties - -```shell -# Create logging.properties -export LOGGING_PROPERTIES_FILE=$(mktemp /tmp/logging.properties.XXXXXX) -cat << 'EOF' > ${LOGGING_PROPERTIES_FILE} -.level=INFO -org.eclipse.edc.level=ALL -handlers=java.util.logging.ConsoleHandler -java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter -java.util.logging.ConsoleHandler.level=ALL -java.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n -EOF -``` - -### Example opentelemetry.properties - -```shell -# Create opentelemetry.properties -export OPENTELEMETRY_PROPERTIES_FILE=$(mktemp /tmp/opentelemetry.properties.XXXXXX) -cat << 'EOF' > ${OPENTELEMETRY_PROPERTIES_FILE} -otel.javaagent.enabled=false -otel.javaagent.debug=false -EOF -``` - -## Running - -```shell -docker run \ - -p 8080:8080 -p 8181:8181 -p 8182:8182 -p 8282:8282 -p 9090:9090 -p 9999:9999 \ - -v ${CONFIGURATION_PROPERTIES_FILE:-/dev/null}:/app/configuration.properties \ - -v ${LOGGING_PROPERTIES_FILE:-/dev/null}:/app/logging.properties \ - -v ${OPENTELEMETRY_PROPERTIES_FILE:-/dev/null}:/app/opentelemetry.properties \ - -i edc-controlplane-postgresql-hashicorp-vault:latest -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/notice.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/notice.md deleted file mode 100644 index 516580e87a3..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/notice.md +++ /dev/null @@ -1,28 +0,0 @@ -# Notice for Docker image - -An EDC Control Plane using PostgreSQL as persistence backend, and HashiCorp Vault as secret store. - -DockerHub: - -Eclipse Tractus-X product(s) installed within the image: - -## TractusX-EDC Control Plane - -- GitHub: -- Project home: -- Dockerfile: -- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE) - -## Used base image - -- [eclipse-temurin:17.0.6_10-jre-alpine](https://github.com/adoptium/containers) -- Official Eclipse Temurin DockerHub page: -- Eclipse Temurin Project: -- Additional information about the Eclipse Temurin - images: - -As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc -from the base distribution, along with any direct or indirect dependencies of the primary software being contained). - -As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies -with any relevant licenses for all software contained within. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql/README.md deleted file mode 100644 index 774abc73ede..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql/README.md +++ /dev/null @@ -1,185 +0,0 @@ -# EDC Control-Plane backed by Postgresql - -## Used Components - -- [Postgresql](https://www.postgresql.org/) - -## Building - -```shell -./gardlew :edc-controlplane:edc-controlplane-postgresql:dockerize -``` - -## Configuration - -Listed below are configuration keys needed to get the `edc-controlplane-postgresql` up and running. -Details regarding each configuration property can be found at the [documentary section of the EDC](https://github.com/eclipse-edc/Connector/tree/main/docs). - -| Key | Required | Example | Description | -|--------------------------------------------------|----------|------------------------------------------------------------------------------|----------------------------| -| edc.api.auth.key | | password | default value: random UUID | -| web.http.default.port | X | 8080 | | -| web.http.default.path | X | /api | | -| web.http.data.port | X | 8181 | | -| web.http.data.path | X | | | -| web.http.validation.port | X | 8182 | | -| web.http.validation.path | X | /validation | | -| web.http.control.port | X | 9999 | | -| web.http.control.path | X | /api/controlplane/control | | -| web.http.ids.port | X | 8282 | | -| web.http.ids.path | X | /api/v1/ids | | -| edc.receiver.http.endpoint | X | | | -| edc.ids.title | | Eclipse Dataspace Connector | | -| edc.ids.description | | Eclipse Dataspace Connector | | -| edc.ids.id | | urn:connector:edc | | -| edc.ids.security.profile | | base | | -| edc.ids.endpoint | | | | -| edc.ids.maintainer | | | | -| edc.ids.curator | | | | -| edc.ids.catalog.id | | urn:catalog:default | | -| ids.webhook.address | | | | -| edc.hostname | | localhost | | -| edc.oauth.token.url | X | | | -| edc.oauth.public.key.alias | X | key-to-daps-certificate-in-keyvault | | -| edc.oauth.private.key.alias | X | key-to-private-key-in-keyvault | | -| edc.oauth.client.id | X | daps-oauth-client-id | | -| edc.vault.clientid | X | 00000000-1111-2222-3333-444444444444 | | -| edc.vault.tenantid | X | 55555555-6666-7777-8888-999999999999 | | -| edc.vault.name | X | my-vault-name | | -| edc.vault.clientsecret | X | 34-chars-secret | | -| edc.datasource.asset.name | X | asset | | -| edc.datasource.asset.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_asset_db | | -| edc.datasource.asset.user | X | username | | -| edc.datasource.asset.password | X | password | | -| edc.datasource.contractdefinition.name | X | contractdefinition | | -| edc.datasource.contractdefinition.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractdefinition_db | | -| edc.datasource.contractdefinition.user | X | username | | -| edc.datasource.contractdefinition.password | X | password | | -| edc.datasource.contractnegotiation.name | X | contractnegotiation | | -| edc.datasource.contractnegotiation.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractnegotiation_db | | -| edc.datasource.contractnegotiation.user | X | username | | -| edc.datasource.contractnegotiation.password | X | password | | -| edc.datasource.policy.name | X | policy | | -| edc.datasource.policy.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_policy_db | | -| edc.datasource.policy.user | X | username | | -| edc.datasource.policy.password | X | password | | -| edc.datasource.transferprocess.name | X | transferprocess | | -| edc.datasource.transferprocess.url | X | jdbc:postgresql://postgres.svc.cluster.local:5432/edc_transferprocess_db | | -| edc.datasource.transferprocess.user | X | username | | -| edc.datasource.transferprocess.password | X | password | | -| edc.transfer.proxy.endpoint | X | | | -| edc.transfer.proxy.token.signer.privatekey.alias | X | | | - -### Example configuration.properties - -JDK properties-style configuration of the EDC Control-Plane is expected to be mounted to `/app/configuration.properties` within the container. - -```shell -# Create configuration.properties -export CONFIGURATION_PROPERTIES_FILE=$(mktemp /tmp/configuration.properties.XXXXXX) -cat << 'EOF' > ${CONFIGURATION_PROPERTIES_FILE} - -web.http.default.port=8080 -web.http.default.path=/api -web.http.data.port=8181 -web.http.data.path=/data -web.http.validation.port=8182 -web.http.validation.path=/validation -web.http.control.port=9999 -web.http.control.path=/api/controlplane/control -web.http.ids.port=8282 -web.http.ids.path=/api/v1/ids - -edc.receiver.http.endpoint=http://backend-service - -edc.ids.title=Eclipse Dataspace Connector -edc.ids.description=Eclipse Dataspace Connector -edc.ids.id=urn:connector:edc -edc.ids.security.profile=base -edc.ids.endpoint=http://localhost:8282/api/v1/ids -edc.ids.maintainer=http://localhost -edc.ids.curator=http://localhost -edc.ids.catalog.id=urn:catalog:default -ids.webhook.address=http://localhost:8282/api/v1/ids - -edc.hostname=localhost - -edc.api.auth.key=password - -# OAuth / DAPS related configuration -edc.oauth.token.url=https://daps.catena-x.net -edc.oauth.public.key.alias=key-to-daps-certificate-in-keyvault -edc.oauth.private.key.alias=key-to-private-key-in-keyvault -edc.oauth.client.id=daps-oauth-client-id - -# Azure vault related configuration -edc.vault.clientid=00000000-1111-2222-3333-444444444444 -edc.vault.tenantid=55555555-6666-7777-8888-999999999999 -edc.vault.name=my-vault-name -edc.vault.clientsecret=34-chars-secret - -# Control- / Data- Plane configuration -edc.transfer.proxy.endpoint=http://dataplane-public-endpoint/public -edc.transfer.proxy.token.signer.privatekey.alias=azure-vault-token-signer-private-key - -# Postgresql related configuration -edc.datasource.asset.name=asset -edc.datasource.asset.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_asset -edc.datasource.asset.user=user -edc.datasource.asset.password=pass -edc.datasource.contractdefinition.name=contractdefinition -edc.datasource.contractdefinition.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractdefinition -edc.datasource.contractdefinition.user=user -edc.datasource.contractdefinition.password=pass -edc.datasource.contractnegotiation.name=contractnegotiation -edc.datasource.contractnegotiation.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_contractnegotiation -edc.datasource.contractnegotiation.user=user -edc.datasource.contractnegotiation.password=pass -edc.datasource.policy.name=policy -edc.datasource.policy.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_policy -edc.datasource.policy.user=user -edc.datasource.policy.password=pass -edc.datasource.transferprocess.name=transferprocess -edc.datasource.transferprocess.url=jdbc:postgresql://postgres.svc.cluster.local:5432/edc_transferprocess -edc.datasource.transferprocess.user=user -edc.datasource.transferprocess.password=pass - -EOF -``` - -### Example logging.properties - -```shell -# Create logging.properties -export LOGGING_PROPERTIES_FILE=$(mktemp /tmp/logging.properties.XXXXXX) -cat << 'EOF' > ${LOGGING_PROPERTIES_FILE} -.level=INFO -org.eclipse.edc.level=ALL -handlers=java.util.logging.ConsoleHandler -java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter -java.util.logging.ConsoleHandler.level=ALL -java.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n -EOF -``` - -### Example opentelemetry.properties - -```shell -# Create opentelemetry.properties -export OPENTELEMETRY_PROPERTIES_FILE=$(mktemp /tmp/opentelemetry.properties.XXXXXX) -cat << 'EOF' > ${OPENTELEMETRY_PROPERTIES_FILE} -otel.javaagent.enabled=true -otel.javaagent.debug=false -EOF -``` - -## Running - -```shell -docker run \ - -p 8080:8080 -p 8181:8181 -p 8182:8182 -p 8282:8282 -p 9090:9090 -p 9999:9999 \ - -v ${CONFIGURATION_PROPERTIES_FILE:-/dev/null}:/app/configuration.properties \ - -v ${LOGGING_PROPERTIES_FILE:-/dev/null}:/app/logging.properties \ - -v ${OPENTELEMETRY_PROPERTIES_FILE:-/dev/null}:/app/opentelemetry.properties \ - -i edc-controlplane-postgresql:latest -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql/notice.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql/notice.md deleted file mode 100644 index b0bd731415d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-controlplane-postgresql/notice.md +++ /dev/null @@ -1,28 +0,0 @@ -# Notice for Docker image - -An EDC Control Plane using PostgreSQL as persistence backend, and Azure KeyVault as secret store. - -DockerHub: - -Eclipse Tractus-X product(s) installed within the image: - -## TractusX-EDC Control Plane - -- GitHub: -- Project home: -- Dockerfile: -- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE) - -## Used base image - -- [eclipse-temurin:17.0.6_10-jre-alpine](https://github.com/adoptium/containers) -- Official Eclipse Temurin DockerHub page: -- Eclipse Temurin Project: -- Additional information about the Eclipse Temurin - images: - -As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc -from the base distribution, along with any direct or indirect dependencies of the primary software being contained). - -As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies -with any relevant licenses for all software contained within. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-runtime-memory/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-runtime-memory/README.md deleted file mode 100644 index caf7fe24e8d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-runtime-memory/README.md +++ /dev/null @@ -1,131 +0,0 @@ -# EDC Control-Plane backed by In-Memory Stores - -## Security - -### In-memory Vault implementation - -The goal of this extension is to provide an ephemeral, memory-based vault implementation that can be used in testing or -demo scenarios. - -Please not that this vault does not encrypt the secrets, they are held in memory in plain text at runtime! In addition, -its ephemeral nature makes it unsuitable for replicated/multi-instance scenarios, i.e. Kubernetes. - -> It is not a secure secret store, please do NOT use it in production workloads! - -## Building - -```shell -./gradlew :edc-controlplane:edc-runtime-memory:dockerize -``` - -## Configuration (configuration.properties) - -Listed below are configuration keys needed to get the `edc-runtime-memory` up and running. -Details regarding each configuration property can be found at -the [documentary section of the EDC](https://github.com/eclipse-edc/Connector/tree/main/docs). - -| Key | Required | Example | Description | -|--------------------------------------------------|----------|-------------------------------------|----------------------------| -| edc.api.auth.key | | password | default value: random UUID | -| web.http.default.port | X | 8080 | | -| web.http.default.path | X | /api | | -| web.http.data.port | X | 8181 | | -| web.http.data.path | X | /data | | -| web.http.validation.port | X | 8182 | | -| web.http.validation.path | X | /validation | | -| web.http.control.port | X | 9999 | | -| web.http.control.path | X | /api/controlplane/control | | -| web.http.ids.port | X | 8282 | | -| web.http.ids.path | X | /api/v1/ids | | -| edc.receiver.http.endpoint | X | | | -| edc.ids.title | | Eclipse Dataspace Connector | | -| edc.ids.description | | Eclipse Dataspace Connector | | -| edc.ids.id | | urn:connector:edc | | -| edc.ids.security.profile | | base | | -| edc.ids.endpoint | | | | -| edc.ids.maintainer | | | | -| edc.ids.curator | | | | -| edc.ids.catalog.id | | urn:catalog:default | | -| ids.webhook.address | | | | -| edc.hostname | | localhost | | -| edc.oauth.token.url | X | | | -| edc.oauth.public.key.alias | X | key-to-daps-certificate-in-keyvault | | -| edc.oauth.private.key.alias | X | key-to-private-key-in-keyvault | | -| edc.oauth.client.id | X | daps-oauth-client-id | | -| edc.transfer.proxy.endpoint | X | | | -| edc.transfer.proxy.token.signer.privatekey.alias | X | | | - -### Example configuration.properties - -JDK properties-style configuration of the EDC Control-Plane is expected to be mounted to `/app/configuration.properties` -within the container. - -```shell -# Create configuration.properties -export CONFIGURATION_PROPERTIES_FILE=$(mktemp /tmp/configuration.properties.XXXXXX) -cat << 'EOF' > ${CONFIGURATION_PROPERTIES_FILE} - -web.http.default.port=8080 -web.http.default.path=/api -web.http.data.port=8181 -web.http.data.path=/data -web.http.validation.port=8182 -web.http.validation.path=/validation -web.http.control.port=9999 -web.http.control.path=/api/controlplane/control -web.http.ids.port=8282 -web.http.ids.path=/api/v1/ids - -edc.receiver.http.endpoint=http://backend-service - -edc.ids.title=Eclipse Dataspace Connector -edc.ids.description=Eclipse Dataspace Connector -edc.ids.id=urn:connector:edc -edc.ids.security.profile=base -edc.ids.endpoint=http://localhost:8282/api/v1/ids -edc.ids.maintainer=http://localhost -edc.ids.curator=http://localhost -edc.ids.catalog.id=urn:catalog:default -ids.webhook.address=http://localhost:8282/api/v1/ids - -edc.hostname=localhost - -edc.api.auth.key=password - -# OAuth / DAPS related configuration -edc.oauth.token.url=https://daps.catena-x.net -edc.oauth.public.key.alias=key-to-daps-certificate-in-keyvault -edc.oauth.private.key.alias=key-to-private-key-in-keyvault -edc.oauth.client.id=daps-oauth-client-id - -# Control- / Data- Plane configuration -edc.transfer.proxy.endpoint=http://dataplane-public-endpoint/public -edc.transfer.proxy.token.signer.privatekey.alias=azure-vault-token-signer-private-key -EOF -``` - -### Example logging.properties - -```shell -# Create logging.properties -export LOGGING_PROPERTIES_FILE=$(mktemp /tmp/logging.properties.XXXXXX) -cat << 'EOF' > ${LOGGING_PROPERTIES_FILE} -.level=INFO -org.eclipse.edc.level=ALL -handlers=java.util.logging.ConsoleHandler -java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter -java.util.logging.ConsoleHandler.level=ALL -java.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n -EOF -``` - -## Running - -```shell -docker run \ - -e SECRETS="key1:secret1,key2:secret2" \ - -p 8080:8080 -p 8181:8181 -p 8182:8182 -p 8282:8282 -p 9090:9090 -p 9999:9999 \ - -v ${CONFIGURATION_PROPERTIES_FILE:-/dev/null}:/app/configuration.properties \ - -v ${LOGGING_PROPERTIES_FILE:-/dev/null}:/app/logging.properties \ - -i edc-runtime-memory:latest -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-runtime-memory/notice.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-runtime-memory/notice.md deleted file mode 100644 index b339cd744f4..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-controlplane/edc-runtime-memory/notice.md +++ /dev/null @@ -1,28 +0,0 @@ -# Notice for Docker image - -An EDC Control Plane using memory-based storage, and Azure KeyVault as secret store. - -DockerHub: - -Eclipse Tractus-X product(s) installed within the image: - -## TractusX-EDC Control Plane - -- GitHub: -- Project home: -- Dockerfile: -- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE) - -## Used base image - -- [eclipse-temurin:17.0.6_10-jre-alpine](https://github.com/adoptium/containers) -- Official Eclipse Temurin DockerHub page: -- Eclipse Temurin Project: -- Additional information about the Eclipse Temurin - images: - -As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc -from the base distribution, along with any direct or indirect dependencies of the primary software being contained). - -As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies -with any relevant licenses for all software contained within. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/README.md deleted file mode 100644 index 9ca28b38d8f..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/README.md +++ /dev/null @@ -1,16 +0,0 @@ -# Data Plane - -The Eclipse Dataspace Connector consists of a **Control Plan** and a **Data Plane** Application. -While the **Control Plane** managing several data transfers, the **Data Plane** is responsible for doing the actual transfer. Like this data is never routed through the control plane itself und must always pass the data plane. - -## Security - -### Confidential Settings - -Please be aware that there are several confidential settings, that should not be part of the actual EDC configuration file (e.g. the Vault credentials). - -As it is possible to configure EDC settings via environment variables, one way to do it would be via Kubernetes Secrets. For other deployment scenarios than Kubernetes equivalent measures should be taken. - -## Known Data Plane Issues - -Please have a look at the open issues in the open source repository: [EDC Github Repository](https://github.com/eclipse-edc/Connector/issues) diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/edc-dataplane-azure-vault/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/edc-dataplane-azure-vault/README.md deleted file mode 100644 index 6fab7351c70..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/edc-dataplane-azure-vault/README.md +++ /dev/null @@ -1,100 +0,0 @@ -# EDC Data-Plane with Azure Key Vault - -## Used Components - -- [Azure Key Vault](https://azure.microsoft.com/en-us/services/key-vault/#product-overview) - -## Building - -```shell -./gardlew :edc-dataplane:edc-dataplane-azure-vault:dockerize -``` - -## Configuration - -Listed below are configuration keys needed to get the `edc-dataplane-azure-vault` up and running. -Details regarding each configuration property can be found at the [documentary section of the EDC](https://github.com/eclipse-edc/Connector/tree/main/docs). - -| Key | Required | Example | Description | -|-----------------------------------------|----------|---------------------------------------------|-------------| -| web.http.default.port | X | 8080 | | -| web.http.default.path | X | /api | | -| web.http.public.port | X | 8181 | | -| web.http.public.path | X | | | -| web.http.control.port | X | 9999 | | -| web.http.control.path | X | /api/controlplane/control | | -| edc.receiver.http.endpoint | X | | | -| edc.hostname | | localhost | | -| edc.oauth.client.id | X | daps-oauth-client-id | | -| edc.vault.clientid | X | 00000000-1111-2222-3333-444444444444 | | -| edc.vault.tenantid | X | 55555555-6666-7777-8888-999999999999 | | -| edc.vault.name | X | my-vault-name | | -| edc.vault.clientsecret | X | 34-chars-secret | | -| edc.dataplane.token.validation.endpoint | X | | | - -### Example configuration.properties - -JDK properties-style configuration of the EDC Control-Plane is expected to be mounted to `/app/configuration.properties` within the container. - -```shell -# Create configuration.properties -export CONFIGURATION_PROPERTIES_FILE=$(mktemp /tmp/configuration.properties.XXXXXX) -cat << 'EOF' > ${CONFIGURATION_PROPERTIES_FILE} - -web.http.default.port=8080 -web.http.default.path=/api -web.http.public.port=8185 -web.http.public.path=/public -web.http.control.port=9999 -web.http.control.path=/api/dataplane/control - -# Validation endpoint of controlplane -edc.dataplane.token.validation.endpoint=http://controlplane:8182/validation/token - -# EDC hostname -edc.hostname=localhost - -# Azure vault related configuration -edc.vault.clientid=00000000-1111-2222-3333-444444444444 -edc.vault.tenantid=55555555-6666-7777-8888-999999999999 -edc.vault.name=my-vault-name -edc.vault.clientsecret=34-chars-secret -EOF -``` - -### Example logging.properties - -```shell -# Create logging.properties -export LOGGING_PROPERTIES_FILE=$(mktemp /tmp/logging.properties.XXXXXX) -cat << 'EOF' > ${LOGGING_PROPERTIES_FILE} -.level=INFO -org.eclipse.edc.level=ALL -handlers=java.util.logging.ConsoleHandler -java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter -java.util.logging.ConsoleHandler.level=ALL -java.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n -EOF -``` - -### Example opentelemetry.properties - -```shell -# Create opentelemetry.properties -export OPENTELEMETRY_PROPERTIES_FILE=$(mktemp /tmp/opentelemetry.properties.XXXXXX) -cat << 'EOF' > ${OPENTELEMETRY_PROPERTIES_FILE} -otel.javaagent.enabled=true -otel.javaagent.debug=false -EOF -``` - -## Running - -```shell -docker run \ - -p 8080:8080 -p 8185:8185 -p 9999:9999 -p 9090:9090 \ - -v ${CONFIGURATION_PROPERTIES_FILE:-/dev/null}:/app/configuration.properties \ - -v ${LOGGING_PROPERTIES_FILE:-/dev/null}:/app/logging.properties \ - -v ${OPENTELEMETRY_PROPERTIES_FILE:-/dev/null}:/app/opentelemetry.properties \ - -i edc-dataplane-azure-vault:latest -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/edc-dataplane-azure-vault/notice.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/edc-dataplane-azure-vault/notice.md deleted file mode 100644 index 2e176a904b7..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/edc-dataplane-azure-vault/notice.md +++ /dev/null @@ -1,28 +0,0 @@ -# Notice for Docker image - -An EDC Data Plane using the Azure KeyVault. - -DockerHub: - -Eclipse Tractus-X product(s) installed within the image: - -## TractusX-EDC Data Plane - -- GitHub: -- Project home: -- Dockerfile: -- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE) - -## Used base image - -- [eclipse-temurin:17.0.6_10-jre-alpine](https://github.com/adoptium/containers) -- Official Eclipse Temurin DockerHub page: -- Eclipse Temurin Project: -- Additional information about the Eclipse Temurin - images: - -As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc -from the base distribution, along with any direct or indirect dependencies of the primary software being contained). - -As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies -with any relevant licenses for all software contained within. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/edc-dataplane-base/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/edc-dataplane-base/README.md deleted file mode 100644 index 89ec915067b..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/edc-dataplane-base/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# EDC Data-Plane Base Module - -## Building - -```shell -./gardlew :edc-dataplane:edc-dataplane-base:build -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/edc-dataplane-hashicorp-vault/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/edc-dataplane-hashicorp-vault/README.md deleted file mode 100644 index 1be6a034c05..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/edc-dataplane-hashicorp-vault/README.md +++ /dev/null @@ -1,98 +0,0 @@ -# EDC Data-Plane Hashicorp Vault - -## Used Components - -- [Hashicorp Vault](https://www.vaultproject.io/) - -## Building - -```shell -./gardlew :edc-dataplane:edc-dataplane-hashicorp-vault:dockerize -``` - -## Configuration - -Listed below are configuration keys needed to get the `edc-dataplane-hashicorp-vault` up and running. -Details regarding each configuration property can be found at the [documentary section of the EDC](https://github.com/eclipse-edc/Connector/tree/main/docs). - -| Key | Required | Example | Description | -|-----------------------------------------|----------|---------------------------------------------|-------------| -| web.http.default.port | X | 8080 | | -| web.http.default.path | X | /api | | -| web.http.public.port | X | 8181 | | -| web.http.public.path | X | | | -| web.http.control.port | X | 9999 | | -| web.http.control.path | X | /api/controlplane/control | | -| edc.receiver.http.endpoint | X | | | -| edc.hostname | | localhost | | -| edc.oauth.client.id | X | daps-oauth-client-id | | -| edc.vault.hashicorp.url | X | | | -| edc.vault.hashicorp.token | X | 55555555-6666-7777-8888-999999999999 | | -| edc.vault.hashicorp.timeout.seconds | | 30 | | -| edc.dataplane.token.validation.endpoint | X | | | - -### Example configuration.properties - -JDK properties-style configuration of the EDC Control-Plane is expected to be mounted to `/app/configuration.properties` within the container. - -```shell -# Create configuration.properties -export CONFIGURATION_PROPERTIES_FILE=$(mktemp /tmp/configuration.properties.XXXXXX) -cat << 'EOF' > ${CONFIGURATION_PROPERTIES_FILE} - -web.http.default.port=8080 -web.http.default.path=/api -web.http.public.port=8185 -web.http.public.path=/public -web.http.control.port=9999 -web.http.control.path=/api/dataplane/control - -# Validation endpoint of controlplane -edc.dataplane.token.validation.endpoint=http://controlplane:8182/validation/token - -# EDC hostname -edc.hostname=localhost - -# HashiCorp vault related configuration -edc.vault.hashicorp.url=http://vault -edc.vault.hashicorp.token=55555555-6666-7777-8888-999999999999 -edc.vault.hashicorp.timeout.seconds=30 -EOF -``` - -### Example logging.properties - -```shell -# Create logging.properties -export LOGGING_PROPERTIES_FILE=$(mktemp /tmp/logging.properties.XXXXXX) -cat << 'EOF' > ${LOGGING_PROPERTIES_FILE} -.level=INFO -org.eclipse.edc.level=ALL -handlers=java.util.logging.ConsoleHandler -java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter -java.util.logging.ConsoleHandler.level=ALL -java.util.logging.SimpleFormatter.format=[%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS] [%4$-7s] %5$s%6$s%n -EOF -``` - -### Example opentelemetry.properties - -```shell -# Create opentelemetry.properties -export OPENTELEMETRY_PROPERTIES_FILE=$(mktemp /tmp/opentelemetry.properties.XXXXXX) -cat << 'EOF' > ${OPENTELEMETRY_PROPERTIES_FILE} -otel.javaagent.enabled=true -otel.javaagent.debug=false -EOF -``` - -## Running - -```shell -docker run \ - -p 8080:8080 -p 8185:8185 -p 9999:9999 -p 9090:9090 \ - -v ${CONFIGURATION_PROPERTIES_FILE:-/dev/null}:/app/configuration.properties \ - -v ${LOGGING_PROPERTIES_FILE:-/dev/null}:/app/logging.properties \ - -v ${OPENTELEMETRY_PROPERTIES_FILE:-/dev/null}:/app/opentelemetry.properties \ - -i edc-dataplane-hashicorp-vault:latest -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/edc-dataplane-hashicorp-vault/notice.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/edc-dataplane-hashicorp-vault/notice.md deleted file mode 100644 index 37b9461385f..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-dataplane/edc-dataplane-hashicorp-vault/notice.md +++ /dev/null @@ -1,28 +0,0 @@ -# Notice for Docker image - -An EDC Data Plane using the HashiCorp Vault - -DockerHub: - -Eclipse Tractus-X product(s) installed within the image: - -## TractusX-EDC Data Plane - -- GitHub: -- Project home: -- Dockerfile: -- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE) - -## Used base image - -- [eclipse-temurin:17.0.6_10-jre-alpine](https://github.com/adoptium/containers) -- Official Eclipse Temurin DockerHub page: -- Eclipse Temurin Project: -- Additional information about the Eclipse Temurin - images: - -As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc -from the base distribution, along with any direct or indirect dependencies of the primary software being contained). - -As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies -with any relevant licenses for all software contained within. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/.gradle/7.4.2/fileHashes/fileHashes.lock b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/.gradle/7.4.2/fileHashes/fileHashes.lock deleted file mode 100644 index 1b5446f7472..00000000000 Binary files a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/.gradle/7.4.2/fileHashes/fileHashes.lock and /dev/null differ diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/business-partner-validation/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/business-partner-validation/README.md deleted file mode 100644 index 79a0d7fc394..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/business-partner-validation/README.md +++ /dev/null @@ -1,189 +0,0 @@ -# Business Partner Validation Extension - -Using the Business Partner Validation Extension it's possible to add configurable validation against -Catena-X `Participants` in the `ContractDefinition.AccessPolicy`. Using a BPN in `ContractDefinition.ContractPolicy` is possible, too, but once the contract is complete there is no policy enforcement in place from the EDC. - -It is recommended to have a basic understanding of the EDC contract/policy domain before using this extension. The -corresponding documentation can be found in the [EDC GitHub Repository](https://github.com/eclipse-edc/Connector). - -The business partner number of another connector is part of its DAPS token. Once a BPN constraint is used in an access -policy the connector checks the token before sending out contract offers. - -Example of business partner constraint: - -```json -{ - "leftExpression": { - "value": "BusinessPartner" - }, - "rightExpression": { - "value": "BPNLCDQ90000X42KU" - }, - "operator": "EQ" -} -``` - -The `leftExpression` must always contain 'BusinessPartner', so that the policy functions of this extension are invoked. -Additionally, the only `operator` that is supported by these policy functions is 'EQ'. Finally, the `rightExpression` -must contain the Business Partner Number. - -## Single BusinessPartnerNumber example - -The most simple BPN policy would allow the usage of certain data to a single Business Partner. An example `Policy` is -shown below. In this example the `edctype` properties are added, so that this policy may even be sent to the Management API. - -```json -{ - "uid": "", - "prohibitions": [], - "obligations": [], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "USE" - }, - "constraints": [ - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BusinessPartnerNumber" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "" - }, - "operator": "EQ" - } - ] - } - ] -} -``` - -## Multiple BusinessPartnerNumber example - -To define multiple BPN and allow multiple participants to use the data the `orconstraint` should be used. -It will permit the constraints contained to be evaluated using the `OR` operator. - -```json -{ - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "USE", - }, - "constraints": [ - { - "edctype": "dataspaceconnector:orconstraint", - "constraints": [ - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BusinessPartnerNumber" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "" - }, - "operator": "EQ" - }, - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BusinessPartnerNumber" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "" - }, - "operator": "EQ" - }, - - ... - - // other constraints can be added - ] - } - ], - "duties": [] - } - ] -} -``` - -## Important: EDC Policies are input sensitive - -Please be aware that the EDC ignores all Rules and Constraint it does not understand. This could cause your constrained policies to be public. - -### Example 1 for accidentially public - -```json -{ - "uid": "1", - "prohibitions": [], - "obligations": [], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "MY-USE" - }, - "constraints": [ - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BusinessPartnerNumber" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BPNLCDQ90000X42KU" - }, - "operator": "EQ" - } - ] - } - ] -} -``` - -This policy is public available, even though the constraint is described correct. The reason is, that this extension only registeres the Policy.Action `USE` within the EDC. Any other Action Type will have the EDC ignore the corresponding permission, hence interpret the polics as public policy. - -### Example 2 for accidentially public - -```json -{ - "uid": "1", - "prohibitions": [], - "obligations": [], - "permissions": [ - { - "edctype": "dataspaceconnector:permission", - "action": { - "type": "USE" - }, - "constraints": [ - { - "edctype": "AtomicConstraint", - "leftExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BusinesPartnerNumber" - }, - "rightExpression": { - "edctype": "dataspaceconnector:literalexpression", - "value": "BPNLCDQ90000X42KU" - }, - "operator": "EQ" - } - ] - } - ] -} -``` - -This policy is public available, too. The cause is a typo in the left-expression of the constraint. This extension only registers the `Constraint.LeftExpression` `BusinessPartnerNumber` within the EDC. Any other term will have the EDC ignore the corresponding constraint, hence interpret the policies as public policy. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/control-plane-adapter/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/control-plane-adapter/README.md deleted file mode 100644 index 5f2d0d89066..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/control-plane-adapter/README.md +++ /dev/null @@ -1,98 +0,0 @@ -# Control Plane Adapter Extension - -The goal of this extension is to simplify the process of retrieving data out of EDC. It returns an `EndpointDataReference` object, hiding all the communication details for contract offers, contract negotiation process and retrieving `EndpointDataReference` from EDC controlplane. - -Additional requirements, that affects the architecture of the extension: - -- can return data both in SYNC and ASYNC mode (currently only SYNC endpoint available) -- can be persistent, so that process can be restored from the point where it was before application was stopped -- scaling horizontally (when persistence is added to configuration) -- can retry failed part of the process (no need to start the process from the beginning) - -## Configuration - -| Key | Description | Mandatory | Default | -|:---------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------| -| `edc.cp.adapter.default.message.retry.number` | Number of retries of a message, in case of an error, within the internal process of retrieving DataReference | no | 3 | -| `edc.cp.adapter.default.sync.request.timeout` | Timeout for synchronous request (in seconds), after witch 'timeout' error will be returned to the requesting client | no | 20 | -| `edc.cp.adapter.messagebus.inmemory.thread.number` | Number of threads running within the in-memory implementation of MessageBus | no | 10 | -| `edc.cp.adapter.reuse.contract.agreement` | Turn on/off reusing of existing contract agreements for the specific asset. Once the contract is agreed, the second request for the same asset will reuse the agreement (if exists) pulled from the EDC. | no | true | -| `edc.cp.adapter.cache.catalog.expire.after` | Number of seconds, after witch previously requested catalog will not be reused, and will be removed from catalog cache | no | 300 | -| `edc.cp.adapter.catalog.request.limit` | Maximum number of items taken from Catalog within single request. Requests are repeated until all offers of the query are retrieved | no | 100 | - -By default, the extension works in "IN MEMORY" mode. This setup has some limitations: - -- It can work only within single EDC instance. If CP-adapter requests are handled by more than one EDC, data flow may be broken. -- If the EDC instance is restarted, all running processes are lost. - -To run CP-Adapter in "PERSISTENT" mode, You need to create a proper tables with [this](docs/schema.sql) script, and add the following configuration values to your controlplane EDC properties file: - -| Key | Description | -|-------------------------------------|----------------------| -| `edc.datasource.cpadapter.name` | data source name | -| `edc.datasource.cpadapter.url` | data source url | -| `edc.datasource.cpadapter.user` | data source user | -| `edc.datasource.cpadapter.password` | data source password | - -## How to use it - -1. Client sends a GET request with two parameters: assetId and the url of the provider controlplane: - - ```plain - {controlplaneUrl}:{web.http.management.port}/{web.http.management.path}/adapter/asset/sync/{assetId}?providerUrl={providerUrl} - ``` - - | Name | Description | - |----------------------------|----------------------------------------------------------------------------------| - | `controlplaneUrl` | The URL where the control plane of the consumer connector is available | - | `web.http.management.port` | Port of the management API provided by the control plane | - | `web.http.management.path` | Path of the management API provided by the control plane | - | `assetId` | ID of the wanted asset | - | `providerUrl` | URL pointing to the `data` endpoint of the IDS context of the provider connector | - - The example ULR could be: - - ```plain - http://localhost:9193/api/v1/data/adapter/asset/sync/123?providerUrl=http://localhost:8182/api/v1/ids/data - ``` - - Optional request parameters, that overwrite the settings for a single request: - - | Name | Description | - |--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `contractAgreementId` | Defines the ID of existing contract agreement, that should be reused for retrieving the asset. If parameter is specified, but contract is not found, 404 error will be returned. | - | `contractAgreementReuse` | Similar to `edc.cp.adapter.reuse.contract.agreement` option allows to turn off reusing of existing contracts, but on a request level. Set the parameter value to 'false' and new contract agrement will be negotiated. | - | `timeout` | Similar to `edc.cp.adapter.default.sync.request.timeout`, defines the maximum time of the request. If data is not ready, time out error will be returned. | - - The controller is registered under the context alias of the Management API. The authentication depends on the configuration of the Management API. - To find out more please visit: - - - [Management API Documentation](https://github.com/eclipse-edc/Connector/tree/main/extensions/control-plane/api/management-api) - - [Management API Configuration Extension](https://github.com/eclipse-edc/Connector/tree/main/extensions/common/api/management-api-configuration) - -2. `EndpointDataReference` object is returned. Example of the `EndpointDataReference` response: - - ```json - { - "id": "ee8b758a-4b02-4cca-bb37-d0256b4638e7", - "endpoint": "http://consumer-dataplane:9192/publicsubmodel?provider-connector-url=...", - "authKey": "Authorization", - "authCode": "eyJhbGciOiJSUzI1NiJ9.eyJkYWQiOi...", - "properties": { - "cid": "1:b2367617-5f51-48c5-9f25-e30a7299235c" - } - } - ``` - -3. Client, using the `EndpointDataReference`, retrieves the Asset through dataplane. - - Example of the dataplane GET request, to retrieve Asset, with `EndpointDataReference` information: - - ```plain - url: http://consumer-dataplane:9192/publicsubmodel?provider-connector-url=... {endpoint} - header: Authorization:eyJhbGciOiJSUzI1NiJ9.eyJkYWQiOi... {authKey:authCode} - ``` - -### Internal design of the extension - -![diagram](src/main/resources/control-plane-adapter.jpg) diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/control-plane-adapter/src/main/resources/control-plane-adapter.jpg b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/control-plane-adapter/src/main/resources/control-plane-adapter.jpg deleted file mode 100644 index 00fd1241bc9..00000000000 Binary files a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/control-plane-adapter/src/main/resources/control-plane-adapter.jpg and /dev/null differ diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/cx-oauth2/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/cx-oauth2/README.md deleted file mode 100644 index 479c783c792..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/cx-oauth2/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# Catena-X OAuth2 Extension - -## Why Catena-X needs this extension - -In IDS the DAPS token audience is always `idsc:IDS_CONNECTORS_ALL`. At first glance this makes it possible for other connectors to steal and reuse an received token. To mitigate this security risk IDS introduces something called `transportCertsSha256`, which couples the connector audience with its corresponding TLS/SSL certificate. - -From [GitHub IDS-G](https://github.com/International-Data-Spaces-Association/IDS-G/tree/main/Components/IdentityProvider/DAPS) - -> - **transportCertsSha256** Contains the public keys of the used transport certificates, hashed using SHA256. The identifying X509 certificate should not be used for the communication encryption. Therefore, the receiving party needs to connect the identity of a connector by relating its hostname (from the communication encryption layer) and the used private/public key pair, with its IDS identity claim of the DAT. The public transportation key must be one of the `transportCertsSha256` values. Otherwise, the receiving connector must expect that the requesting connector is using a false identity claim. In general, this claim holds an Array of Strings, but it may optionally hold a single String instead if the Array would have exactly one element. - -The reason IDS did this is to prevent the IDS DAPS to know, which connectors talk to each other. But this solution introduces a new level of complexity for different deployment scenarios. The Catena-X OAuth2 Extension introduces the classic audience validation again, so that Catena-X does not have to deal with these things for now. - -## Configuration - -| Key | Description | Mandatory | Default | -|:--------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|------------| -| edc.oauth.token.url | Token URL of the DAPS | X | | -| edc.oauth.public.key.alias | Vault alias of the public key | X | | -| edc.oauth.client.id | DAPS client id of the connector | X | | -| edc.oauth.private.key.alias | Vault lias of the private key | X | | -| edc.oauth.token.expiration.seconds | | | 5 minutes | -| edc.oauth.validation.nbf.leeway | DAPS token request leeway | | 10 seconds | -| edc.oauth.provider.jwks.refresh | Time between refresh of the DAPS json web key set | | 5 minutes | -| edc.ids.endpoint.audience | The audience the connector requests from the DAPS. Should be the IDS URL of the connector, e.g. `http://plato-edc-controlplane:8282/api/v1/ids/data` | X | | -| edc.ids.validation.referringconnector | Adds checks to the DAPS token. Validation that the `referringConnector` equals the `issuerConnector` and the `securityProfile` of the token is equal to the profile of the IDS message | | false | - -## Audience Validation - -Instead of the `idsc:IDS_CONNECTORS_ALL` the connector requests a specific audience from the DAPS. This audience will be the IDS URL, the connector intends to call. - -When a connector receives a message, it will checks the token audience is equal to the configured value in `edc.ids.endpoint.audience`. - -![sequence diagram](./diagrams/sequence.png) diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/cx-oauth2/diagrams/sequence.png b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/cx-oauth2/diagrams/sequence.png deleted file mode 100644 index 784441b4e7d..00000000000 Binary files a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/cx-oauth2/diagrams/sequence.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/cx-oauth2/diagrams/sequence.puml b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/cx-oauth2/diagrams/sequence.puml deleted file mode 100644 index d2f20f27879..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/cx-oauth2/diagrams/sequence.puml +++ /dev/null @@ -1,24 +0,0 @@ -@startuml - -title CX-DAPS Audience Validation - -participant ConnectorA as "Connector A" -participant DAPS as "IDS DAPS" -participant ConnectorB as "Connector B" - -== Configuration == - -ConnectorB <-? : Configure //edc.ids.endpoint.audience//\nto ///api/v1/ids/data// - -== Request == - -?-> ConnectorA ++: Initiate Catalog Request\n/data/catalog?providerUrl=///api/v1/ids/data// - ConnectorA -> DAPS ++: Request Token for audience\n///api/v1/ids/data// - return DAPS Token - ConnectorA -> ConnectorB ++ : Send Request with Token - ConnectorB -> ConnectorB : Check Audience equals\n/api/v1/ids/data - ... continue request processing ... - return Catalog Response -return Catalog - -@enduml \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/data-encryption/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/data-encryption/README.md deleted file mode 100644 index 586dad775ba..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/data-encryption/README.md +++ /dev/null @@ -1,42 +0,0 @@ -# Data Encryption Extension - -The Eclipse Dataspace Connector encrypts sensitive information inside a token it sends to other applications (from possibly other companies). This extension implements the encryption of this data and should be used with secure keys and algorithms at all times. - -## Algorithm Configuration - -| Key | Description | Mandatory | Default | -|:--------------------------------------------|:-----------------------------------------------------------------------------------------------------------------|-----------|------------------| -| edc.data.encryption.algorithm | Algorithm for encryption and decryption. Must be ether 'AES' or 'NONE'. | | AES | - -## Strategies - -### 1. AES - -The Advanced Encryption Standard (AES) is the default encryption algorithm. For Authenticated Encryption with Associated Data (AEAD) it uses the Galois/Counter Mode or GCM. - -When using AES-GCM the key length must be ether 128-, 196- or 256bit. Keys must be stored stored Base64 encoded in the Vault, separated by a comma. - -It's possible to generate Keys using OpenSSL - -```bash -# 128 Bit -openssl rand -base64 16 - -# 196 Bit -openssl rand -base64 24 - -# 256 Bit -openssl rand -base64 32 -``` - -#### AES Configuration - -| Key | Description | Mandatory | Default | -|:------------------------------------|:----------------------------------------------------------------------------|-----------|---------| -| edc.data.encryption.keys.alias | Symmetric Keys stored in the Vault under the configured alias. | X | | -| edc.data.encryption.caching.enabled | Enable caching to request only keys from the vault after the cache expires. | | false | -| edc.data.encryption.caching.seconds | Duration in seconds until the cache expires. | | 3600 | - -### 2. NONE - -This strategy does apply no encryption at all and should only be used for debugging purposes. Using NONE encryption may leak sensitive data to other connectors! diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/dataplane-selector-configuration/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/dataplane-selector-configuration/README.md deleted file mode 100644 index 7ee61fac523..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/dataplane-selector-configuration/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# Data Plane Selector Configuration Extension - -This control-plane extension makes it possible configure one or more Data Plane Instances. During a transfer the control -plane will look for an instance with matching capabilities to transfer data. - -## Configuration - -Per data plane instance the following settings must be configured. As `` any unique string is valid. - -| Key | Description | Mandatory | Example | -|:------------------------------------------------------------|:--------------------------------------------------|-----------|------------------------------------------------------------------| -| edc.dataplane.selector.````.url | URL to connect to the Data Plane Instance. | X | | -| edc.dataplane.selector.````.sourcetypes | Source Types in a comma separated List. | X | HttpData | -| edc.dataplane.selector.````.destinationtypes | Destination Types in a comma separated List. | X | HttpProxy | -| edc.dataplane.selector.````.properties | Additional properties of the Data Plane Instance. | (X) | { "publicApiUrl": "" } | - -The property `publicApiUrl` is mandatory for Data Plane Instances with destination type `HttpProxy`. - -### Helm Example Configuration using environment variables - -```yaml -EDC_DATAPLANE_SELECTOR_PLATOPLANE_URL: http://plato-edc-dataplane:9999/api/dataplane/control -EDC_DATAPLANE_SELECTOR_PLATOPLANE_SOURCETYPES : HttpData -EDC_DATAPLANE_SELECTOR_PLATOPLANE_DESTINATIONTYPES: HttpProxy -EDC_DATAPLANE_SELECTOR_PLATOPLANE_PROPERTIES: >- - { - "publicApiUrl": "http://plato-edc-dataplane:8185/api/public" - } -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/hashicorp-vault/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/hashicorp-vault/README.md deleted file mode 100644 index 7ad555a7e74..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/hashicorp-vault/README.md +++ /dev/null @@ -1,116 +0,0 @@ -# HashiCorp Vault Extension - -## Used Components - -- [Hashicorp Vault](https://www.vaultproject.io/) - ---- - -**Please note:** -Using the HashiCorp vault it is possible to define multiple data entries per secret. Other vaults might allow only one -entry per secret (e.g. Azure Key Vault). - -Therefore, the HashiCorp vault extension **only** checks the '**content**' data entry! Please use this knowledge when -creating secrets the EDC should consume. - ---- - -## Configuration - -| Key | Description | Mandatory | Default | -|:--------------------------------------------|:-----------------------------------------------------------------------------------------------------------------|-----------|------------------| -| edc.vault.hashicorp.url | URL to connect to the HashiCorp Vault | X || | -| edc.vault.hashicorp.token | Value for [Token Authentication](https://www.vaultproject.io/docs/auth/token) with the vault | X || | -| edc.vault.hashicorp.timeout.seconds | Request timeout in seconds when contacting the vault | | `30` | -| edc.vault.hashicorp.health.check.enabled | Enable health checks to ensure vault is initialized, unsealed and active | | `true` | -| edc.vault.hashicorp.health.check.standby.ok | Specifies if a vault in standby is healthy. This is useful when Vault is behind a non-configurable load balancer | | `false` | -| edc.vault.hashicorp.api.secret.path | Path to the [secret api](https://www.vaultproject.io/api-docs/secret/kv/kv-v1) | | `/v1/secret` | -| edc.vault.hashicorp.api.health.check.path | Path to the [health api](https://www.vaultproject.io/api-docs/system/health) | | `/v1/sys/health` | - -## Health Check - -The HashiCorp Vault Extension is able to run health checks. A health check is successful when the vault is _initialized_, _active_ and _unsealed_. Successful health checks are logged with level _FINE_. Unsuccessful health checks will be logged -with level _WARNING_. - ---- - -### Health Checks in Catena-X - -If your project uses the Catena-X HashiCorp Vault please set `edc.vault.hashicorp.health.check.standby.ok` to _true_. Otherwise the health check would fail if the Vault is in standby. - -```plain -# Logs of successful check with standby vault -[2022-08-01 14:48:37] [FINE ] HashiCorp Vault HealthCheck successful. HashicorpVaultHealthResponsePayload(isInitialized=true, isSealed=false, isStandby=true, isPerformanceStandby=false, replicationPerformanceMode=disabled,replicationDrMode=disabled, serverTimeUtc=1659365317, version=1.9.2, clusterName=vault-cluster-4b193c26, clusterId=83fabd45-685d-7f8d-9495-18fab6f50d5e) -``` - ---- - -## Example: Create & Configure DAPS Key - -### Insert DAPS Key into HashiCorp Vault - -```bash -cat << EOF | /bin/vault kv put secret/my-daps-key content=- - -----BEGIN PRIVATE KEY----- - MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQCv+NUvK7ppJPiM - wZPaQQxE745T5pV38O/Mkay5m82nnd5BoMoCdhhRTy3Efy79FhvBfGruFBLLGzsQ - FOEUY53Albeumo2gmpZSKjJR/M2ifK4MTaRniVOWL5mEcZSKPhsItKpxdLaiYfB6 - 8uzqkqNICtmAQRSclYKzLBM9xHLEtxDWCbnzYFCHoOELGi+PTNIFsUnsT3QuKaJ/ - ejb47vdA/EZbwCQdtTyJ6i54jGhZUp0WMwq1Go2uhzJsygPmT2da/ZZZc7BNNEQE - sUSMZSpMH807TG/TunstotrzO4ShhpV4zbJ2FV/VlxH7yuCawmnR84F/KnXs9fUc - RSrQfuYBAgMBAAECggEAO+KjsjTgcG3bhBNQnMLsSP15Y0Yicbn18ZlVvaivGS7Z - d14fwSytY+ZdPfTGaey/L16HCVSdfK9cr0Fbw9OO2P5ajzobnp9dLsMbctlkpbpm - hNtbarzKTF8QkIkSsuUl0BWjt46vpJ1N+Jl5VO7oUFkY4dPEDvG2lAEY3zlekWDm - cQeOC/YgpoW4xfRwPPS6QE0w3Q+H5NfNjfz+mSHeItTlVfTKDRliWQLPWeRZFuXh - FlRFUQnTmEE/9wpIe3Hn7WXJ3fQqcYDzxU7/zwwY9I7bB15SgVHlR0ENDPAD5X8F - MVZ3EcLlqGBy+WvTWALp6pc8YfhW3fiTWyuamXtNrQKBgQDonsIzBKEOOKdKGW0e - uyw79ErmnmzkY5nuMrMxrmTA4WKCfJ/YRRA+4sxiltWsIJ3UkHe3OBCSSCdj79hb - ugb/+UzE70hOdgrct2NUQqbrj3gvsVvU8ZRQgTRMqKpmC0zY7KOMx6NU85z3IvS1 - z5fjszcUv4kLQlldYGSAuqPy+wKBgQDBqIkc8p/wcw7ygo1q/GerNeszfoxiIFp8 - h4RWLVhkwrcXFz30wBlUWuv5/kxU8tmJcmXxe72EmUstd6wvNOAnYwCiile6zQiJ - vsr1axavZnGOtNGUp6DUAsd2iviBl7IZ7kAcqCrQo4ivGhfHmahH3hmg8wuAMjYB - 8f+FSPgaMwKBgQC7W4tMrjDOFIFhJEOIWfcRvvxI7VcFSNelS76aiDzsQVwnfxr7 - hPzFucQmsBgfUBHvMADMWGK4f1cCnh5kGtwidXgIsjVJxLeQ+EAPkLOCzQZfW3l8 - dKshgD9QcxTzpaxal5ZPAEikVqaZQtVYToCmzCTUGETYBbOWitnH+Qut2wKBgQC6 - Y6DcSLUhc0xOotLDxv1sbu/aVxF8nFEbDD+Vxf0Otc4MnmUWPRHj+8KlkVkcZcR0 - IrP1kThd+EDAGS+TG9wmbIY+6tH3S8HM+eJUBWcHGJ1xUZ1p61DC3Y3nDWiTKlLT - 3Fi+fCkBOHSku4Npq/2odh7Kp0JJd4o9oxJg0VNhuwKBgQDSFn7dqFE0Xmwc40Vr - 0wJH8cPWXKGt7KJENpj894buk2DniLD4w2x874dzTjrOFi6fKxEzbBNA9Rq9UPo8 - u9gKvl/IyWmV0c4zFCNMjRwVdnkMEte/lXcJZ67T4FXZByqAZlhrr/v0FD442Z9B - AjWFbUiBCFOo+gpAFcQGrkOQHA== - -----END PRIVATE KEY----- - EOF -``` - -### Configure Key in the EDC - -```bash -EDC_OAUTH_PRIVATE_KEY_ALIAS: my-daps-key -``` - -or - -```bash -edc.oauth.private.key.alias=my-daps-key -``` - -## Example: Catena-X Argo CD Vault Configuration - -```properties -######### -# Vault # -######### - -edc.vault.hashicorp.url=https://vault.demo.catena-x.net -# or even better configure token as k8 secret -edc.vault.hashicorp.token= -edc.vault.hashicorp.api.secret.path=/v1// -edc.vault.hashicorp.health.check.standby.ok=true - -######################## -# E.g. OAuth Extension # -######################## - -# from UI: secret stored in https://vault.demo.catena-x.net/ui/vault/secrets//show/my-daps-key -edc.oauth.private.key.alias=my-daps-key -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/observability-api-customization/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/observability-api-customization/README.md deleted file mode 100644 index 920d76afc2c..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/observability-api-customization/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# Observability API customization - -This extension is a (temporary) replacement for - and a 1:1 stand-in for the EDC `observability-api` module. It exposes -the same endpoints as the upstream module, with one important distinction: users can configure in which HTTP context the -API gets registered, and whether insecure (= unauthenticated) access is allowed. - -## Default behaviour - -If no additional configuration is done, the Observability API is registered into the `"management"` context of EDC. -That means the following configuration values **must be present** - -```properties -web.http.management.port= -web.http.management.path=/some/api/path -``` - -Further, the Observability API is secured with the default `AuthenticationService`, most likely a token-based one. - -## Allowing insecure access - -If the Observability API should be unauthenticated, the following configuration is required: - -```properties -tractusx.api.observability.allow-insecure=true -web.http.observability.port= -web.http.observability.path=/some/api/path -``` - -If the `tractusx.api.observability.allow-insecure=true` is set, then the Observability API will get registered -into the `observability` context, which is unsecured. - -> Disclaimer: allowing unsecured access to APIs is dangerous and a potential security risk! Using authenticated access -> to all APIs is highly recommended. Never expose unsecured APIs to the public! diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/postgresql-migration/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/postgresql-migration/README.md deleted file mode 100644 index 73f94eb56da..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/postgresql-migration/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# Postgresql SQL Migration Extension - -This extension applies SQL migrations to - -* the asset-index -* the contract-definition store -* contract-negotiation store -* policy store -* transfer-process store diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/provision-additional-headers/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/provision-additional-headers/README.md deleted file mode 100644 index 1883f370f27..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-extensions/provision-additional-headers/README.md +++ /dev/null @@ -1,10 +0,0 @@ -# Provision: additional headers - -The goal of this extension is to provide additional headers to the request to the backend service done by the provider -in order to retrieve the data that will be given to the consumer. - -This gives for example the provider backend service the possibility to audit the data requests. - -The following headers are added to the `HttpDataAddress`: - -- `Edc-Contract-Agreement-Id`: the id of the contract agreement diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-tests/cucumber/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-tests/cucumber/README.md deleted file mode 100644 index a1993003e5d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-tests/cucumber/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# Invoke Business-Tests via Maven - -THIS MODULE IS DEPRECATED AND WILL NOT BE MAINTAINED ANYMORE. - -```shell -./gradlew :edc-tests:test -Dcucumber=true -``` - -## Test locally using Act Tool - -> "Think globally, [`act`](https://github.com/nektos/act) locally" - -```shell -act -j business-test -``` - -## Run and debug Business-Tests local within IDE - -Please refer to [run-local documentation in docs](../../docs/development/Run-business-tests-local.md) diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-tests/deployment/omejdn/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-tests/deployment/omejdn/README.md deleted file mode 100644 index f85a948890d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-tests/deployment/omejdn/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# Omejdn DAPS - -This chart deployes an [IDS Omejdn DAPS](https://github.com/Fraunhofer-AISEC/omejdn-server). - -Two Eclipse Dataspace Connectors need to be registered at the same DAPS instance, to be able to talk to each other. Each connector is registered in the DAPS by an unique client ID and a correpsonding client certificate. - -New connectors are configured in the omejdn _values.yaml_. - -In each Eclipse Dataspace Connector configure the following properties to use the DAPS. - -```properties - edc.oauth.client.id= - - edc.oauth.provider.jwks.url="http://:4567/.well-known/jwks.json" - edc.oauth.token.url="http://:4567/token" - - edc.oauth.private.key.alias= - edc.oauth.public.key.alias= - - edc.oauth.provider.audience=idsc:IDS_CONNECTORS_ALL -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-tests/deployment/test-infrastructure/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-tests/deployment/test-infrastructure/README.md deleted file mode 100644 index e927d7bc555..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-tests/deployment/test-infrastructure/README.md +++ /dev/null @@ -1,54 +0,0 @@ -# Supporting Infrastructure Deployment - -The Supporting Infrastructure Deployment creates a complete, independent and already configured EDC test environment. -During the automated business tests, these infrastructure components are deployed together with two connectors (Plato & Sokrates). - -This deployment could also be used as - -- reference setup for teams, that want to create their own connector -- standalone infrastructure to try things out - -This deployment should **never** be used - -- in **any** production or near production environments -- in **any** long living internet facing connector setups - -## Omejdn DAPS - -The Dynamic Attribute Provisioning Service (DAPS) is a component of the IDS Ecosystem. -The Fraunhofer Institute has created a DAPS reference implementation, the Omejdn -DAPS ([link](https://github.com/Fraunhofer-AISEC/omejdn-server)). This deplyoment configures and deployes a instance of -this reference implementation. - -Definition of DAPS from the IDS Reference architecture v3.0: - -> The Identity Provider acts as an agent for the International -> Data Spaces Association. It is responsible for issuing technical identities to parties that have been approved to become -> Participants in the International Data Spaces. The Identity -> Provider is instructed to issue identities based on approved -> roles (e.g., App Store or App Provider). Only if equipped with -> such an identity, an entity is allowed to participate in the International Data Spaces - -Also, please note, that the Omejdn DAPS is meant as research sandbox and should not be used in anq -productive environment. - -> **IMPORTANT:** Omejdn is meant to be a research sandbox in which we can (re)implement standard protocols and -> potentially extend and modify functionality under the hood to support research projects. Use at your own -> risk! ([source](https://github.com/Fraunhofer-AISEC/omejdn-server)) - -## HashiCorp Vault - -The Control- and Data Plane persist confidential in the vault and persist and communicate using only the secret -names. Hence, it is not possible to run a connector without an instance of a vault. - -## PostgreSQL - -This database is used to persist the state of the Control Plane. - -## Setup - -Simply execute the following comment in a shell: - -```shell -helm install infra edc-tests/deployment/src/main/resources/helm/test-infrastructure --update-dependencies -``` diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-tests/e2e-tests/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-tests/e2e-tests/README.md deleted file mode 100644 index f204147c3a4..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-tests/e2e-tests/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# E2E-Tests - -This module contains JUnit tests that spin up multiple runtimes in one JVM. diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-tests/runtime/README.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-tests/runtime/README.md deleted file mode 100644 index 2f9593a7594..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/edc-tests/runtime/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# In-Memory Runtime for Testing Purposes - -This module provides a very small, purely in-mem runtime to execute tests against. Not intended for anything other than testing! diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/pr_etiquette.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/pr_etiquette.md deleted file mode 100644 index 348ebf0002a..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/pr_etiquette.md +++ /dev/null @@ -1,70 +0,0 @@ -# Etiquette for pull requests - -## As an author - -Submitting pull requests in EDC should be done while adhering to a couple of simple rules. - -- Familiarize yourself - with [coding style](styleguide.md), [architectural patterns](docs/development/coding-principles.md) and - other contribution guidelines. -- No surprise PRs please. Before you submit a PR, open a discussion or an issue outlining your planned work and give - people time to comment. It may even be advisable to contact committers using the `@mention` feature. Unsolicited PRs - may get ignored or rejected. -- Create your working branch in your fork of TractusX-EDC, and create the PR against the upstream `main` branch -- Create focused PRs: your work should be focused on one particular feature or bug. Do not create broad-scoped PRs that - solve multiple issues as reviewers may reject those PR bombs outright. -- Provide a clear description and motivation in the PR description in GitHub. This makes the reviewer's life much - easier. It is also helpful to outline the broad changes that were made, e.g. "Changes the schema of XYZ-Entity: - the `age` field changed from `long` to `String`". -- If you introduce new 3rd party dependencies, be sure to note them in the PR description and explain why they are - necessary. -- Stick to the established code style, please refer to the [styleguide document](styleguide.md). -- All tests should be green, especially when your PR is in `"Ready for review"` -- Mark PRs as `"Ready for review"` only when you're prepared to defend your work. By that time you have completed your - work and shouldn't need to push any more commits other than to incorporate review comments. -- Merge conflicts should be resolved by squashing all commits on the PR branch, rebasing onto `main` and - force-pushing. Do this when your PR is ready to review. -- If you require a reviewer's input while it's still in draft, please contact the designated reviewer using - the `@mention` feature and let them know what you'd like them to look at. -- Request a review from one of the committers. Requesting a review from anyone else is still possible, and - sometimes may be advisable, but only committers can merge PRs, so be sure to include them early on. -- Re-request reviews after all remarks have been adopted. This helps reviewers track their work in GitHub. -- If you disagree with a committer's remarks, feel free to object and argue, but if no agreement is reached, you'll have - to either accept the decision or withdraw your PR. -- Be civil and objective. No foul language, insulting or otherwise abusive language will be tolerated. -- The PR titles must follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). - - The title must follow the format as `(): `. - `build`, `chore`, `ci`, `docs`, `feat`, `fix`, `perf`, `refactor`, `revert`, `style`, `test` are allowed for - the ``. - - The length must be kept under 80 characters. - -## As a reviewer - -- Please complete reviews within two business days or delegate to another committer, removing yourself as a reviewer. -- If you have been requested as reviewer, but cannot do the review for any reason (lack of time or expertise in a - particular area, etc.) please comment that in the PR and remove yourself as a reviewer, suggesting a stand-in. - The [code owners document](CODEOWNERS) should help with that. -- Don't be overly pedantic. -- Don't argue basic principles (code style, architectural decisions, etc.) -- Use the `suggestion` feature of GitHub for small/simple changes. -- The following could serve you as a review checklist: - - no unnecessary dependencies in `build.gradle.kts` - - sensible unit tests, prefer unit tests over integration tests wherever possible (test runtime). Also check the - usage of test tags. - - code style - - simplicity and "uncluttered-ness" of the code - - overall focus of the PR -- Don't just wave through any PR. Please take the time to look at them carefully. -- Be civil and objective. No foul language, insulting or otherwise abusive language will be tolerated. The goal is to - _encourage_ contributions. - -## The technical committers (as of April 05, 2023) - -Main committers for the TractusX-EDC project: - -- @paullatzelsperger -- @florianrusch-zf - -Alternatively, the following Tractus-X committers can also step in: - -- @SebastianBezold diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/resources/save_actions_scr.png b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/resources/save_actions_scr.png deleted file mode 100644 index 10ae06cb006..00000000000 Binary files a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/resources/save_actions_scr.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/styleguide.md b/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/styleguide.md deleted file mode 100644 index 695faf91d13..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/kits/tractusx-edc/styleguide.md +++ /dev/null @@ -1,62 +0,0 @@ -# Eclipse Tractus-X EDC Code Style Guide - -In order to maintain a coherent code style throughout the project we ask every contributor to adhere to a few simple -style guidelines. We assume most developers will use at least something like `vim` and therefore have support for -automatic code formatting, we are not going to list the guidelines here. If you absolutely want to take a look, checkout -the [config written in XML](resources/tx-checkstyle-config.xml). - -## Checkstyle configuration - -Checkstyle is a [tool](https://checkstyle.sourceforge.io/) that can statically analyze your source code to check against -a set of given rules. Those rules are formulated in an [XML document](resources/tx-checkstyle-config.xml). Many modern -IDEs have a plugin available for download that runs in the background and does code analysis. - -Our checkstyle config is based off of the [Google Style](https://checkstyle.sourceforge.io/google_style.html) with a few -additional rules such as the naming of constants and Types. - -_Note: currently we do **not** enforce the generation of Javadoc comments, even though documenting code is **highly** -recommended. We might enable this in the future, such that at least interfaces and public methods are commented._ - -## Running Checkstyle - -Checkstyle can be run in different ways: implicitly we run it through the `checkstyle` Gradle Plugin -during `gradle build` or `gradle check`. That will cause the build to fail if any violations are found. But in order to get better -usability and on-the-fly reporting, Checkstyle is also available as IDE plugins for many modern IDEs, and it can run -either on-demand or continuously in the background: - -- [IntelliJ IDEA plugin [recommended]]() -- [Eclipse IDE [recommended]]() - -### Checkstyle as PR validation - -Apart from running Checkstyle locally as IDE plugin, we do run it on -our GitHub Actions pipeline. At this time, Checkstyle will only spew out warnings, but -we may tighten the rules at a future time and without notice. This will result in failing GitHub Action pipelines. Also, -committers might reject PRs due to Checkstyle warnings. - -It is therefore **highly** recommended running Checkstyle locally as well. - -If you **do not wish** to run Checkstyle on you local machine, that's fine, but be prepared to get your PRs rejected -simply because of a naming or formatting error. - -## [Recommended] IntelliJ Code Style Configuration - -If you are using Jetbrains IntelliJ IDEA, we have created a specific code style configuration that will automatically -format your source code according to that style guide. This should eliminate most of the potential Checkstyle violations -right from the get-go. You will need to reformat your code manually or in a pre-commit hook though. - -## [Optional] Intellij SaveActions Plugin - -If you absolutely want to make sure that no piece of ever-so-slightly misformatted code even hits your hard disk, we -advise you to use the [SaveActions plugin](https://plugins.jetbrains.com/plugin/7642-save-actions) for IntelliJ IDEA. It -takes care that your code is always correctly formatted. Unfortunately SaveActions has no export feature, so please just -copy this configuration: - -![SaveActions configuration](resources/save_actions_scr.png) - -## [Optional] Generic `.editorConfig` - -For most other editors and IDEs we've supplied an [.editorConfig](resources/tx-codestyle.editorconfig) file that can be -placed at the appropriate location. The specific location will largely depend on your editor and your OS, please refer -to the -[official documentation](https://editorconfig.org) for details. diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/bpdm/gate.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/bpdm/gate.yaml deleted file mode 100644 index 4b6a1fbd260..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/bpdm/gate.yaml +++ /dev/null @@ -1,3814 +0,0 @@ -openapi: 3.0.1 -info: - title: Business Partner Data Management Gate - description: A gate for a member to share business partner data with CatenaX - version: 4.0.0 -servers: - - url: http://localhost:8081 - description: Generated server url -paths: - /api/catena/input/sites: - get: - tags: - - site-controller - summary: Get page of sites - description: Get page of sites. - operationId: getSites - parameters: - - name: startAfter - in: query - description: Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages. - required: false - schema: - type: string - - name: limit - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 1 - type: string - default: '10' - responses: - '200': - description: The requested page of sites - content: - '*/*': - schema: - $ref: '#/components/schemas/PageStartAfterResponseSiteGateInputResponse' - '400': - description: On malformed pagination request - put: - tags: - - site-controller - summary: Create or update sites. - description: Create or update sites. Updates instead of creating a new site if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of sites in the request is limited to 100 entries. - operationId: upsertSites - requestBody: - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/SiteGateInputRequest' - required: true - responses: - '200': - description: Sites were successfully updated or created - content: - '*/*': - schema: - type: object - '400': - description: On malformed site request - /api/catena/input/legal-entities: - get: - tags: - - legal-entity-controller - summary: Get page of legal entities - description: Get page of legal entities. - operationId: getLegalEntities - parameters: - - name: startAfter - in: query - description: Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages. - required: false - schema: - type: string - - name: limit - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 1 - type: string - default: '10' - responses: - '200': - description: The requested page of legal entities - content: - '*/*': - schema: - $ref: '#/components/schemas/PageStartAfterResponseLegalEntityGateInputResponse' - '400': - description: On malformed pagination request - put: - tags: - - legal-entity-controller - summary: Create or update legal entities. - description: Create or update legal entities. Updates instead of creating a new legal entity if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of legal entities in the request is limited to 100 entries. - operationId: upsertLegalEntities - requestBody: - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/LegalEntityGateInputRequest' - required: true - responses: - '200': - description: Legal entities were successfully updated or created - content: - '*/*': - schema: - type: object - '400': - description: On malformed legal entity request - /api/catena/input/addresses: - get: - tags: - - address-controller - summary: Get page of addresses - description: Get page of addresses. - operationId: getAddresses - parameters: - - name: startAfter - in: query - description: Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages. - required: false - schema: - type: string - - name: limit - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 1 - type: string - default: '10' - responses: - '200': - description: The requested page of addresses - content: - '*/*': - schema: - $ref: '#/components/schemas/PageStartAfterResponseAddressGateInputResponse' - '400': - description: On malformed pagination request - put: - tags: - - address-controller - summary: Create or update addresses. - description: Create or update addresses. Updates instead of creating a new address if an already existing external id is used. The same external id may not occur more than once in a single request. For a single request, the maximum number of addresses in the request is limited to 100 entries. - operationId: upsertAddresses - requestBody: - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/AddressGateInputRequest' - required: true - responses: - '200': - description: Addresses were successfully updated or created - content: - '*/*': - schema: - $ref: '#/components/schemas/Unit' - '400': - description: On malformed address request - /api/catena/output/sites/search: - post: - tags: - - site-controller - summary: Get page of sites - description: Get page of sites. Can optionally be filtered by external ids. - operationId: getSitesOutput - parameters: - - name: startAfter - in: query - description: Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages. - required: false - schema: - type: string - - name: limit - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 1 - type: string - default: '10' - requestBody: - content: - application/json: - schema: - type: array - items: - type: string - responses: - '200': - description: The requested page of sites - content: - '*/*': - schema: - $ref: '#/components/schemas/PageOutputResponseSiteGateOutput' - '400': - description: On malformed pagination request - /api/catena/output/legal-entities/search: - post: - tags: - - legal-entity-controller - summary: Get page of legal entities - description: Get page of legal entities. Can optionally be filtered by external ids. - operationId: getLegalEntitiesOutput - parameters: - - name: startAfter - in: query - description: Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages. - required: false - schema: - type: string - - name: limit - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 1 - type: string - default: '10' - requestBody: - content: - application/json: - schema: - type: array - items: - type: string - responses: - '200': - description: The requested page of legal entities - content: - '*/*': - schema: - $ref: '#/components/schemas/PageOutputResponseLegalEntityGateOutput' - '400': - description: On malformed pagination request - /api/catena/output/addresses/search: - post: - tags: - - address-controller - summary: Get page of addresses - description: Get page of addresses. Can optionally be filtered by external ids. - operationId: getAddressesOutput - parameters: - - name: startAfter - in: query - description: Value used to indicate which page to retrieve. When this value is not provided, the first page is returned.The nextStartAfter value from the response can then be used to request subsequent pages. - required: false - schema: - type: string - - name: limit - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 1 - type: string - default: '10' - requestBody: - content: - application/json: - schema: - type: array - items: - type: string - responses: - '200': - description: The requested page of addresses - content: - '*/*': - schema: - $ref: '#/components/schemas/PageOutputResponseAddressGateOutput' - '400': - description: On malformed pagination request - /api/catena/input/sites/validation: - post: - tags: - - site-controller - summary: Validate a site - description: Determines errors in a site record which keep it from entering the sharing process - operationId: validateSite - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SiteGateInputRequest' - required: true - responses: - '200': - description: A validation response with possible errors - content: - '*/*': - schema: - $ref: '#/components/schemas/ValidationResponse' - '400': - description: On malformed site requests - /api/catena/input/legal-entities/validation: - post: - tags: - - legal-entity-controller - summary: Validate a legal entity - description: Determines errors in a legal entity record which keep it from entering the sharing process - operationId: validateLegalEntity - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/LegalEntityGateInputRequest' - required: true - responses: - '200': - description: A validation response with possible errors - content: - '*/*': - schema: - $ref: '#/components/schemas/ValidationResponse' - '400': - description: On malformed legal entity requests - /api/catena/input/addresses/validation: - post: - tags: - - address-controller - summary: Validate an address partner - description: Determines errors in an address partner record which keep it from entering the sharing process - operationId: validateSite_1 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddressGateInputRequest' - required: true - responses: - '200': - description: A validation response with possible errors - content: - '*/*': - schema: - $ref: '#/components/schemas/ValidationResponse' - '400': - description: On malformed address requests - /api/catena/business-partners/type-match: - post: - tags: - - business-partner-controller - summary: Determine the LSA type of a business partner candidate - description: For one business partner candidate this request determines its likely type of either legal entity, site or address.It is possible that no type could be determined.The candidate needs to contain either a name or an identifier as a minimum requirement. - operationId: determineLsaType - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BusinessPartnerCandidateDto' - required: true - responses: - '200': - description: Records were successfully processed. - content: - '*/*': - schema: - $ref: '#/components/schemas/TypeMatchResponse' - '400': - description: No name and no identifier given, or malformed request - /api/catena/input/sites/{externalId}: - get: - tags: - - site-controller - summary: Get site by external identifier - description: Get site by external identifier. - operationId: getSiteByExternalId - parameters: - - name: externalId - in: path - description: External identifier - required: true - schema: - type: string - responses: - '200': - description: Found site with external identifier - content: - '*/*': - schema: - $ref: '#/components/schemas/SiteGateInputResponse' - '404': - description: No site found under specified external identifier - /api/catena/input/legal-entities/{externalId}: - get: - tags: - - legal-entity-controller - summary: Get legal entity by external identifier - description: Get legal entity by external identifier. - operationId: getLegalEntityByExternalId - parameters: - - name: externalId - in: path - description: External identifier - required: true - schema: - type: string - responses: - '200': - description: Found legal entity with external identifier - content: - '*/*': - schema: - $ref: '#/components/schemas/LegalEntityGateInputResponse' - '404': - description: No legal entity found under specified external identifier - /api/catena/input/addresses/{externalId}: - get: - tags: - - address-controller - summary: Get address by external identifier - description: Get address by external identifier. - operationId: getAddressByExternalId - parameters: - - name: externalId - in: path - description: External identifier - required: true - schema: - type: string - responses: - '200': - description: Found address with external identifier - content: - '*/*': - schema: - $ref: '#/components/schemas/AddressGateInputResponse' - '404': - description: No address found under specified external identifier -components: - schemas: - Address: - type: object - properties: - version: - $ref: '#/components/schemas/AddressVersion' - careOf: - type: string - contexts: - type: array - items: - type: string - country: - type: string - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - administrativeAreas: - type: array - items: - $ref: '#/components/schemas/AdministrativeArea' - postCodes: - type: array - items: - $ref: '#/components/schemas/Postcode' - localities: - type: array - items: - $ref: '#/components/schemas/Locality' - thoroughfares: - type: array - items: - $ref: '#/components/schemas/Thoroughfare' - premises: - type: array - items: - $ref: '#/components/schemas/Premise' - postalDeliveryPoints: - type: array - items: - $ref: '#/components/schemas/PostalDeliveryPoint' - geographicCoordinates: - $ref: '#/components/schemas/GeoCoordinates' - types: - type: array - items: - type: string - enum: - - BRANCH_OFFICE - - CARE_OF - - HEADQUARTER - - LEGAL_ALTERNATIVE - - PO_BOX - - REGISTERED - - REGISTERED_AGENT_MAIL - - REGISTERED_AGENT_PHYSICAL - - VAT_REGISTERED - - UNSPECIFIC - description: Localized address record for a business partner - AddressGateInputRequest: - type: object - properties: - version: - $ref: '#/components/schemas/AddressVersion' - careOf: - type: string - contexts: - type: array - items: - type: string - country: - type: string - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - administrativeAreas: - type: array - items: - $ref: '#/components/schemas/AdministrativeArea' - postCodes: - type: array - items: - $ref: '#/components/schemas/Postcode' - localities: - type: array - items: - $ref: '#/components/schemas/Locality' - thoroughfares: - type: array - items: - $ref: '#/components/schemas/Thoroughfare' - premises: - type: array - items: - $ref: '#/components/schemas/Premise' - postalDeliveryPoints: - type: array - items: - $ref: '#/components/schemas/PostalDeliveryPoint' - geographicCoordinates: - $ref: '#/components/schemas/GeoCoordinates' - types: - type: array - items: - type: string - enum: - - BRANCH_OFFICE - - CARE_OF - - HEADQUARTER - - LEGAL_ALTERNATIVE - - PO_BOX - - REGISTERED - - REGISTERED_AGENT_MAIL - - REGISTERED_AGENT_PHYSICAL - - VAT_REGISTERED - - UNSPECIFIC - externalId: - type: string - legalEntityExternalId: - type: string - siteExternalId: - type: string - bpn: - type: string - description: Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address. - AddressGateInputResponse: - type: object - properties: - version: - $ref: '#/components/schemas/AddressVersion' - careOf: - type: string - contexts: - type: array - items: - type: string - country: - type: string - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - administrativeAreas: - type: array - items: - $ref: '#/components/schemas/AdministrativeArea' - postCodes: - type: array - items: - $ref: '#/components/schemas/Postcode' - localities: - type: array - items: - $ref: '#/components/schemas/Locality' - thoroughfares: - type: array - items: - $ref: '#/components/schemas/Thoroughfare' - premises: - type: array - items: - $ref: '#/components/schemas/Premise' - postalDeliveryPoints: - type: array - items: - $ref: '#/components/schemas/PostalDeliveryPoint' - geographicCoordinates: - $ref: '#/components/schemas/GeoCoordinates' - types: - type: array - items: - type: string - enum: - - BRANCH_OFFICE - - CARE_OF - - HEADQUARTER - - LEGAL_ALTERNATIVE - - PO_BOX - - REGISTERED - - REGISTERED_AGENT_MAIL - - REGISTERED_AGENT_PHYSICAL - - VAT_REGISTERED - - UNSPECIFIC - externalId: - type: string - legalEntityExternalId: - type: string - siteExternalId: - type: string - bpn: - type: string - processStartedAt: - type: string - format: date-time - description: Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address. - AddressGateOutput: - type: object - properties: - bpn: - type: string - version: - $ref: '#/components/schemas/AddressVersionResponse' - careOf: - type: string - contexts: - type: array - items: - type: string - country: - $ref: '#/components/schemas/TypeKeyNameDtoCountryCode' - administrativeAreas: - type: array - items: - $ref: '#/components/schemas/AdministrativeAreaResponse' - postCodes: - type: array - items: - $ref: '#/components/schemas/PostcodeResponse' - localities: - type: array - items: - $ref: '#/components/schemas/LocalityResponse' - thoroughfares: - type: array - items: - $ref: '#/components/schemas/ThoroughfareResponse' - premises: - type: array - items: - $ref: '#/components/schemas/PremiseResponse' - postalDeliveryPoints: - type: array - items: - $ref: '#/components/schemas/PostalDeliveryPointResponse' - geographicCoordinates: - $ref: '#/components/schemas/GeoCoordinates' - types: - type: array - items: - $ref: '#/components/schemas/TypeKeyNameUrlDtoAddressType' - externalId: - type: string - legalEntityBpn: - type: string - siteBpn: - type: string - description: Address with legal entity or site references. Only one of either legal entity or site external id can be set for an address. - AddressResponse: - type: object - properties: - version: - $ref: '#/components/schemas/AddressVersionResponse' - careOf: - type: string - contexts: - type: array - items: - type: string - country: - $ref: '#/components/schemas/TypeKeyNameDtoCountryCode' - administrativeAreas: - type: array - items: - $ref: '#/components/schemas/AdministrativeAreaResponse' - postCodes: - type: array - items: - $ref: '#/components/schemas/PostcodeResponse' - localities: - type: array - items: - $ref: '#/components/schemas/LocalityResponse' - thoroughfares: - type: array - items: - $ref: '#/components/schemas/ThoroughfareResponse' - premises: - type: array - items: - $ref: '#/components/schemas/PremiseResponse' - postalDeliveryPoints: - type: array - items: - $ref: '#/components/schemas/PostalDeliveryPointResponse' - geographicCoordinates: - $ref: '#/components/schemas/GeoCoordinates' - types: - type: array - items: - $ref: '#/components/schemas/TypeKeyNameUrlDtoAddressType' - description: Localized address record of a business partner - AddressVersion: - type: object - properties: - characterSet: - type: string - enum: - - ARABIC - - CHINESE - - CHINESE_TRADITIONAL - - CYRILLIC - - GREEK - - HANGUL_KOREAN - - HEBREW - - HIRAGANA - - KANJI - - KATAKANA - - LATIN - - THAI - - WESTERN_LATIN_STANDARD - - UNDEFINED - language: - type: string - enum: - - undefined - - aa - - ab - - ae - - af - - ak - - am - - an - - ar - - as - - av - - ay - - az - - ba - - be - - bg - - bh - - bi - - bm - - bn - - bo - - br - - bs - - ca - - ce - - ch - - co - - cr - - cs - - cu - - cv - - cy - - da - - de - - dv - - dz - - ee - - el - - en - - eo - - es - - et - - eu - - fa - - ff - - fi - - fj - - fo - - fr - - fy - - ga - - gd - - gl - - gn - - gu - - gv - - ha - - he - - hi - - ho - - hr - - ht - - hu - - hy - - hz - - ia - - id - - ie - - ig - - ii - - ik - - io - - is - - it - - iu - - ja - - jv - - ka - - kg - - ki - - kj - - kk - - kl - - km - - kn - - ko - - kr - - ks - - ku - - kv - - kw - - ky - - la - - lb - - lg - - li - - ln - - lo - - lt - - lu - - lv - - mg - - mh - - mi - - mk - - ml - - mn - - mr - - ms - - mt - - my - - na - - nb - - nd - - ne - - ng - - nl - - nn - - 'no' - - nr - - nv - - ny - - oc - - oj - - om - - or - - os - - pa - - pi - - pl - - ps - - pt - - qu - - rm - - rn - - ro - - ru - - rw - - sa - - sc - - sd - - se - - sg - - si - - sk - - sl - - sm - - sn - - so - - sq - - sr - - ss - - st - - su - - sv - - sw - - ta - - te - - tg - - th - - ti - - tk - - tl - - tn - - to - - tr - - ts - - tt - - tw - - ty - - ug - - uk - - ur - - uz - - ve - - vi - - vo - - wa - - wo - - xh - - yi - - yo - - za - - zh - - zu - description: Localization record for an address - AddressVersionResponse: - type: object - properties: - characterSet: - $ref: '#/components/schemas/TypeKeyNameDtoCharacterSet' - language: - $ref: '#/components/schemas/TypeKeyNameDtoLanguageCode' - description: Localization record of an address - AdministrativeArea: - type: object - properties: - value: - type: string - shortName: - type: string - fipsCode: - type: string - type: - type: string - enum: - - COUNTY - - REGION - - OTHER - description: Areas such as country regions or counties - AdministrativeAreaResponse: - type: object - properties: - value: - type: string - shortName: - type: string - fipsCode: - type: string - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoAdministrativeAreaType' - language: - $ref: '#/components/schemas/TypeKeyNameDtoLanguageCode' - description: Area of an address such as country region or county - BankAccount: - type: object - properties: - trustScores: - type: array - items: - type: number - format: float - currency: - type: string - enum: - - UNDEFINED - - AED - - AFN - - ALL - - AMD - - ANG - - AOA - - ARS - - AUD - - AWG - - AZN - - BAM - - BBD - - BDT - - BGN - - BHD - - BIF - - BMD - - BND - - BOB - - BOV - - BRL - - BSD - - BTN - - BWP - - BYN - - BYR - - BZD - - CAD - - CDF - - CHE - - CHF - - CHW - - CLF - - CLP - - CNY - - COP - - COU - - CRC - - CUC - - CUP - - CVE - - CZK - - DJF - - DKK - - DOP - - DZD - - EGP - - ERN - - ETB - - EUR - - FJD - - FKP - - GBP - - GEL - - GHS - - GIP - - GMD - - GNF - - GTQ - - GYD - - HKD - - HNL - - HRK - - HTG - - HUF - - IDR - - ILS - - INR - - IQD - - IRR - - ISK - - JMD - - JOD - - JPY - - KES - - KGS - - KHR - - KMF - - KPW - - KRW - - KWD - - KYD - - KZT - - LAK - - LBP - - LKR - - LRD - - LSL - - LTL - - LYD - - MAD - - MDL - - MGA - - MKD - - MMK - - MNT - - MOP - - MRO - - MRU - - MUR - - MVR - - MWK - - MXN - - MXV - - MYR - - MZN - - NAD - - NGN - - NIO - - NOK - - NPR - - NZD - - OMR - - PAB - - PEN - - PGK - - PHP - - PKR - - PLN - - PYG - - QAR - - RON - - RSD - - RUB - - RUR - - RWF - - SAR - - SBD - - SCR - - SDG - - SEK - - SGD - - SHP - - SLL - - SOS - - SRD - - SSP - - STD - - STN - - SVC - - SYP - - SZL - - THB - - TJS - - TMT - - TND - - TOP - - TRY - - TTD - - TWD - - TZS - - UAH - - UGX - - USD - - USN - - USS - - UYI - - UYU - - UZS - - VEF - - VES - - VND - - VUV - - WST - - XAF - - XAG - - XAU - - XBA - - XBB - - XBC - - XBD - - XCD - - XDR - - XOF - - XPD - - XPF - - XPT - - XSU - - XTS - - XUA - - XXX - - YER - - ZAR - - ZMW - - ZWL - internationalBankAccountIdentifier: - type: string - internationalBankIdentifier: - type: string - nationalBankAccountIdentifier: - type: string - nationalBankIdentifier: - type: string - description: Bank account record of a business partner - BankAccountResponse: - type: object - properties: - trustScores: - type: array - items: - type: number - format: float - currency: - $ref: '#/components/schemas/TypeKeyNameDtoCurrencyCode' - internationalBankAccountIdentifier: - type: string - internationalBankIdentifier: - type: string - nationalBankAccountIdentifier: - type: string - nationalBankIdentifier: - type: string - description: Bank account record for a business partner - BusinessPartnerCandidateDto: - type: object - properties: - identifiers: - type: array - items: - $ref: '#/components/schemas/Identifier' - names: - type: array - items: - $ref: '#/components/schemas/Name' - legalForm: - type: string - status: - $ref: '#/components/schemas/BusinessStatus' - profileClassifications: - type: array - items: - $ref: '#/components/schemas/Classification' - bankAccounts: - type: array - items: - $ref: '#/components/schemas/BankAccount' - address: - $ref: '#/components/schemas/Address' - BusinessStatus: - type: object - properties: - officialDenotation: - type: string - validFrom: - type: string - format: date-time - validUntil: - type: string - format: date-time - type: - type: string - enum: - - ACTIVE - - DISSOLVED - - IN_LIQUIDATION - - INACTIVE - - INSOLVENCY - - UNKNOWN - description: Status record for a business partner - BusinessStatusResponse: - type: object - properties: - officialDenotation: - type: string - validFrom: - type: string - format: date-time - validUntil: - type: string - format: date-time - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoBusinessStatusType' - description: Status of a business partner - Classification: - type: object - properties: - value: - type: string - code: - type: string - type: - type: string - enum: - - NACE - - NAF - - NAICS - - SIC - description: Classification record for a business partner - ClassificationResponse: - type: object - properties: - value: - type: string - code: - type: string - type: - $ref: '#/components/schemas/NamedTypeWithLink' - description: Classification record of a business partner - ErrorInfoBusinessPartnerOutputError: - title: ErrorInfo - type: object - properties: - errorCode: - type: string - description: BusinessPartnerOutputError - enum: - - SharingProcessError - - SharingTimeout - - BpnNotInPool - message: - type: string - entityKey: - type: string - description: Holds information about failures - GeoCoordinates: - type: object - properties: - longitude: - type: number - format: float - latitude: - type: number - format: float - altitude: - type: number - format: float - description: Geo coordinates record for an address - Identifier: - type: object - properties: - value: - type: string - type: - type: string - issuingBody: - type: string - status: - type: string - description: Identifier record for a business partner - IdentifierResponse: - type: object - properties: - value: - type: string - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoString' - issuingBody: - $ref: '#/components/schemas/TypeKeyNameUrlDtoString' - status: - $ref: '#/components/schemas/TypeKeyNameDtoString' - description: Identifier record of a business partner - LegalEntityGateInputRequest: - type: object - properties: - identifiers: - type: array - items: - $ref: '#/components/schemas/Identifier' - names: - type: array - items: - $ref: '#/components/schemas/Name' - legalForm: - type: string - status: - $ref: '#/components/schemas/BusinessStatus' - profileClassifications: - type: array - items: - $ref: '#/components/schemas/Classification' - types: - type: array - items: - type: string - enum: - - BRAND - - LEGAL_ENTITY - - ORGANIZATIONAL_UNIT - - SITE - - UNKNOWN - bankAccounts: - type: array - items: - $ref: '#/components/schemas/BankAccount' - legalAddress: - $ref: '#/components/schemas/Address' - externalId: - type: string - bpn: - type: string - description: Legal entity with external id - LegalEntityGateInputResponse: - type: object - properties: - identifiers: - type: array - items: - $ref: '#/components/schemas/Identifier' - names: - type: array - items: - $ref: '#/components/schemas/Name' - legalForm: - type: string - status: - $ref: '#/components/schemas/BusinessStatus' - profileClassifications: - type: array - items: - $ref: '#/components/schemas/Classification' - types: - type: array - items: - type: string - enum: - - BRAND - - LEGAL_ENTITY - - ORGANIZATIONAL_UNIT - - SITE - - UNKNOWN - bankAccounts: - type: array - items: - $ref: '#/components/schemas/BankAccount' - legalAddress: - $ref: '#/components/schemas/Address' - externalId: - type: string - bpn: - type: string - processStartedAt: - type: string - format: date-time - description: Legal entity with external id - LegalEntityGateOutput: - type: object - properties: - identifiers: - type: array - items: - $ref: '#/components/schemas/IdentifierResponse' - names: - type: array - items: - $ref: '#/components/schemas/NameResponse' - legalForm: - $ref: '#/components/schemas/LegalFormResponse' - status: - $ref: '#/components/schemas/BusinessStatusResponse' - profileClassifications: - type: array - items: - $ref: '#/components/schemas/ClassificationResponse' - types: - type: array - items: - $ref: '#/components/schemas/TypeKeyNameUrlDtoBusinessPartnerType' - bankAccounts: - type: array - items: - $ref: '#/components/schemas/BankAccountResponse' - roles: - type: array - items: - $ref: '#/components/schemas/TypeKeyNameDtoString' - relations: - type: array - items: - $ref: '#/components/schemas/RelationResponse' - legalAddress: - $ref: '#/components/schemas/AddressResponse' - bpn: - type: string - externalId: - type: string - description: Legal entity with references - LegalFormResponse: - type: object - properties: - technicalKey: - type: string - name: - type: string - url: - type: string - mainAbbreviation: - type: string - language: - $ref: '#/components/schemas/TypeKeyNameDtoLanguageCode' - categories: - type: array - items: - $ref: '#/components/schemas/NamedTypeWithLink' - description: Legal form a business partner can have - Locality: - type: object - properties: - value: - type: string - shortName: - type: string - type: - type: string - enum: - - BLOCK - - CITY - - DISTRICT - - OTHER - - POST_OFFICE_CITY - - QUARTER - description: Locality record for an address such as city, block or district - LocalityResponse: - type: object - properties: - value: - type: string - shortName: - type: string - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoLocalityType' - language: - $ref: '#/components/schemas/TypeKeyNameDtoLanguageCode' - description: Locality record of an address such as city, block or district - Name: - type: object - properties: - value: - type: string - shortName: - type: string - type: - type: string - enum: - - ACRONYM - - DOING_BUSINESS_AS - - ESTABLISHMENT - - INTERNATIONAL - - LOCAL - - OTHER - - REGISTERED - - TRANSLITERATED - - VAT_REGISTERED - language: - type: string - enum: - - undefined - - aa - - ab - - ae - - af - - ak - - am - - an - - ar - - as - - av - - ay - - az - - ba - - be - - bg - - bh - - bi - - bm - - bn - - bo - - br - - bs - - ca - - ce - - ch - - co - - cr - - cs - - cu - - cv - - cy - - da - - de - - dv - - dz - - ee - - el - - en - - eo - - es - - et - - eu - - fa - - ff - - fi - - fj - - fo - - fr - - fy - - ga - - gd - - gl - - gn - - gu - - gv - - ha - - he - - hi - - ho - - hr - - ht - - hu - - hy - - hz - - ia - - id - - ie - - ig - - ii - - ik - - io - - is - - it - - iu - - ja - - jv - - ka - - kg - - ki - - kj - - kk - - kl - - km - - kn - - ko - - kr - - ks - - ku - - kv - - kw - - ky - - la - - lb - - lg - - li - - ln - - lo - - lt - - lu - - lv - - mg - - mh - - mi - - mk - - ml - - mn - - mr - - ms - - mt - - my - - na - - nb - - nd - - ne - - ng - - nl - - nn - - 'no' - - nr - - nv - - ny - - oc - - oj - - om - - or - - os - - pa - - pi - - pl - - ps - - pt - - qu - - rm - - rn - - ro - - ru - - rw - - sa - - sc - - sd - - se - - sg - - si - - sk - - sl - - sm - - sn - - so - - sq - - sr - - ss - - st - - su - - sv - - sw - - ta - - te - - tg - - th - - ti - - tk - - tl - - tn - - to - - tr - - ts - - tt - - tw - - ty - - ug - - uk - - ur - - uz - - ve - - vi - - vo - - wa - - wo - - xh - - yi - - yo - - za - - zh - - zu - description: Name record for a business partner - NameResponse: - type: object - properties: - value: - type: string - shortName: - type: string - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoNameType' - language: - $ref: '#/components/schemas/TypeKeyNameDtoLanguageCode' - description: Name record of a business partner - NamedTypeWithLink: - type: object - properties: - name: - type: string - url: - type: string - description: General type with name and URL link for further information - PageOutputResponseAddressGateOutput: - type: object - properties: - total: - type: integer - format: int32 - nextStartAfter: - type: string - content: - type: array - items: - $ref: '#/components/schemas/AddressGateOutput' - invalidEntries: - type: integer - format: int32 - pending: - type: array - items: - type: string - errors: - type: array - items: - $ref: '#/components/schemas/ErrorInfoBusinessPartnerOutputError' - description: Paginated collection of results - PageOutputResponseLegalEntityGateOutput: - type: object - properties: - total: - type: integer - format: int32 - nextStartAfter: - type: string - content: - type: array - items: - $ref: '#/components/schemas/LegalEntityGateOutput' - invalidEntries: - type: integer - format: int32 - pending: - type: array - items: - type: string - errors: - type: array - items: - $ref: '#/components/schemas/ErrorInfoBusinessPartnerOutputError' - description: Paginated collection of results - PageOutputResponseSiteGateOutput: - type: object - properties: - total: - type: integer - format: int32 - nextStartAfter: - type: string - content: - type: array - items: - $ref: '#/components/schemas/SiteGateOutput' - invalidEntries: - type: integer - format: int32 - pending: - type: array - items: - type: string - errors: - type: array - items: - $ref: '#/components/schemas/ErrorInfoBusinessPartnerOutputError' - description: Paginated collection of results - PageStartAfterResponseAddressGateInputResponse: - type: object - properties: - total: - type: integer - format: int32 - nextStartAfter: - type: string - content: - type: array - items: - $ref: '#/components/schemas/AddressGateInputResponse' - invalidEntries: - type: integer - format: int32 - description: Paginated collection of results - PageStartAfterResponseLegalEntityGateInputResponse: - type: object - properties: - total: - type: integer - format: int32 - nextStartAfter: - type: string - content: - type: array - items: - $ref: '#/components/schemas/LegalEntityGateInputResponse' - invalidEntries: - type: integer - format: int32 - description: Paginated collection of results - PageStartAfterResponseSiteGateInputResponse: - type: object - properties: - total: - type: integer - format: int32 - nextStartAfter: - type: string - content: - type: array - items: - $ref: '#/components/schemas/SiteGateInputResponse' - invalidEntries: - type: integer - format: int32 - description: Paginated collection of results - PostalDeliveryPoint: - type: object - properties: - value: - type: string - shortName: - type: string - number: - type: string - type: - type: string - enum: - - INTERURBAN_DELIVERY_POINT - - MAIL_STATION - - MAILBOX - - OTHER - - POST_OFFICE_BOX - description: Postal delivery point record for an address - PostalDeliveryPointResponse: - type: object - properties: - value: - type: string - shortName: - type: string - number: - type: string - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoPostalDeliveryPointType' - language: - $ref: '#/components/schemas/TypeKeyNameDtoLanguageCode' - description: Postal delivery point record of an address - Postcode: - type: object - properties: - value: - type: string - type: - type: string - enum: - - CEDEX - - LARGE_MAIL_USER - - OTHER - - POST_BOX - - REGULAR - description: Postcode record for an address - PostcodeResponse: - type: object - properties: - value: - type: string - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoPostCodeType' - description: Postcode record of an address - Premise: - type: object - properties: - value: - type: string - shortName: - type: string - number: - type: string - type: - type: string - enum: - - BUILDING - - OTHER - - LEVEL - - HARBOUR - - ROOM - - SUITE - - UNIT - - WAREHOUSE - description: Premise record for an address such as building, room or floor - PremiseResponse: - type: object - properties: - value: - type: string - shortName: - type: string - number: - type: string - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoPremiseType' - language: - $ref: '#/components/schemas/TypeKeyNameDtoLanguageCode' - description: Premise record of an address such as building, room or floor - RelationResponse: - type: object - properties: - relationClass: - $ref: '#/components/schemas/TypeKeyNameDtoRelationClass' - type: - $ref: '#/components/schemas/TypeKeyNameDtoRelationType' - startNode: - type: string - endNode: - type: string - startedAt: - type: string - format: date-time - endedAt: - type: string - format: date-time - description: Directed relation between two business partners - SiteGateInputRequest: - type: object - properties: - name: - type: string - mainAddress: - $ref: '#/components/schemas/Address' - externalId: - type: string - legalEntityExternalId: - type: string - bpn: - type: string - description: Site with legal entity reference - SiteGateInputResponse: - type: object - properties: - name: - type: string - mainAddress: - $ref: '#/components/schemas/Address' - externalId: - type: string - legalEntityExternalId: - type: string - bpn: - type: string - processStartedAt: - type: string - format: date-time - description: Site with legal entity reference - SiteGateOutput: - type: object - properties: - name: - type: string - mainAddress: - $ref: '#/components/schemas/AddressResponse' - externalId: - type: string - bpn: - type: string - legalEntityBpn: - type: string - description: Site with legal entity reference. - Thoroughfare: - type: object - properties: - value: - type: string - name: - type: string - shortName: - type: string - number: - type: string - direction: - type: string - type: - type: string - enum: - - INDUSTRIAL_ZONE - - OTHER - - RIVER - - SQUARE - - STREET - description: Thoroughfare record for an address such as street, square or industrial zone - ThoroughfareResponse: - type: object - properties: - value: - type: string - name: - type: string - shortName: - type: string - number: - type: string - direction: - type: string - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoThoroughfareType' - language: - $ref: '#/components/schemas/TypeKeyNameDtoLanguageCode' - description: Thoroughfare record of an address such as street, square or industrial zone - TypeKeyNameDtoCharacterSet: - type: object - properties: - technicalKey: - type: string - enum: - - ARABIC - - CHINESE - - CHINESE_TRADITIONAL - - CYRILLIC - - GREEK - - HANGUL_KOREAN - - HEBREW - - HIRAGANA - - KANJI - - KATAKANA - - LATIN - - THAI - - WESTERN_LATIN_STANDARD - - UNDEFINED - name: - type: string - description: Named type uniquely identified by its technical key - TypeKeyNameDtoCountryCode: - type: object - properties: - technicalKey: - type: string - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - name: - type: string - description: Named type uniquely identified by its technical key - TypeKeyNameDtoCurrencyCode: - type: object - properties: - technicalKey: - type: string - enum: - - UNDEFINED - - AED - - AFN - - ALL - - AMD - - ANG - - AOA - - ARS - - AUD - - AWG - - AZN - - BAM - - BBD - - BDT - - BGN - - BHD - - BIF - - BMD - - BND - - BOB - - BOV - - BRL - - BSD - - BTN - - BWP - - BYN - - BYR - - BZD - - CAD - - CDF - - CHE - - CHF - - CHW - - CLF - - CLP - - CNY - - COP - - COU - - CRC - - CUC - - CUP - - CVE - - CZK - - DJF - - DKK - - DOP - - DZD - - EGP - - ERN - - ETB - - EUR - - FJD - - FKP - - GBP - - GEL - - GHS - - GIP - - GMD - - GNF - - GTQ - - GYD - - HKD - - HNL - - HRK - - HTG - - HUF - - IDR - - ILS - - INR - - IQD - - IRR - - ISK - - JMD - - JOD - - JPY - - KES - - KGS - - KHR - - KMF - - KPW - - KRW - - KWD - - KYD - - KZT - - LAK - - LBP - - LKR - - LRD - - LSL - - LTL - - LYD - - MAD - - MDL - - MGA - - MKD - - MMK - - MNT - - MOP - - MRO - - MRU - - MUR - - MVR - - MWK - - MXN - - MXV - - MYR - - MZN - - NAD - - NGN - - NIO - - NOK - - NPR - - NZD - - OMR - - PAB - - PEN - - PGK - - PHP - - PKR - - PLN - - PYG - - QAR - - RON - - RSD - - RUB - - RUR - - RWF - - SAR - - SBD - - SCR - - SDG - - SEK - - SGD - - SHP - - SLL - - SOS - - SRD - - SSP - - STD - - STN - - SVC - - SYP - - SZL - - THB - - TJS - - TMT - - TND - - TOP - - TRY - - TTD - - TWD - - TZS - - UAH - - UGX - - USD - - USN - - USS - - UYI - - UYU - - UZS - - VEF - - VES - - VND - - VUV - - WST - - XAF - - XAG - - XAU - - XBA - - XBB - - XBC - - XBD - - XCD - - XDR - - XOF - - XPD - - XPF - - XPT - - XSU - - XTS - - XUA - - XXX - - YER - - ZAR - - ZMW - - ZWL - name: - type: string - description: Named type uniquely identified by its technical key - TypeKeyNameDtoLanguageCode: - type: object - properties: - technicalKey: - type: string - enum: - - undefined - - aa - - ab - - ae - - af - - ak - - am - - an - - ar - - as - - av - - ay - - az - - ba - - be - - bg - - bh - - bi - - bm - - bn - - bo - - br - - bs - - ca - - ce - - ch - - co - - cr - - cs - - cu - - cv - - cy - - da - - de - - dv - - dz - - ee - - el - - en - - eo - - es - - et - - eu - - fa - - ff - - fi - - fj - - fo - - fr - - fy - - ga - - gd - - gl - - gn - - gu - - gv - - ha - - he - - hi - - ho - - hr - - ht - - hu - - hy - - hz - - ia - - id - - ie - - ig - - ii - - ik - - io - - is - - it - - iu - - ja - - jv - - ka - - kg - - ki - - kj - - kk - - kl - - km - - kn - - ko - - kr - - ks - - ku - - kv - - kw - - ky - - la - - lb - - lg - - li - - ln - - lo - - lt - - lu - - lv - - mg - - mh - - mi - - mk - - ml - - mn - - mr - - ms - - mt - - my - - na - - nb - - nd - - ne - - ng - - nl - - nn - - 'no' - - nr - - nv - - ny - - oc - - oj - - om - - or - - os - - pa - - pi - - pl - - ps - - pt - - qu - - rm - - rn - - ro - - ru - - rw - - sa - - sc - - sd - - se - - sg - - si - - sk - - sl - - sm - - sn - - so - - sq - - sr - - ss - - st - - su - - sv - - sw - - ta - - te - - tg - - th - - ti - - tk - - tl - - tn - - to - - tr - - ts - - tt - - tw - - ty - - ug - - uk - - ur - - uz - - ve - - vi - - vo - - wa - - wo - - xh - - yi - - yo - - za - - zh - - zu - name: - type: string - description: Named type uniquely identified by its technical key - TypeKeyNameDtoRelationClass: - type: object - properties: - technicalKey: - type: string - enum: - - SAAS_HIERARCHY - - SAAS_TRANSITION - - CX_HIERARCHY - - DNB_HIERARCHY - - LEI_HIERARCHY - name: - type: string - description: Named type uniquely identified by its technical key - TypeKeyNameDtoRelationType: - type: object - properties: - technicalKey: - type: string - enum: - - CX_LEGAL_SUCCESSOR_OF - - CX_LEGAL_PREDECESSOR_OF - - CX_ADDRESS_OF - - CX_SITE_OF - - CX_OWNED_BY - - DIRECT_LEGAL_RELATION - - COMMERCIAL_ULTIMATE - - DOMESTIC_BRANCH_RELATION - - INTERNATIONAL_BRANCH_RELATION - - DOMESTIC_LEGAL_ULTIMATE_RELATION - - GLOBAL_LEGAL_ULTIMATE_RELATION - - LEGAL_PREDECESSOR - - LEGAL_SUCCESSOR - - DNB_PARENT - - DNB_HEADQUARTER - - DNB_DOMESTIC_ULTIMATE - - DNB_GLOBAL_ULTIMATE - - LEI_DIRECT_PARENT - - LEI_INTERNATIONAL_BRANCH - - LEI_ULTIMATE_PARENT - name: - type: string - description: Named type uniquely identified by its technical key - TypeKeyNameDtoString: - type: object - properties: - technicalKey: - type: string - name: - type: string - description: Named type uniquely identified by its technical key - TypeKeyNameUrlDtoAddressType: - type: object - properties: - technicalKey: - type: string - enum: - - BRANCH_OFFICE - - CARE_OF - - HEADQUARTER - - LEGAL_ALTERNATIVE - - PO_BOX - - REGISTERED - - REGISTERED_AGENT_MAIL - - REGISTERED_AGENT_PHYSICAL - - VAT_REGISTERED - - UNSPECIFIC - name: - type: string - url: - type: string - TypeKeyNameUrlDtoAdministrativeAreaType: - type: object - properties: - technicalKey: - type: string - enum: - - COUNTY - - REGION - - OTHER - name: - type: string - url: - type: string - TypeKeyNameUrlDtoBusinessPartnerType: - type: object - properties: - technicalKey: - type: string - enum: - - BRAND - - LEGAL_ENTITY - - ORGANIZATIONAL_UNIT - - SITE - - UNKNOWN - name: - type: string - url: - type: string - TypeKeyNameUrlDtoBusinessStatusType: - type: object - properties: - technicalKey: - type: string - enum: - - ACTIVE - - DISSOLVED - - IN_LIQUIDATION - - INACTIVE - - INSOLVENCY - - UNKNOWN - name: - type: string - url: - type: string - TypeKeyNameUrlDtoLocalityType: - type: object - properties: - technicalKey: - type: string - enum: - - BLOCK - - CITY - - DISTRICT - - OTHER - - POST_OFFICE_CITY - - QUARTER - name: - type: string - url: - type: string - TypeKeyNameUrlDtoNameType: - type: object - properties: - technicalKey: - type: string - enum: - - ACRONYM - - DOING_BUSINESS_AS - - ESTABLISHMENT - - INTERNATIONAL - - LOCAL - - OTHER - - REGISTERED - - TRANSLITERATED - - VAT_REGISTERED - name: - type: string - url: - type: string - TypeKeyNameUrlDtoPostCodeType: - type: object - properties: - technicalKey: - type: string - enum: - - CEDEX - - LARGE_MAIL_USER - - OTHER - - POST_BOX - - REGULAR - name: - type: string - url: - type: string - TypeKeyNameUrlDtoPostalDeliveryPointType: - type: object - properties: - technicalKey: - type: string - enum: - - INTERURBAN_DELIVERY_POINT - - MAIL_STATION - - MAILBOX - - OTHER - - POST_OFFICE_BOX - name: - type: string - url: - type: string - TypeKeyNameUrlDtoPremiseType: - type: object - properties: - technicalKey: - type: string - enum: - - BUILDING - - OTHER - - LEVEL - - HARBOUR - - ROOM - - SUITE - - UNIT - - WAREHOUSE - name: - type: string - url: - type: string - TypeKeyNameUrlDtoString: - type: object - properties: - technicalKey: - type: string - name: - type: string - url: - type: string - TypeKeyNameUrlDtoThoroughfareType: - type: object - properties: - technicalKey: - type: string - enum: - - INDUSTRIAL_ZONE - - OTHER - - RIVER - - SQUARE - - STREET - name: - type: string - url: - type: string - TypeMatchResponse: - type: object - properties: - score: - type: number - format: float - type: - type: string - enum: - - LegalEntity - - Site - - Address - - None - Unit: - type: object - ValidationResponse: - type: object - properties: - status: - type: string - enum: - - OK - - ERROR - errors: - type: array - items: - type: string - description: Contains overall result of a sharing process validation request \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/bpdm/pool.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/bpdm/pool.yaml deleted file mode 100644 index f2b8a08b12d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/bpdm/pool.yaml +++ /dev/null @@ -1,6812 +0,0 @@ -openapi: 3.0.1 -info: - title: Business Partner Data Management Pool - description: Service that manages and shares business partner data with other CatenaX services - version: 4.0.0 -servers: - - url: http://localhost:8080 - description: Generated server url -paths: - /api/catena/sites: - put: - tags: - - site-controller - summary: Update existing site business partners - description: Update existing business partner records of type site referenced via BPNS. The endpoint expects to receive the full updated record, including values that didn't change. - operationId: updateSite - requestBody: - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/SitePartnerUpdateRequest' - required: true - responses: - '200': - description: The successfully updated records - content: - '*/*': - schema: - type: array - items: - $ref: '#/components/schemas/SitePartnerCreateResponse' - '400': - description: On malformed requests - post: - tags: - - site-controller - summary: Create new site business partners - description: Create new business partners of type site by specifying the BPNL of the legal entity each site belongs to. If the legal entitiy cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. - operationId: createSite - requestBody: - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/SitePartnerCreateRequest' - required: true - responses: - '200': - description: New business partner record successfully created - content: - '*/*': - schema: - type: array - items: - $ref: '#/components/schemas/SitePartnerCreateResponse' - '400': - description: On malformed requests - /api/catena/legal-entities: - get: - tags: - - legal-entity-controller - summary: Get page of legal entity business partners matching the search criteria - description: This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. - operationId: getLegalEntities - parameters: - - name: name - in: query - description: Filter legal entities by name - required: false - schema: - type: string - - name: legalForm - in: query - description: Filter legal entities by legal form name - required: false - schema: - type: string - - name: status - in: query - description: Filter legal entities by status official denotation - required: false - schema: - type: string - - name: classification - in: query - description: Filter legal entities by classification denotation - required: false - schema: - type: string - - name: administrativeArea - in: query - description: Filter business partners by administrative area name - required: false - schema: - type: string - - name: postCode - in: query - description: Filter business partners by postcode or postcodes - required: false - schema: - type: string - - name: locality - in: query - description: Filter business partners by locality full denotation - required: false - schema: - type: string - - name: thoroughfare - in: query - description: Filter business partners by thoroughfare full denotation - required: false - schema: - type: string - - name: premise - in: query - description: Filter business partners by premise full denotation - required: false - schema: - type: string - - name: postalDeliveryPoint - in: query - description: Filter business partners by postal delivery point full denotation - required: false - schema: - type: string - - name: siteName - in: query - description: Filter sites by name - required: false - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Page of business partners matching the search criteria, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseLegalEntityMatchResponse' - '400': - description: On malformed search or pagination request - put: - tags: - - legal-entity-controller - summary: Update existing legal entity business partners - description: Update existing business partner records of type legal entity referenced via BPNL. The endpoint expects to receive the full updated record, including values that didn't change. - operationId: updateBusinessPartners - requestBody: - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/LegalEntityUpdateRequest' - required: true - responses: - '200': - description: The successfully updated records - content: - '*/*': - schema: - type: array - items: - $ref: '#/components/schemas/LegalEntityPartnerCreateResponse' - '400': - description: On malformed requests - '404': - description: Metadata referenced by technical key not found - post: - tags: - - legal-entity-controller - summary: Create new legal entity business partners - description: Create new business partners of type legal entity. The given additional identifiers of a record need to be unique, otherwise they are ignored. For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. - operationId: createBusinessPartners - requestBody: - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/LegalEntityPartnerCreateRequest' - required: true - responses: - '200': - description: New business partner record successfully created - content: - '*/*': - schema: - type: array - items: - $ref: '#/components/schemas/LegalEntityPartnerCreateResponse' - '400': - description: On malformed requests - '404': - description: Metadata referenced by technical key not found - /api/catena/addresses: - get: - tags: - - address-controller - summary: Get page of addresses matching the search criteria - description: This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. - operationId: getAddresses_1 - parameters: - - name: administrativeArea - in: query - description: Filter business partners by administrative area name - required: false - schema: - type: string - - name: postCode - in: query - description: Filter business partners by postcode or postcodes - required: false - schema: - type: string - - name: locality - in: query - description: Filter business partners by locality full denotation - required: false - schema: - type: string - - name: thoroughfare - in: query - description: Filter business partners by thoroughfare full denotation - required: false - schema: - type: string - - name: premise - in: query - description: Filter business partners by premise full denotation - required: false - schema: - type: string - - name: postalDeliveryPoint - in: query - description: Filter business partners by postal delivery point full denotation - required: false - schema: - type: string - - name: countryCode - in: query - description: Filter business partners by ISO 3166-1 alpha-2 country code - required: false - schema: - type: string - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Page of addresses matching the search criteria, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseAddressMatchResponse' - '400': - description: On malformed search or pagination request - put: - tags: - - address-controller - summary: Update existing address business partners - description: Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change. - operationId: updateAddresses - requestBody: - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/AddressPartnerUpdateRequest' - required: true - responses: - '200': - description: The successfully updated records - content: - '*/*': - schema: - type: array - items: - $ref: '#/components/schemas/AddressPartnerResponse' - '400': - description: On malformed requests - post: - tags: - - address-controller - summary: Create new address business partners - description: Create new business partners of type address by specifying the BPN of the parent each address belongs to. A parent can be either a site or legal entity business partner. If the parent cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. - operationId: createAddresses - requestBody: - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/AddressPartnerCreateRequest' - required: true - responses: - '200': - description: New business partner record successfully created - content: - '*/*': - schema: - type: array - items: - $ref: '#/components/schemas/AddressPartnerCreateResponse' - '400': - description: On malformed requests - /api/saas/business-partner/sync: - get: - tags: - - saas-controller - summary: Fetch information about the SaaS synchronization - description: Fetch information about the latest import (either ongoing or already finished) - operationId: getSyncStatus - responses: - '200': - description: Import information found - content: - '*/*': - schema: - $ref: '#/components/schemas/SyncResponse' - '500': - description: Fetching failed (no connection to database) - post: - tags: - - saas-controller - summary: Import new business partner records from SaaS - description: Triggers an asynchronous import of new business partner records from SaaS. A SaaS record counts as new when it does not have a BPN and the BPDM service does not already have a record with the same SaaS ID. This import only regards records with a modifiedAfter timestamp since the last import. - operationId: importBusinessPartners - responses: - '200': - description: Import successfully started - content: - '*/*': - schema: - $ref: '#/components/schemas/SyncResponse' - '409': - description: Import already running - content: - '*/*': - schema: - $ref: '#/components/schemas/SyncResponse' - '500': - description: Import couldn't start to unexpected error - /api/opensearch/business-partner: - get: - tags: - - open-search-controller - summary: Fetch information about the latest OpenSearch export - description: Fetch information about the latest export (either ongoing or already finished) - operationId: getBusinessPartners - responses: - '200': - description: Export information found - content: - '*/*': - schema: - $ref: '#/components/schemas/SyncResponse' - '500': - description: Fetching failed (no connection to database) - post: - tags: - - open-search-controller - summary: Index new business partner records on OpenSearch - description: 'Triggers an asynchronous export of business partner records from BPDM to OpenSearch. Only exports records which have been updated since the last export. ' - operationId: export - responses: - '200': - description: Export of records successfully - content: - '*/*': - schema: - $ref: '#/components/schemas/SyncResponse' - '500': - description: Export failed (no connection to OpenSearch or database) - delete: - tags: - - open-search-controller - summary: Clear business partner index on OpenSearch - description: Deletes all business partner records in the OpenSearch index. Also resets the timestamp from the last export. - operationId: clear - responses: - '200': - description: Index successfully cleared - '500': - description: Clearing failed (no connection to OpenSearch or database) - /api/catena/sites/search: - post: - tags: - - site-controller - summary: Search site partners by BPNs and/or parent BPNs - description: Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities - operationId: searchSites - parameters: - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SiteBpnSearchRequest' - required: true - responses: - '200': - description: Found sites that belong to specified legal entites - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseSitePartnerSearchResponse' - '400': - description: On malformed request parameters - /api/catena/sites/main-addresses/search: - post: - tags: - - site-controller - summary: Search Main Addresses - description: Search main addresses of site business partners by BPNS - operationId: searchMainAddresses - requestBody: - content: - application/json: - schema: - type: array - items: - type: string - required: true - responses: - '200': - description: The found main addresses - content: - '*/*': - schema: - type: array - items: - $ref: '#/components/schemas/MainAddressSearchResponse' - '400': - description: On malformed request parameters - /api/catena/legal-forms: - get: - tags: - - metadata-controller - summary: Get page of legal forms - description: Lists all currently known legal forms in a paginated result - operationId: getLegalForms - parameters: - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Page of existing legal forms, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseLegalFormResponse' - '400': - description: On malformed request parameters - post: - tags: - - metadata-controller - summary: Create new legal form - description: 'Create a new legal form which can be referenced by business partner records. The actual name of the legal form is free to choose and doesn''t need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.' - operationId: createLegalForm - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/LegalFormRequest' - required: true - responses: - '200': - description: New legal form successfully created - content: - '*/*': - schema: - $ref: '#/components/schemas/LegalFormResponse' - '400': - description: On malformed request parameters - '409': - description: Legal form with specified technical key already exists - /api/catena/legal-entities/{bpn}/confirm-up-to-date: - post: - tags: - - legal-entity-controller - summary: Confirms that the data of a legal entity business partner is still up to date. - description: Confirms that the data of a business partner is still up to date by saving the current timestamp at the time this POST-request is made as this business partner's "currentness". Ignores case of bpn. - operationId: setLegalEntityCurrentness - parameters: - - name: bpn - in: path - description: Bpn value - required: true - schema: - type: string - responses: - '200': - description: Business partner's "currentness" successfully updated - '400': - description: On malformed request parameters - '404': - description: No business partner found for specified bpn - /api/catena/legal-entities/search: - post: - tags: - - legal-entity-controller - summary: Search legal entity partners by BPNLs - description: Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to 5000 entries. - operationId: searchSites_1 - requestBody: - content: - application/json: - schema: - type: array - items: - type: string - required: true - responses: - '200': - description: Found legal entites - content: - '*/*': - schema: - type: array - items: - $ref: '#/components/schemas/LegalEntityPartnerResponse' - '400': - description: On malformed request parameters or if number of requested bpns exceeds limit - /api/catena/legal-entities/legal-addresses/search: - post: - tags: - - legal-entity-controller - summary: Search Legal Addresses - description: Search legal addresses of legal entities by BPNL - operationId: searchLegalAddresses - requestBody: - content: - application/json: - schema: - type: array - items: - type: string - required: true - responses: - '200': - description: The found legal addresses - content: - '*/*': - schema: - type: array - items: - $ref: '#/components/schemas/LegalAddressSearchResponse' - '400': - description: On malformed request parameters - /api/catena/issuing-bodies: - get: - tags: - - metadata-controller - summary: Get page of issuing bodies - description: Lists all currently known issuing bodies in a paginated result - operationId: getIssuingBodies - parameters: - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Page of existing issuing bodies, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseTypeKeyNameUrlDtoString' - '400': - description: On malformed request parameters - post: - tags: - - metadata-controller - summary: Create new issuing body - description: 'Create a new issuing body which can be referenced by business partner records. An issuing body should be an entity which the Catena organisation trusts to issue identifiers.The actual name of the issuing body is free to choose and doesn''t need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.' - operationId: createIssuingBody - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TypeKeyNameUrlDtoString' - required: true - responses: - '200': - description: New issuing body successfully created - content: - '*/*': - schema: - $ref: '#/components/schemas/TypeKeyNameUrlDtoString' - '400': - description: On malformed request parameters - '409': - description: Issuing body with specified technical key already exists - /api/catena/identifier-types: - get: - tags: - - metadata-controller - summary: Get page of identifier types - description: Lists all currently known identifier types in a paginated result - operationId: getIdentifierTypes - parameters: - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Page of existing identifier types, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseTypeKeyNameUrlDtoString' - '400': - description: On malformed request parameters - post: - tags: - - metadata-controller - summary: Create new identifier type - description: 'Create a new identifier type which can be referenced by business partner records. Identifier types such as BPN or VAT determine with which kind of values a business partner can be identified with. The actual name of the identifier type is free to choose and doesn''t need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.' - operationId: createIdentifierType - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TypeKeyNameUrlDtoString' - required: true - responses: - '200': - description: New identifier type successfully created - content: - '*/*': - schema: - $ref: '#/components/schemas/TypeKeyNameUrlDtoString' - '400': - description: On malformed request parameters - '409': - description: Identifier type with specified technical key already exists - /api/catena/identifier-status: - get: - tags: - - metadata-controller - summary: Get page of identifier statuses - description: Lists all currently known identifier statuses in a paginated result - operationId: getIdentifierStati - parameters: - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Page of existing identifier statuses, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseTypeKeyNameDtoString' - '400': - description: On malformed request parameters - post: - tags: - - metadata-controller - summary: Create new identifier status - description: 'Create a new identifier status which can be referenced by business partner records. A status further distinguishes an identifier by adding current status information such as active or revoked.The actual name of the identifier status is free to choose and doesn''t need to be unique. The technical key can be freely chosen but needs to be unique as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.' - operationId: createIdentifierStatus - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TypeKeyNameDtoString' - required: true - responses: - '200': - description: New identifier status successfully created - content: - '*/*': - schema: - $ref: '#/components/schemas/TypeKeyNameDtoString' - '400': - description: On malformed request parameters - '409': - description: Identifier status with specified technical key already exists - /api/catena/bpn/search: - post: - tags: - - bpn-controller - summary: Find business partner numbers by identifiers - description: Find business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to 5000 entries. - operationId: findBpnsByIdentifiers - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/IdentifiersSearchRequest' - required: true - responses: - '200': - description: Found bpn to identifier value mappings - content: - '*/*': - schema: - uniqueItems: true - type: array - items: - $ref: '#/components/schemas/BpnIdentifierMappingResponse' - '400': - description: On malformed request parameters or if number of requested bpns exceeds limit - '404': - description: Specified identifier type not found - /api/catena/addresses/search: - post: - tags: - - address-controller - summary: Search address partners by BPNs and/or parent BPNs - description: Search business partners of type address by their BPN or their parent partners BPN (BPNLs or BPNS). - operationId: searchAddresses - parameters: - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddressPartnerBpnSearchRequest' - required: true - responses: - '200': - description: Found sites for the specified sites and legal entities - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseAddressPartnerSearchResponse' - '400': - description: On malformed pagination request - /api/catena/suggestions/sites/names: - get: - tags: - - suggestion-controller - summary: Find best matches for given text in business partner sites - description: Performs search on site names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible site names in the search set. - operationId: getSiteSuggestion - parameters: - - name: text - in: query - description: Show site names best matching this text - required: false - schema: - type: string - - name: name - in: query - description: Filter legal entities by name - required: false - schema: - type: string - - name: legalForm - in: query - description: Filter legal entities by legal form name - required: false - schema: - type: string - - name: status - in: query - description: Filter legal entities by status official denotation - required: false - schema: - type: string - - name: classification - in: query - description: Filter legal entities by classification denotation - required: false - schema: - type: string - - name: administrativeArea - in: query - description: Filter business partners by administrative area name - required: false - schema: - type: string - - name: postCode - in: query - description: Filter business partners by postcode or postcodes - required: false - schema: - type: string - - name: locality - in: query - description: Filter business partners by locality full denotation - required: false - schema: - type: string - - name: thoroughfare - in: query - description: Filter business partners by thoroughfare full denotation - required: false - schema: - type: string - - name: premise - in: query - description: Filter business partners by premise full denotation - required: false - schema: - type: string - - name: postalDeliveryPoint - in: query - description: Filter business partners by postal delivery point full denotation - required: false - schema: - type: string - - name: siteName - in: query - description: Filter sites by name - required: false - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Best matches found, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseSuggestionResponse' - /api/catena/suggestions/legal-entities/statuses: - get: - tags: - - suggestion-controller - summary: Find best matches for given text in business statuses - description: Performs search on business status denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible business status denotations in the search set. - operationId: getStatusSuggestion - parameters: - - name: text - in: query - description: Show business status denotations best matching this text - required: false - schema: - type: string - - name: name - in: query - description: Filter legal entities by name - required: false - schema: - type: string - - name: legalForm - in: query - description: Filter legal entities by legal form name - required: false - schema: - type: string - - name: status - in: query - description: Filter legal entities by status official denotation - required: false - schema: - type: string - - name: classification - in: query - description: Filter legal entities by classification denotation - required: false - schema: - type: string - - name: administrativeArea - in: query - description: Filter business partners by administrative area name - required: false - schema: - type: string - - name: postCode - in: query - description: Filter business partners by postcode or postcodes - required: false - schema: - type: string - - name: locality - in: query - description: Filter business partners by locality full denotation - required: false - schema: - type: string - - name: thoroughfare - in: query - description: Filter business partners by thoroughfare full denotation - required: false - schema: - type: string - - name: premise - in: query - description: Filter business partners by premise full denotation - required: false - schema: - type: string - - name: postalDeliveryPoint - in: query - description: Filter business partners by postal delivery point full denotation - required: false - schema: - type: string - - name: siteName - in: query - description: Filter sites by name - required: false - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Best matches found, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseSuggestionResponse' - /api/catena/suggestions/legal-entities/names: - get: - tags: - - suggestion-controller - summary: Find best matches for given text in business partner names - description: Performs search on business partner names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible names in the search set. - operationId: getNameSuggestion - parameters: - - name: text - in: query - description: Show names best matching this text - required: false - schema: - type: string - - name: name - in: query - description: Filter legal entities by name - required: false - schema: - type: string - - name: legalForm - in: query - description: Filter legal entities by legal form name - required: false - schema: - type: string - - name: status - in: query - description: Filter legal entities by status official denotation - required: false - schema: - type: string - - name: classification - in: query - description: Filter legal entities by classification denotation - required: false - schema: - type: string - - name: administrativeArea - in: query - description: Filter business partners by administrative area name - required: false - schema: - type: string - - name: postCode - in: query - description: Filter business partners by postcode or postcodes - required: false - schema: - type: string - - name: locality - in: query - description: Filter business partners by locality full denotation - required: false - schema: - type: string - - name: thoroughfare - in: query - description: Filter business partners by thoroughfare full denotation - required: false - schema: - type: string - - name: premise - in: query - description: Filter business partners by premise full denotation - required: false - schema: - type: string - - name: postalDeliveryPoint - in: query - description: Filter business partners by postal delivery point full denotation - required: false - schema: - type: string - - name: siteName - in: query - description: Filter sites by name - required: false - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Best matches found, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseSuggestionResponse' - /api/catena/suggestions/legal-entities/legal-forms: - get: - tags: - - suggestion-controller - summary: Find best matches for given text in business partner legal forms - description: Performs search on legal form names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible legal form names in the search set. - operationId: getLegalFormSuggestion - parameters: - - name: text - in: query - description: Show legal form names best matching this text - required: false - schema: - type: string - - name: name - in: query - description: Filter legal entities by name - required: false - schema: - type: string - - name: legalForm - in: query - description: Filter legal entities by legal form name - required: false - schema: - type: string - - name: status - in: query - description: Filter legal entities by status official denotation - required: false - schema: - type: string - - name: classification - in: query - description: Filter legal entities by classification denotation - required: false - schema: - type: string - - name: administrativeArea - in: query - description: Filter business partners by administrative area name - required: false - schema: - type: string - - name: postCode - in: query - description: Filter business partners by postcode or postcodes - required: false - schema: - type: string - - name: locality - in: query - description: Filter business partners by locality full denotation - required: false - schema: - type: string - - name: thoroughfare - in: query - description: Filter business partners by thoroughfare full denotation - required: false - schema: - type: string - - name: premise - in: query - description: Filter business partners by premise full denotation - required: false - schema: - type: string - - name: postalDeliveryPoint - in: query - description: Filter business partners by postal delivery point full denotation - required: false - schema: - type: string - - name: siteName - in: query - description: Filter sites by name - required: false - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Best matches found, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseSuggestionResponse' - /api/catena/suggestions/legal-entities/classifications: - get: - tags: - - suggestion-controller - summary: Find best matches for given text in business partner classifications - description: Performs search on business partner classifications in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible business partner classifications in the search set. - operationId: getClassificationSuggestion - parameters: - - name: text - in: query - description: Show business partner classifications best matching this text - required: false - schema: - type: string - - name: name - in: query - description: Filter legal entities by name - required: false - schema: - type: string - - name: legalForm - in: query - description: Filter legal entities by legal form name - required: false - schema: - type: string - - name: status - in: query - description: Filter legal entities by status official denotation - required: false - schema: - type: string - - name: classification - in: query - description: Filter legal entities by classification denotation - required: false - schema: - type: string - - name: administrativeArea - in: query - description: Filter business partners by administrative area name - required: false - schema: - type: string - - name: postCode - in: query - description: Filter business partners by postcode or postcodes - required: false - schema: - type: string - - name: locality - in: query - description: Filter business partners by locality full denotation - required: false - schema: - type: string - - name: thoroughfare - in: query - description: Filter business partners by thoroughfare full denotation - required: false - schema: - type: string - - name: premise - in: query - description: Filter business partners by premise full denotation - required: false - schema: - type: string - - name: postalDeliveryPoint - in: query - description: Filter business partners by postal delivery point full denotation - required: false - schema: - type: string - - name: siteName - in: query - description: Filter sites by name - required: false - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Best matches found, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseSuggestionResponse' - /api/catena/suggestions/addresses/thoroughfares: - get: - tags: - - suggestion-controller - summary: Find best matches for given text in thoroughfares - description: Performs search on thoroughfare denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible thoroughfare names in the search set. - operationId: getThoroughfareSuggestion - parameters: - - name: text - in: query - description: Show thoroughfare names best matching this text - required: false - schema: - type: string - - name: name - in: query - description: Filter legal entities by name - required: false - schema: - type: string - - name: legalForm - in: query - description: Filter legal entities by legal form name - required: false - schema: - type: string - - name: status - in: query - description: Filter legal entities by status official denotation - required: false - schema: - type: string - - name: classification - in: query - description: Filter legal entities by classification denotation - required: false - schema: - type: string - - name: administrativeArea - in: query - description: Filter business partners by administrative area name - required: false - schema: - type: string - - name: postCode - in: query - description: Filter business partners by postcode or postcodes - required: false - schema: - type: string - - name: locality - in: query - description: Filter business partners by locality full denotation - required: false - schema: - type: string - - name: thoroughfare - in: query - description: Filter business partners by thoroughfare full denotation - required: false - schema: - type: string - - name: premise - in: query - description: Filter business partners by premise full denotation - required: false - schema: - type: string - - name: postalDeliveryPoint - in: query - description: Filter business partners by postal delivery point full denotation - required: false - schema: - type: string - - name: siteName - in: query - description: Filter sites by name - required: false - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Best matches found, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseSuggestionResponse' - /api/catena/suggestions/addresses/premises: - get: - tags: - - suggestion-controller - summary: Find best matches for given text in premises - description: Performs search on premise denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible premise names in the search set. - operationId: getPremiseSuggestion - parameters: - - name: text - in: query - description: Show premise names best matching this text - required: false - schema: - type: string - - name: name - in: query - description: Filter legal entities by name - required: false - schema: - type: string - - name: legalForm - in: query - description: Filter legal entities by legal form name - required: false - schema: - type: string - - name: status - in: query - description: Filter legal entities by status official denotation - required: false - schema: - type: string - - name: classification - in: query - description: Filter legal entities by classification denotation - required: false - schema: - type: string - - name: administrativeArea - in: query - description: Filter business partners by administrative area name - required: false - schema: - type: string - - name: postCode - in: query - description: Filter business partners by postcode or postcodes - required: false - schema: - type: string - - name: locality - in: query - description: Filter business partners by locality full denotation - required: false - schema: - type: string - - name: thoroughfare - in: query - description: Filter business partners by thoroughfare full denotation - required: false - schema: - type: string - - name: premise - in: query - description: Filter business partners by premise full denotation - required: false - schema: - type: string - - name: postalDeliveryPoint - in: query - description: Filter business partners by postal delivery point full denotation - required: false - schema: - type: string - - name: siteName - in: query - description: Filter sites by name - required: false - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Best matches found, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseSuggestionResponse' - /api/catena/suggestions/addresses/postcodes: - get: - tags: - - suggestion-controller - summary: Find best matches for given text in postcodes - description: Performs search on postcode values in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible postcode values in the search set. - operationId: getPostcodeSuggestion - parameters: - - name: text - in: query - description: Show postcodes best matching this text - required: false - schema: - type: string - - name: name - in: query - description: Filter legal entities by name - required: false - schema: - type: string - - name: legalForm - in: query - description: Filter legal entities by legal form name - required: false - schema: - type: string - - name: status - in: query - description: Filter legal entities by status official denotation - required: false - schema: - type: string - - name: classification - in: query - description: Filter legal entities by classification denotation - required: false - schema: - type: string - - name: administrativeArea - in: query - description: Filter business partners by administrative area name - required: false - schema: - type: string - - name: postCode - in: query - description: Filter business partners by postcode or postcodes - required: false - schema: - type: string - - name: locality - in: query - description: Filter business partners by locality full denotation - required: false - schema: - type: string - - name: thoroughfare - in: query - description: Filter business partners by thoroughfare full denotation - required: false - schema: - type: string - - name: premise - in: query - description: Filter business partners by premise full denotation - required: false - schema: - type: string - - name: postalDeliveryPoint - in: query - description: Filter business partners by postal delivery point full denotation - required: false - schema: - type: string - - name: siteName - in: query - description: Filter sites by name - required: false - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Best matches found, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseSuggestionResponse' - /api/catena/suggestions/addresses/postal-delivery-points: - get: - tags: - - suggestion-controller - summary: Find best matches for given text in postal delivery points - description: Performs search on postal delivery point denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible postal delivery point names in the search set. - operationId: getPostalDeliverPointSuggestion - parameters: - - name: text - in: query - description: Show postal delivery point names best matching this text - required: false - schema: - type: string - - name: name - in: query - description: Filter legal entities by name - required: false - schema: - type: string - - name: legalForm - in: query - description: Filter legal entities by legal form name - required: false - schema: - type: string - - name: status - in: query - description: Filter legal entities by status official denotation - required: false - schema: - type: string - - name: classification - in: query - description: Filter legal entities by classification denotation - required: false - schema: - type: string - - name: administrativeArea - in: query - description: Filter business partners by administrative area name - required: false - schema: - type: string - - name: postCode - in: query - description: Filter business partners by postcode or postcodes - required: false - schema: - type: string - - name: locality - in: query - description: Filter business partners by locality full denotation - required: false - schema: - type: string - - name: thoroughfare - in: query - description: Filter business partners by thoroughfare full denotation - required: false - schema: - type: string - - name: premise - in: query - description: Filter business partners by premise full denotation - required: false - schema: - type: string - - name: postalDeliveryPoint - in: query - description: Filter business partners by postal delivery point full denotation - required: false - schema: - type: string - - name: siteName - in: query - description: Filter sites by name - required: false - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Best matches found, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseSuggestionResponse' - /api/catena/suggestions/addresses/localities: - get: - tags: - - suggestion-controller - summary: Find best matches for given text in localities - description: Performs search on locality denotations in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible locality names in the search set. - operationId: getLocalitySuggestion - parameters: - - name: text - in: query - description: Show locality names this text - required: false - schema: - type: string - - name: name - in: query - description: Filter legal entities by name - required: false - schema: - type: string - - name: legalForm - in: query - description: Filter legal entities by legal form name - required: false - schema: - type: string - - name: status - in: query - description: Filter legal entities by status official denotation - required: false - schema: - type: string - - name: classification - in: query - description: Filter legal entities by classification denotation - required: false - schema: - type: string - - name: administrativeArea - in: query - description: Filter business partners by administrative area name - required: false - schema: - type: string - - name: postCode - in: query - description: Filter business partners by postcode or postcodes - required: false - schema: - type: string - - name: locality - in: query - description: Filter business partners by locality full denotation - required: false - schema: - type: string - - name: thoroughfare - in: query - description: Filter business partners by thoroughfare full denotation - required: false - schema: - type: string - - name: premise - in: query - description: Filter business partners by premise full denotation - required: false - schema: - type: string - - name: postalDeliveryPoint - in: query - description: Filter business partners by postal delivery point full denotation - required: false - schema: - type: string - - name: siteName - in: query - description: Filter sites by name - required: false - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Best matches found, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseSuggestionResponse' - /api/catena/suggestions/addresses/administrative-areas: - get: - tags: - - suggestion-controller - summary: Find best matches for given text in administrative areas - description: Performs search on administrative area names in order to find the best matches for the given text. By specifying further request parameters the set of business partners to search in can be restricted. If no text is given, the endpoint lists possible administrative area names in the search set. - operationId: getAdminAreaSuggestion - parameters: - - name: text - in: query - description: Show administrative area names best matching this text - required: false - schema: - type: string - - name: name - in: query - description: Filter legal entities by name - required: false - schema: - type: string - - name: legalForm - in: query - description: Filter legal entities by legal form name - required: false - schema: - type: string - - name: status - in: query - description: Filter legal entities by status official denotation - required: false - schema: - type: string - - name: classification - in: query - description: Filter legal entities by classification denotation - required: false - schema: - type: string - - name: administrativeArea - in: query - description: Filter business partners by administrative area name - required: false - schema: - type: string - - name: postCode - in: query - description: Filter business partners by postcode or postcodes - required: false - schema: - type: string - - name: locality - in: query - description: Filter business partners by locality full denotation - required: false - schema: - type: string - - name: thoroughfare - in: query - description: Filter business partners by thoroughfare full denotation - required: false - schema: - type: string - - name: premise - in: query - description: Filter business partners by premise full denotation - required: false - schema: - type: string - - name: postalDeliveryPoint - in: query - description: Filter business partners by postal delivery point full denotation - required: false - schema: - type: string - - name: siteName - in: query - description: Filter sites by name - required: false - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Best matches found, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseSuggestionResponse' - /api/catena/sites/{bpn}: - get: - tags: - - site-controller - summary: Get site partners by bpn - description: Get business partners of type site by bpn-s ignoring case. - operationId: getSite - parameters: - - name: bpn - in: path - description: Bpn value - required: true - schema: - type: string - responses: - '200': - description: Found site with specified bpn - content: - '*/*': - schema: - $ref: '#/components/schemas/SitePartnerSearchResponse' - '400': - description: On malformed request parameters - '404': - description: No site found under specified bpn - /api/catena/legal-entities/{idValue}: - get: - tags: - - legal-entity-controller - summary: Get legal entity business partner by identifier - description: This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type. - operationId: getLegalEntity - parameters: - - name: idValue - in: path - description: Identifier value - required: true - schema: - type: string - - name: idType - in: query - description: Type of identifier to use, defaults to BPN when omitted - required: false - schema: - type: string - default: BPN - responses: - '200': - description: Found business partner with specified identifier - content: - '*/*': - schema: - $ref: '#/components/schemas/LegalEntityPartnerResponse' - '400': - description: On malformed request parameters - '404': - description: No business partner found under specified identifier or specified identifier type not found - /api/catena/legal-entities/{bpn}/sites: - get: - tags: - - legal-entity-controller - summary: Get site partners of a legal entity - description: Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpn ignoring case. - operationId: getSites - parameters: - - name: bpn - in: path - description: Bpn value - required: true - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: The sites for the specified bpn - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseSitePartnerResponse' - '400': - description: On malformed pagination request - '404': - description: No business partner found for specified bpn - /api/catena/legal-entities/{bpn}/addresses: - get: - tags: - - legal-entity-controller - summary: Get address partners of a legal entity - description: Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's bpn ignoring case. - operationId: getAddresses - parameters: - - name: bpn - in: path - description: Bpn value - required: true - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: The addresses for the specified bpn - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseAddressPartnerResponse' - '400': - description: On malformed pagination request - '404': - description: No business partner found for specified bpn - /api/catena/identifier-types/for-country: - get: - tags: - - metadata-controller - summary: Get valid identifier types for a country - description: Returns which identifier types are valid and which ones are mandatory for a country specified by its ISO 3166-1 alpha-2 country code. - operationId: getValidIdentifierTypesForCountry - parameters: - - name: country - in: query - required: true - schema: - type: string - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - responses: - '200': - description: The identifier types - content: - '*/*': - schema: - type: array - items: - $ref: '#/components/schemas/CountryIdentifierTypeResponse' - '400': - description: On malformed request parameters - /api/catena/business-partners/{bpn}/changelog: - get: - tags: - - business-partner-controller - summary: Get business partner changelog entries by bpn - description: Get business partner changelog entries by bpn ignoring case. - operationId: getChangelogEntries - parameters: - - name: bpn - in: path - description: Bpn value - required: true - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: The changelog entries for the specified bpn - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseChangelogEntryResponse' - '400': - description: On malformed pagination request - '404': - description: No business partner found for specified bpn - /api/catena/business-partner: - get: - tags: - - business-partner-legacy-controller - summary: Get page of business partners matching the search criteria - description: This endpoint tries to find matches among all existing business partners, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. - operationId: searchBusinessPartners - parameters: - - name: name - in: query - description: Filter legal entities by name - required: false - schema: - type: string - - name: legalForm - in: query - description: Filter legal entities by legal form name - required: false - schema: - type: string - - name: status - in: query - description: Filter legal entities by status official denotation - required: false - schema: - type: string - - name: classification - in: query - description: Filter legal entities by classification denotation - required: false - schema: - type: string - - name: administrativeArea - in: query - description: Filter business partners by administrative area name - required: false - schema: - type: string - - name: postCode - in: query - description: Filter business partners by postcode or postcodes - required: false - schema: - type: string - - name: locality - in: query - description: Filter business partners by locality full denotation - required: false - schema: - type: string - - name: thoroughfare - in: query - description: Filter business partners by thoroughfare full denotation - required: false - schema: - type: string - - name: premise - in: query - description: Filter business partners by premise full denotation - required: false - schema: - type: string - - name: postalDeliveryPoint - in: query - description: Filter business partners by postal delivery point full denotation - required: false - schema: - type: string - - name: siteName - in: query - description: Filter sites by name - required: false - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Page of business partners matching the search criteria, may be empty - content: - '*/*': - schema: - $ref: '#/components/schemas/PageResponseBusinessPartnerMatchResponse' - '400': - description: On malformed search or pagination request - deprecated: true - /api/catena/business-partner/{idValue}: - get: - tags: - - business-partner-legacy-controller - summary: Get business partner by identifier - description: This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type. - operationId: getLegalEntity_1 - parameters: - - name: idValue - in: path - description: Identifier value - required: true - schema: - type: string - - name: idType - in: query - description: Type of identifier to use, defaults to BPN when omitted - required: false - schema: - type: string - default: BPN - responses: - '200': - description: Found business partner with specified identifier - content: - '*/*': - schema: - $ref: '#/components/schemas/BusinessPartnerResponse' - '400': - description: On malformed request parameters - '404': - description: No business partner found under specified identifier or specified identifier type not found - deprecated: true - /api/catena/addresses/{bpn}: - get: - tags: - - address-controller - summary: Get address partners by bpn - description: Get business partners of type address by bpn-a ignoring case. - operationId: getAddress - parameters: - - name: bpn - in: path - description: Bpn value - required: true - schema: - type: string - responses: - '200': - description: Found address with specified bpn - content: - '*/*': - schema: - $ref: '#/components/schemas/AddressPartnerSearchResponse' - '400': - description: On malformed request parameters - '404': - description: No address found under specified bpn -components: - schemas: - Address: - type: object - properties: - version: - $ref: '#/components/schemas/AddressVersion' - careOf: - type: string - contexts: - type: array - items: - type: string - country: - type: string - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - administrativeAreas: - type: array - items: - $ref: '#/components/schemas/AdministrativeArea' - postCodes: - type: array - items: - $ref: '#/components/schemas/Postcode' - localities: - type: array - items: - $ref: '#/components/schemas/Locality' - thoroughfares: - type: array - items: - $ref: '#/components/schemas/Thoroughfare' - premises: - type: array - items: - $ref: '#/components/schemas/Premise' - postalDeliveryPoints: - type: array - items: - $ref: '#/components/schemas/PostalDeliveryPoint' - geographicCoordinates: - $ref: '#/components/schemas/GeoCoordinates' - types: - type: array - items: - type: string - enum: - - BRANCH_OFFICE - - CARE_OF - - HEADQUARTER - - LEGAL_ALTERNATIVE - - PO_BOX - - REGISTERED - - REGISTERED_AGENT_MAIL - - REGISTERED_AGENT_PHYSICAL - - VAT_REGISTERED - - UNSPECIFIC - description: Localized address record for a business partner - AddressMatchResponse: - type: object - properties: - score: - type: number - format: float - address: - $ref: '#/components/schemas/AddressPartnerSearchResponse' - description: Match with score for a business partner record of type address - AddressPartnerBpnSearchRequest: - type: object - properties: - legalEntities: - type: array - items: - type: string - sites: - type: array - items: - type: string - addresses: - type: array - items: - type: string - description: Request for searching business partners of type address by parent BPNs - AddressPartnerCreateRequest: - type: object - properties: - version: - $ref: '#/components/schemas/AddressVersion' - careOf: - type: string - contexts: - type: array - items: - type: string - country: - type: string - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - administrativeAreas: - type: array - items: - $ref: '#/components/schemas/AdministrativeArea' - postCodes: - type: array - items: - $ref: '#/components/schemas/Postcode' - localities: - type: array - items: - $ref: '#/components/schemas/Locality' - thoroughfares: - type: array - items: - $ref: '#/components/schemas/Thoroughfare' - premises: - type: array - items: - $ref: '#/components/schemas/Premise' - postalDeliveryPoints: - type: array - items: - $ref: '#/components/schemas/PostalDeliveryPoint' - geographicCoordinates: - $ref: '#/components/schemas/GeoCoordinates' - types: - type: array - items: - type: string - enum: - - BRANCH_OFFICE - - CARE_OF - - HEADQUARTER - - LEGAL_ALTERNATIVE - - PO_BOX - - REGISTERED - - REGISTERED_AGENT_MAIL - - REGISTERED_AGENT_PHYSICAL - - VAT_REGISTERED - - UNSPECIFIC - parent: - type: string - index: - type: string - description: Request for creating new business partner record of type address - AddressPartnerCreateResponse: - type: object - properties: - bpn: - type: string - version: - $ref: '#/components/schemas/AddressVersionResponse' - careOf: - type: string - contexts: - type: array - items: - type: string - country: - $ref: '#/components/schemas/TypeKeyNameDtoCountryCode' - administrativeAreas: - type: array - items: - $ref: '#/components/schemas/AdministrativeAreaResponse' - postCodes: - type: array - items: - $ref: '#/components/schemas/PostcodeResponse' - localities: - type: array - items: - $ref: '#/components/schemas/LocalityResponse' - thoroughfares: - type: array - items: - $ref: '#/components/schemas/ThoroughfareResponse' - premises: - type: array - items: - $ref: '#/components/schemas/PremiseResponse' - postalDeliveryPoints: - type: array - items: - $ref: '#/components/schemas/PostalDeliveryPointResponse' - geographicCoordinates: - $ref: '#/components/schemas/GeoCoordinates' - types: - type: array - items: - $ref: '#/components/schemas/TypeKeyNameUrlDtoAddressType' - index: - type: string - description: Created business partners of type address - AddressPartnerResponse: - type: object - properties: - bpn: - type: string - version: - $ref: '#/components/schemas/AddressVersionResponse' - careOf: - type: string - contexts: - type: array - items: - type: string - country: - $ref: '#/components/schemas/TypeKeyNameDtoCountryCode' - administrativeAreas: - type: array - items: - $ref: '#/components/schemas/AdministrativeAreaResponse' - postCodes: - type: array - items: - $ref: '#/components/schemas/PostcodeResponse' - localities: - type: array - items: - $ref: '#/components/schemas/LocalityResponse' - thoroughfares: - type: array - items: - $ref: '#/components/schemas/ThoroughfareResponse' - premises: - type: array - items: - $ref: '#/components/schemas/PremiseResponse' - postalDeliveryPoints: - type: array - items: - $ref: '#/components/schemas/PostalDeliveryPointResponse' - geographicCoordinates: - $ref: '#/components/schemas/GeoCoordinates' - types: - type: array - items: - $ref: '#/components/schemas/TypeKeyNameUrlDtoAddressType' - description: Business partner of type address - AddressPartnerSearchResponse: - type: object - properties: - address: - $ref: '#/components/schemas/AddressPartnerResponse' - bpnLegalEntity: - type: string - bpnSite: - type: string - description: Business partner of type address with parent reference - AddressPartnerUpdateRequest: - type: object - properties: - bpn: - type: string - version: - $ref: '#/components/schemas/AddressVersion' - careOf: - type: string - contexts: - type: array - items: - type: string - country: - type: string - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - administrativeAreas: - type: array - items: - $ref: '#/components/schemas/AdministrativeArea' - postCodes: - type: array - items: - $ref: '#/components/schemas/Postcode' - localities: - type: array - items: - $ref: '#/components/schemas/Locality' - thoroughfares: - type: array - items: - $ref: '#/components/schemas/Thoroughfare' - premises: - type: array - items: - $ref: '#/components/schemas/Premise' - postalDeliveryPoints: - type: array - items: - $ref: '#/components/schemas/PostalDeliveryPoint' - geographicCoordinates: - $ref: '#/components/schemas/GeoCoordinates' - types: - type: array - items: - type: string - enum: - - BRANCH_OFFICE - - CARE_OF - - HEADQUARTER - - LEGAL_ALTERNATIVE - - PO_BOX - - REGISTERED - - REGISTERED_AGENT_MAIL - - REGISTERED_AGENT_PHYSICAL - - VAT_REGISTERED - - UNSPECIFIC - description: Request for updating a business partner record of type address - AddressResponse: - type: object - properties: - version: - $ref: '#/components/schemas/AddressVersionResponse' - careOf: - type: string - contexts: - type: array - items: - type: string - country: - $ref: '#/components/schemas/TypeKeyNameDtoCountryCode' - administrativeAreas: - type: array - items: - $ref: '#/components/schemas/AdministrativeAreaResponse' - postCodes: - type: array - items: - $ref: '#/components/schemas/PostcodeResponse' - localities: - type: array - items: - $ref: '#/components/schemas/LocalityResponse' - thoroughfares: - type: array - items: - $ref: '#/components/schemas/ThoroughfareResponse' - premises: - type: array - items: - $ref: '#/components/schemas/PremiseResponse' - postalDeliveryPoints: - type: array - items: - $ref: '#/components/schemas/PostalDeliveryPointResponse' - geographicCoordinates: - $ref: '#/components/schemas/GeoCoordinates' - types: - type: array - items: - $ref: '#/components/schemas/TypeKeyNameUrlDtoAddressType' - description: Localized address record of a business partner - AddressVersion: - type: object - properties: - characterSet: - type: string - enum: - - ARABIC - - CHINESE - - CHINESE_TRADITIONAL - - CYRILLIC - - GREEK - - HANGUL_KOREAN - - HEBREW - - HIRAGANA - - KANJI - - KATAKANA - - LATIN - - THAI - - WESTERN_LATIN_STANDARD - - UNDEFINED - language: - type: string - enum: - - undefined - - aa - - ab - - ae - - af - - ak - - am - - an - - ar - - as - - av - - ay - - az - - ba - - be - - bg - - bh - - bi - - bm - - bn - - bo - - br - - bs - - ca - - ce - - ch - - co - - cr - - cs - - cu - - cv - - cy - - da - - de - - dv - - dz - - ee - - el - - en - - eo - - es - - et - - eu - - fa - - ff - - fi - - fj - - fo - - fr - - fy - - ga - - gd - - gl - - gn - - gu - - gv - - ha - - he - - hi - - ho - - hr - - ht - - hu - - hy - - hz - - ia - - id - - ie - - ig - - ii - - ik - - io - - is - - it - - iu - - ja - - jv - - ka - - kg - - ki - - kj - - kk - - kl - - km - - kn - - ko - - kr - - ks - - ku - - kv - - kw - - ky - - la - - lb - - lg - - li - - ln - - lo - - lt - - lu - - lv - - mg - - mh - - mi - - mk - - ml - - mn - - mr - - ms - - mt - - my - - na - - nb - - nd - - ne - - ng - - nl - - nn - - 'no' - - nr - - nv - - ny - - oc - - oj - - om - - or - - os - - pa - - pi - - pl - - ps - - pt - - qu - - rm - - rn - - ro - - ru - - rw - - sa - - sc - - sd - - se - - sg - - si - - sk - - sl - - sm - - sn - - so - - sq - - sr - - ss - - st - - su - - sv - - sw - - ta - - te - - tg - - th - - ti - - tk - - tl - - tn - - to - - tr - - ts - - tt - - tw - - ty - - ug - - uk - - ur - - uz - - ve - - vi - - vo - - wa - - wo - - xh - - yi - - yo - - za - - zh - - zu - description: Localization record for an address - AddressVersionResponse: - type: object - properties: - characterSet: - $ref: '#/components/schemas/TypeKeyNameDtoCharacterSet' - language: - $ref: '#/components/schemas/TypeKeyNameDtoLanguageCode' - description: Localization record of an address - AdministrativeArea: - type: object - properties: - value: - type: string - shortName: - type: string - fipsCode: - type: string - type: - type: string - enum: - - COUNTY - - REGION - - OTHER - description: Areas such as country regions or counties - AdministrativeAreaResponse: - type: object - properties: - value: - type: string - shortName: - type: string - fipsCode: - type: string - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoAdministrativeAreaType' - language: - $ref: '#/components/schemas/TypeKeyNameDtoLanguageCode' - description: Area of an address such as country region or county - BankAccount: - type: object - properties: - trustScores: - type: array - items: - type: number - format: float - currency: - type: string - enum: - - UNDEFINED - - AED - - AFN - - ALL - - AMD - - ANG - - AOA - - ARS - - AUD - - AWG - - AZN - - BAM - - BBD - - BDT - - BGN - - BHD - - BIF - - BMD - - BND - - BOB - - BOV - - BRL - - BSD - - BTN - - BWP - - BYN - - BYR - - BZD - - CAD - - CDF - - CHE - - CHF - - CHW - - CLF - - CLP - - CNY - - COP - - COU - - CRC - - CUC - - CUP - - CVE - - CZK - - DJF - - DKK - - DOP - - DZD - - EGP - - ERN - - ETB - - EUR - - FJD - - FKP - - GBP - - GEL - - GHS - - GIP - - GMD - - GNF - - GTQ - - GYD - - HKD - - HNL - - HRK - - HTG - - HUF - - IDR - - ILS - - INR - - IQD - - IRR - - ISK - - JMD - - JOD - - JPY - - KES - - KGS - - KHR - - KMF - - KPW - - KRW - - KWD - - KYD - - KZT - - LAK - - LBP - - LKR - - LRD - - LSL - - LTL - - LYD - - MAD - - MDL - - MGA - - MKD - - MMK - - MNT - - MOP - - MRO - - MRU - - MUR - - MVR - - MWK - - MXN - - MXV - - MYR - - MZN - - NAD - - NGN - - NIO - - NOK - - NPR - - NZD - - OMR - - PAB - - PEN - - PGK - - PHP - - PKR - - PLN - - PYG - - QAR - - RON - - RSD - - RUB - - RUR - - RWF - - SAR - - SBD - - SCR - - SDG - - SEK - - SGD - - SHP - - SLL - - SOS - - SRD - - SSP - - STD - - STN - - SVC - - SYP - - SZL - - THB - - TJS - - TMT - - TND - - TOP - - TRY - - TTD - - TWD - - TZS - - UAH - - UGX - - USD - - USN - - USS - - UYI - - UYU - - UZS - - VEF - - VES - - VND - - VUV - - WST - - XAF - - XAG - - XAU - - XBA - - XBB - - XBC - - XBD - - XCD - - XDR - - XOF - - XPD - - XPF - - XPT - - XSU - - XTS - - XUA - - XXX - - YER - - ZAR - - ZMW - - ZWL - internationalBankAccountIdentifier: - type: string - internationalBankIdentifier: - type: string - nationalBankAccountIdentifier: - type: string - nationalBankIdentifier: - type: string - description: Bank account record of a business partner - BankAccountResponse: - type: object - properties: - trustScores: - type: array - items: - type: number - format: float - currency: - $ref: '#/components/schemas/TypeKeyNameDtoCurrencyCode' - internationalBankAccountIdentifier: - type: string - internationalBankIdentifier: - type: string - nationalBankAccountIdentifier: - type: string - nationalBankIdentifier: - type: string - description: Bank account record for a business partner - BpnIdentifierMappingResponse: - type: object - properties: - idValue: - type: string - bpn: - type: string - description: Mapping of Business Partner Number to identifier value - BusinessPartnerMatchResponse: - type: object - properties: - score: - type: number - format: float - businessPartner: - $ref: '#/components/schemas/BusinessPartnerResponse' - description: Match with score for a business partner of type legal entity in legacy format - deprecated: true - BusinessPartnerResponse: - type: object - properties: - uuid: - type: string - bpn: - type: string - identifiers: - type: array - items: - $ref: '#/components/schemas/IdentifierResponse' - names: - type: array - items: - $ref: '#/components/schemas/NameResponse' - legalForm: - $ref: '#/components/schemas/LegalFormResponse' - status: - $ref: '#/components/schemas/BusinessStatusResponse' - profileClassifications: - type: array - items: - $ref: '#/components/schemas/ClassificationResponse' - types: - type: array - items: - $ref: '#/components/schemas/TypeKeyNameUrlDtoBusinessPartnerType' - bankAccounts: - type: array - items: - $ref: '#/components/schemas/BankAccountResponse' - roles: - type: array - items: - $ref: '#/components/schemas/TypeKeyNameDtoString' - relations: - type: array - items: - $ref: '#/components/schemas/RelationResponse' - addresses: - type: array - items: - $ref: '#/components/schemas/AddressPartnerResponse' - sites: - type: array - items: - $ref: '#/components/schemas/SitePartnerResponse' - currentness: - type: string - format: date-time - description: Business Partner of type legal entity in deprecated response format - deprecated: true - BusinessStatus: - type: object - properties: - officialDenotation: - type: string - validFrom: - type: string - format: date-time - validUntil: - type: string - format: date-time - type: - type: string - enum: - - ACTIVE - - DISSOLVED - - IN_LIQUIDATION - - INACTIVE - - INSOLVENCY - - UNKNOWN - description: Status record for a business partner - BusinessStatusResponse: - type: object - properties: - officialDenotation: - type: string - validFrom: - type: string - format: date-time - validUntil: - type: string - format: date-time - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoBusinessStatusType' - description: Status of a business partner - ChangelogEntryResponse: - type: object - properties: - bpn: - type: string - changelogType: - type: string - enum: - - CREATE - - UPDATE - timestamp: - type: string - format: date-time - description: Changelog entry for a business partner - Classification: - type: object - properties: - value: - type: string - code: - type: string - type: - type: string - enum: - - NACE - - NAF - - NAICS - - SIC - description: Classification record for a business partner - ClassificationResponse: - type: object - properties: - value: - type: string - code: - type: string - type: - $ref: '#/components/schemas/NamedTypeWithLink' - description: Classification record of a business partner - CountryIdentifierTypeResponse: - type: object - properties: - identifierType: - $ref: '#/components/schemas/TypeKeyNameUrlDtoString' - mandatory: - type: boolean - description: Valid identifiers for a country - GeoCoordinates: - type: object - properties: - longitude: - type: number - format: float - latitude: - type: number - format: float - altitude: - type: number - format: float - description: Geo coordinates record for an address - Identifier: - type: object - properties: - value: - type: string - type: - type: string - issuingBody: - type: string - status: - type: string - description: Identifier record for a business partner - IdentifierResponse: - type: object - properties: - value: - type: string - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoString' - issuingBody: - $ref: '#/components/schemas/TypeKeyNameUrlDtoString' - status: - $ref: '#/components/schemas/TypeKeyNameDtoString' - description: Identifier record of a business partner - IdentifiersSearchRequest: - type: object - properties: - idType: - type: string - idValues: - type: array - items: - type: string - description: Contains identifiers to search legal entities by - LegalAddressSearchResponse: - type: object - properties: - legalEntity: - type: string - legalAddress: - $ref: '#/components/schemas/AddressResponse' - description: Legal address record with parent BPN - LegalEntityMatchResponse: - type: object - properties: - score: - type: number - format: float - legalEntity: - $ref: '#/components/schemas/LegalEntityPartnerResponse' - description: Match with score for a business partner record of type legal entity - LegalEntityPartnerCreateRequest: - type: object - properties: - identifiers: - type: array - items: - $ref: '#/components/schemas/Identifier' - names: - type: array - items: - $ref: '#/components/schemas/Name' - legalForm: - type: string - status: - $ref: '#/components/schemas/BusinessStatus' - profileClassifications: - type: array - items: - $ref: '#/components/schemas/Classification' - types: - type: array - items: - type: string - enum: - - BRAND - - LEGAL_ENTITY - - ORGANIZATIONAL_UNIT - - SITE - - UNKNOWN - bankAccounts: - type: array - items: - $ref: '#/components/schemas/BankAccount' - legalAddress: - $ref: '#/components/schemas/Address' - index: - type: string - description: Request for creating new business partner record of type legal entity - LegalEntityPartnerCreateResponse: - type: object - properties: - bpn: - type: string - identifiers: - type: array - items: - $ref: '#/components/schemas/IdentifierResponse' - names: - type: array - items: - $ref: '#/components/schemas/NameResponse' - legalForm: - $ref: '#/components/schemas/LegalFormResponse' - status: - $ref: '#/components/schemas/BusinessStatusResponse' - profileClassifications: - type: array - items: - $ref: '#/components/schemas/ClassificationResponse' - types: - type: array - items: - $ref: '#/components/schemas/TypeKeyNameUrlDtoBusinessPartnerType' - bankAccounts: - type: array - items: - $ref: '#/components/schemas/BankAccountResponse' - roles: - type: array - items: - $ref: '#/components/schemas/TypeKeyNameDtoString' - relations: - type: array - items: - $ref: '#/components/schemas/RelationResponse' - currentness: - type: string - format: date-time - legalAddress: - $ref: '#/components/schemas/AddressResponse' - index: - type: string - description: Created business partner of type legal entity - LegalEntityPartnerResponse: - type: object - properties: - bpn: - type: string - identifiers: - type: array - items: - $ref: '#/components/schemas/IdentifierResponse' - names: - type: array - items: - $ref: '#/components/schemas/NameResponse' - legalForm: - $ref: '#/components/schemas/LegalFormResponse' - status: - $ref: '#/components/schemas/BusinessStatusResponse' - profileClassifications: - type: array - items: - $ref: '#/components/schemas/ClassificationResponse' - types: - type: array - items: - $ref: '#/components/schemas/TypeKeyNameUrlDtoBusinessPartnerType' - bankAccounts: - type: array - items: - $ref: '#/components/schemas/BankAccountResponse' - roles: - type: array - items: - $ref: '#/components/schemas/TypeKeyNameDtoString' - relations: - type: array - items: - $ref: '#/components/schemas/RelationResponse' - currentness: - type: string - format: date-time - description: Business partner of type legal entity with currentness - LegalEntityUpdateRequest: - type: object - properties: - bpn: - type: string - identifiers: - type: array - items: - $ref: '#/components/schemas/Identifier' - names: - type: array - items: - $ref: '#/components/schemas/Name' - legalForm: - type: string - status: - $ref: '#/components/schemas/BusinessStatus' - profileClassifications: - type: array - items: - $ref: '#/components/schemas/Classification' - types: - type: array - items: - type: string - enum: - - BRAND - - LEGAL_ENTITY - - ORGANIZATIONAL_UNIT - - SITE - - UNKNOWN - bankAccounts: - type: array - items: - $ref: '#/components/schemas/BankAccount' - legalAddress: - $ref: '#/components/schemas/Address' - description: Request for updating a business partner record of type legal entity - LegalFormRequest: - type: object - properties: - technicalKey: - type: string - name: - type: string - url: - type: string - mainAbbreviation: - type: string - language: - type: string - enum: - - undefined - - aa - - ab - - ae - - af - - ak - - am - - an - - ar - - as - - av - - ay - - az - - ba - - be - - bg - - bh - - bi - - bm - - bn - - bo - - br - - bs - - ca - - ce - - ch - - co - - cr - - cs - - cu - - cv - - cy - - da - - de - - dv - - dz - - ee - - el - - en - - eo - - es - - et - - eu - - fa - - ff - - fi - - fj - - fo - - fr - - fy - - ga - - gd - - gl - - gn - - gu - - gv - - ha - - he - - hi - - ho - - hr - - ht - - hu - - hy - - hz - - ia - - id - - ie - - ig - - ii - - ik - - io - - is - - it - - iu - - ja - - jv - - ka - - kg - - ki - - kj - - kk - - kl - - km - - kn - - ko - - kr - - ks - - ku - - kv - - kw - - ky - - la - - lb - - lg - - li - - ln - - lo - - lt - - lu - - lv - - mg - - mh - - mi - - mk - - ml - - mn - - mr - - ms - - mt - - my - - na - - nb - - nd - - ne - - ng - - nl - - nn - - 'no' - - nr - - nv - - ny - - oc - - oj - - om - - or - - os - - pa - - pi - - pl - - ps - - pt - - qu - - rm - - rn - - ro - - ru - - rw - - sa - - sc - - sd - - se - - sg - - si - - sk - - sl - - sm - - sn - - so - - sq - - sr - - ss - - st - - su - - sv - - sw - - ta - - te - - tg - - th - - ti - - tk - - tl - - tn - - to - - tr - - ts - - tt - - tw - - ty - - ug - - uk - - ur - - uz - - ve - - vi - - vo - - wa - - wo - - xh - - yi - - yo - - za - - zh - - zu - category: - type: array - items: - $ref: '#/components/schemas/NamedTypeWithLink' - description: New legal form record to be referenced by business partners - LegalFormResponse: - type: object - properties: - technicalKey: - type: string - name: - type: string - url: - type: string - mainAbbreviation: - type: string - language: - $ref: '#/components/schemas/TypeKeyNameDtoLanguageCode' - categories: - type: array - items: - $ref: '#/components/schemas/NamedTypeWithLink' - description: Legal form a business partner can have - Locality: - type: object - properties: - value: - type: string - shortName: - type: string - type: - type: string - enum: - - BLOCK - - CITY - - DISTRICT - - OTHER - - POST_OFFICE_CITY - - QUARTER - description: Locality record for an address such as city, block or district - LocalityResponse: - type: object - properties: - value: - type: string - shortName: - type: string - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoLocalityType' - language: - $ref: '#/components/schemas/TypeKeyNameDtoLanguageCode' - description: Locality record of an address such as city, block or district - MainAddressSearchResponse: - type: object - properties: - site: - type: string - mainAddress: - $ref: '#/components/schemas/AddressResponse' - description: Main address record with parent BPN - Name: - type: object - properties: - value: - type: string - shortName: - type: string - type: - type: string - enum: - - ACRONYM - - DOING_BUSINESS_AS - - ESTABLISHMENT - - INTERNATIONAL - - LOCAL - - OTHER - - REGISTERED - - TRANSLITERATED - - VAT_REGISTERED - language: - type: string - enum: - - undefined - - aa - - ab - - ae - - af - - ak - - am - - an - - ar - - as - - av - - ay - - az - - ba - - be - - bg - - bh - - bi - - bm - - bn - - bo - - br - - bs - - ca - - ce - - ch - - co - - cr - - cs - - cu - - cv - - cy - - da - - de - - dv - - dz - - ee - - el - - en - - eo - - es - - et - - eu - - fa - - ff - - fi - - fj - - fo - - fr - - fy - - ga - - gd - - gl - - gn - - gu - - gv - - ha - - he - - hi - - ho - - hr - - ht - - hu - - hy - - hz - - ia - - id - - ie - - ig - - ii - - ik - - io - - is - - it - - iu - - ja - - jv - - ka - - kg - - ki - - kj - - kk - - kl - - km - - kn - - ko - - kr - - ks - - ku - - kv - - kw - - ky - - la - - lb - - lg - - li - - ln - - lo - - lt - - lu - - lv - - mg - - mh - - mi - - mk - - ml - - mn - - mr - - ms - - mt - - my - - na - - nb - - nd - - ne - - ng - - nl - - nn - - 'no' - - nr - - nv - - ny - - oc - - oj - - om - - or - - os - - pa - - pi - - pl - - ps - - pt - - qu - - rm - - rn - - ro - - ru - - rw - - sa - - sc - - sd - - se - - sg - - si - - sk - - sl - - sm - - sn - - so - - sq - - sr - - ss - - st - - su - - sv - - sw - - ta - - te - - tg - - th - - ti - - tk - - tl - - tn - - to - - tr - - ts - - tt - - tw - - ty - - ug - - uk - - ur - - uz - - ve - - vi - - vo - - wa - - wo - - xh - - yi - - yo - - za - - zh - - zu - description: Name record for a business partner - NameResponse: - type: object - properties: - value: - type: string - shortName: - type: string - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoNameType' - language: - $ref: '#/components/schemas/TypeKeyNameDtoLanguageCode' - description: Name record of a business partner - NamedTypeWithLink: - type: object - properties: - name: - type: string - url: - type: string - description: General type with name and URL link for further information - PageResponseAddressMatchResponse: - type: object - properties: - totalElements: - type: integer - format: int64 - totalPages: - type: integer - format: int32 - page: - type: integer - format: int32 - contentSize: - type: integer - format: int32 - content: - type: array - items: - $ref: '#/components/schemas/AddressMatchResponse' - description: Paginated collection of results - PageResponseAddressPartnerResponse: - type: object - properties: - totalElements: - type: integer - format: int64 - totalPages: - type: integer - format: int32 - page: - type: integer - format: int32 - contentSize: - type: integer - format: int32 - content: - type: array - items: - $ref: '#/components/schemas/AddressPartnerResponse' - description: Paginated collection of results - PageResponseAddressPartnerSearchResponse: - type: object - properties: - totalElements: - type: integer - format: int64 - totalPages: - type: integer - format: int32 - page: - type: integer - format: int32 - contentSize: - type: integer - format: int32 - content: - type: array - items: - $ref: '#/components/schemas/AddressPartnerSearchResponse' - description: Paginated collection of results - PageResponseBusinessPartnerMatchResponse: - type: object - properties: - totalElements: - type: integer - format: int64 - totalPages: - type: integer - format: int32 - page: - type: integer - format: int32 - contentSize: - type: integer - format: int32 - content: - type: array - items: - $ref: '#/components/schemas/BusinessPartnerMatchResponse' - description: Paginated collection of results - PageResponseChangelogEntryResponse: - type: object - properties: - totalElements: - type: integer - format: int64 - totalPages: - type: integer - format: int32 - page: - type: integer - format: int32 - contentSize: - type: integer - format: int32 - content: - type: array - items: - $ref: '#/components/schemas/ChangelogEntryResponse' - description: Paginated collection of results - PageResponseLegalEntityMatchResponse: - type: object - properties: - totalElements: - type: integer - format: int64 - totalPages: - type: integer - format: int32 - page: - type: integer - format: int32 - contentSize: - type: integer - format: int32 - content: - type: array - items: - $ref: '#/components/schemas/LegalEntityMatchResponse' - description: Paginated collection of results - PageResponseLegalFormResponse: - type: object - properties: - totalElements: - type: integer - format: int64 - totalPages: - type: integer - format: int32 - page: - type: integer - format: int32 - contentSize: - type: integer - format: int32 - content: - type: array - items: - $ref: '#/components/schemas/LegalFormResponse' - description: Paginated collection of results - PageResponseSitePartnerResponse: - type: object - properties: - totalElements: - type: integer - format: int64 - totalPages: - type: integer - format: int32 - page: - type: integer - format: int32 - contentSize: - type: integer - format: int32 - content: - type: array - items: - $ref: '#/components/schemas/SitePartnerResponse' - description: Paginated collection of results - PageResponseSitePartnerSearchResponse: - type: object - properties: - totalElements: - type: integer - format: int64 - totalPages: - type: integer - format: int32 - page: - type: integer - format: int32 - contentSize: - type: integer - format: int32 - content: - type: array - items: - $ref: '#/components/schemas/SitePartnerSearchResponse' - description: Paginated collection of results - PageResponseSuggestionResponse: - type: object - properties: - totalElements: - type: integer - format: int64 - totalPages: - type: integer - format: int32 - page: - type: integer - format: int32 - contentSize: - type: integer - format: int32 - content: - type: array - items: - $ref: '#/components/schemas/SuggestionResponse' - description: Paginated collection of results - PageResponseTypeKeyNameDtoString: - type: object - properties: - totalElements: - type: integer - format: int64 - totalPages: - type: integer - format: int32 - page: - type: integer - format: int32 - contentSize: - type: integer - format: int32 - content: - type: array - items: - $ref: '#/components/schemas/TypeKeyNameDtoString' - description: Paginated collection of results - PageResponseTypeKeyNameUrlDtoString: - type: object - properties: - totalElements: - type: integer - format: int64 - totalPages: - type: integer - format: int32 - page: - type: integer - format: int32 - contentSize: - type: integer - format: int32 - content: - type: array - items: - $ref: '#/components/schemas/TypeKeyNameUrlDtoString' - description: Paginated collection of results - PostalDeliveryPoint: - type: object - properties: - value: - type: string - shortName: - type: string - number: - type: string - type: - type: string - enum: - - INTERURBAN_DELIVERY_POINT - - MAIL_STATION - - MAILBOX - - OTHER - - POST_OFFICE_BOX - description: Postal delivery point record for an address - PostalDeliveryPointResponse: - type: object - properties: - value: - type: string - shortName: - type: string - number: - type: string - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoPostalDeliveryPointType' - language: - $ref: '#/components/schemas/TypeKeyNameDtoLanguageCode' - description: Postal delivery point record of an address - Postcode: - type: object - properties: - value: - type: string - type: - type: string - enum: - - CEDEX - - LARGE_MAIL_USER - - OTHER - - POST_BOX - - REGULAR - description: Postcode record for an address - PostcodeResponse: - type: object - properties: - value: - type: string - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoPostCodeType' - description: Postcode record of an address - Premise: - type: object - properties: - value: - type: string - shortName: - type: string - number: - type: string - type: - type: string - enum: - - BUILDING - - OTHER - - LEVEL - - HARBOUR - - ROOM - - SUITE - - UNIT - - WAREHOUSE - description: Premise record for an address such as building, room or floor - PremiseResponse: - type: object - properties: - value: - type: string - shortName: - type: string - number: - type: string - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoPremiseType' - language: - $ref: '#/components/schemas/TypeKeyNameDtoLanguageCode' - description: Premise record of an address such as building, room or floor - RelationResponse: - type: object - properties: - relationClass: - $ref: '#/components/schemas/TypeKeyNameDtoRelationClass' - type: - $ref: '#/components/schemas/TypeKeyNameDtoRelationType' - startNode: - type: string - endNode: - type: string - startedAt: - type: string - format: date-time - endedAt: - type: string - format: date-time - description: Directed relation between two business partners - SiteBpnSearchRequest: - type: object - properties: - legalEntities: - type: array - items: - type: string - sites: - type: array - items: - type: string - SitePartnerCreateRequest: - type: object - properties: - name: - type: string - mainAddress: - $ref: '#/components/schemas/Address' - legalEntity: - type: string - index: - type: string - description: Request for creating new business partner record of type site - SitePartnerCreateResponse: - type: object - properties: - bpn: - type: string - name: - type: string - mainAddress: - $ref: '#/components/schemas/AddressResponse' - index: - type: string - description: Created business partner record of type site - SitePartnerResponse: - type: object - properties: - bpn: - type: string - name: - type: string - description: Business partner of type site - SitePartnerSearchResponse: - type: object - properties: - site: - $ref: '#/components/schemas/SitePartnerResponse' - bpnLegalEntity: - type: string - description: Business partner of type site with parent BPN - SitePartnerUpdateRequest: - type: object - properties: - bpn: - type: string - name: - type: string - mainAddress: - $ref: '#/components/schemas/Address' - description: Request for updating a business partner record of type site - SuggestionResponse: - type: object - properties: - suggestion: - type: string - relevancy: - type: number - format: float - description: Shows a ranked suggestion based on a given search text - SyncResponse: - type: object - properties: - type: - type: string - enum: - - OPENSEARCH - - SAAS_IMPORT - status: - type: string - enum: - - NOT_SYNCED - - RUNNING - - SUCCESS - - ERROR - count: - type: integer - format: int32 - progress: - type: number - format: float - errorDetails: - type: string - startedAt: - type: string - format: date-time - finishedAt: - type: string - format: date-time - Thoroughfare: - type: object - properties: - value: - type: string - name: - type: string - shortName: - type: string - number: - type: string - direction: - type: string - type: - type: string - enum: - - INDUSTRIAL_ZONE - - OTHER - - RIVER - - SQUARE - - STREET - description: Thoroughfare record for an address such as street, square or industrial zone - ThoroughfareResponse: - type: object - properties: - value: - type: string - name: - type: string - shortName: - type: string - number: - type: string - direction: - type: string - type: - $ref: '#/components/schemas/TypeKeyNameUrlDtoThoroughfareType' - language: - $ref: '#/components/schemas/TypeKeyNameDtoLanguageCode' - description: Thoroughfare record of an address such as street, square or industrial zone - TypeKeyNameDtoCharacterSet: - type: object - properties: - technicalKey: - type: string - enum: - - ARABIC - - CHINESE - - CHINESE_TRADITIONAL - - CYRILLIC - - GREEK - - HANGUL_KOREAN - - HEBREW - - HIRAGANA - - KANJI - - KATAKANA - - LATIN - - THAI - - WESTERN_LATIN_STANDARD - - UNDEFINED - name: - type: string - description: Named type uniquely identified by its technical key - TypeKeyNameDtoCountryCode: - type: object - properties: - technicalKey: - type: string - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - name: - type: string - description: Named type uniquely identified by its technical key - TypeKeyNameDtoCurrencyCode: - type: object - properties: - technicalKey: - type: string - enum: - - UNDEFINED - - AED - - AFN - - ALL - - AMD - - ANG - - AOA - - ARS - - AUD - - AWG - - AZN - - BAM - - BBD - - BDT - - BGN - - BHD - - BIF - - BMD - - BND - - BOB - - BOV - - BRL - - BSD - - BTN - - BWP - - BYN - - BYR - - BZD - - CAD - - CDF - - CHE - - CHF - - CHW - - CLF - - CLP - - CNY - - COP - - COU - - CRC - - CUC - - CUP - - CVE - - CZK - - DJF - - DKK - - DOP - - DZD - - EGP - - ERN - - ETB - - EUR - - FJD - - FKP - - GBP - - GEL - - GHS - - GIP - - GMD - - GNF - - GTQ - - GYD - - HKD - - HNL - - HRK - - HTG - - HUF - - IDR - - ILS - - INR - - IQD - - IRR - - ISK - - JMD - - JOD - - JPY - - KES - - KGS - - KHR - - KMF - - KPW - - KRW - - KWD - - KYD - - KZT - - LAK - - LBP - - LKR - - LRD - - LSL - - LTL - - LYD - - MAD - - MDL - - MGA - - MKD - - MMK - - MNT - - MOP - - MRO - - MRU - - MUR - - MVR - - MWK - - MXN - - MXV - - MYR - - MZN - - NAD - - NGN - - NIO - - NOK - - NPR - - NZD - - OMR - - PAB - - PEN - - PGK - - PHP - - PKR - - PLN - - PYG - - QAR - - RON - - RSD - - RUB - - RUR - - RWF - - SAR - - SBD - - SCR - - SDG - - SEK - - SGD - - SHP - - SLL - - SOS - - SRD - - SSP - - STD - - STN - - SVC - - SYP - - SZL - - THB - - TJS - - TMT - - TND - - TOP - - TRY - - TTD - - TWD - - TZS - - UAH - - UGX - - USD - - USN - - USS - - UYI - - UYU - - UZS - - VEF - - VES - - VND - - VUV - - WST - - XAF - - XAG - - XAU - - XBA - - XBB - - XBC - - XBD - - XCD - - XDR - - XOF - - XPD - - XPF - - XPT - - XSU - - XTS - - XUA - - XXX - - YER - - ZAR - - ZMW - - ZWL - name: - type: string - description: Named type uniquely identified by its technical key - TypeKeyNameDtoLanguageCode: - type: object - properties: - technicalKey: - type: string - enum: - - undefined - - aa - - ab - - ae - - af - - ak - - am - - an - - ar - - as - - av - - ay - - az - - ba - - be - - bg - - bh - - bi - - bm - - bn - - bo - - br - - bs - - ca - - ce - - ch - - co - - cr - - cs - - cu - - cv - - cy - - da - - de - - dv - - dz - - ee - - el - - en - - eo - - es - - et - - eu - - fa - - ff - - fi - - fj - - fo - - fr - - fy - - ga - - gd - - gl - - gn - - gu - - gv - - ha - - he - - hi - - ho - - hr - - ht - - hu - - hy - - hz - - ia - - id - - ie - - ig - - ii - - ik - - io - - is - - it - - iu - - ja - - jv - - ka - - kg - - ki - - kj - - kk - - kl - - km - - kn - - ko - - kr - - ks - - ku - - kv - - kw - - ky - - la - - lb - - lg - - li - - ln - - lo - - lt - - lu - - lv - - mg - - mh - - mi - - mk - - ml - - mn - - mr - - ms - - mt - - my - - na - - nb - - nd - - ne - - ng - - nl - - nn - - 'no' - - nr - - nv - - ny - - oc - - oj - - om - - or - - os - - pa - - pi - - pl - - ps - - pt - - qu - - rm - - rn - - ro - - ru - - rw - - sa - - sc - - sd - - se - - sg - - si - - sk - - sl - - sm - - sn - - so - - sq - - sr - - ss - - st - - su - - sv - - sw - - ta - - te - - tg - - th - - ti - - tk - - tl - - tn - - to - - tr - - ts - - tt - - tw - - ty - - ug - - uk - - ur - - uz - - ve - - vi - - vo - - wa - - wo - - xh - - yi - - yo - - za - - zh - - zu - name: - type: string - description: Named type uniquely identified by its technical key - TypeKeyNameDtoRelationClass: - type: object - properties: - technicalKey: - type: string - enum: - - SAAS_HIERARCHY - - SAAS_TRANSITION - - CX_HIERARCHY - - DNB_HIERARCHY - - LEI_HIERARCHY - name: - type: string - description: Named type uniquely identified by its technical key - TypeKeyNameDtoRelationType: - type: object - properties: - technicalKey: - type: string - enum: - - CX_LEGAL_SUCCESSOR_OF - - CX_LEGAL_PREDECESSOR_OF - - CX_ADDRESS_OF - - CX_SITE_OF - - CX_OWNED_BY - - DIRECT_LEGAL_RELATION - - COMMERCIAL_ULTIMATE - - DOMESTIC_BRANCH_RELATION - - INTERNATIONAL_BRANCH_RELATION - - DOMESTIC_LEGAL_ULTIMATE_RELATION - - GLOBAL_LEGAL_ULTIMATE_RELATION - - LEGAL_PREDECESSOR - - LEGAL_SUCCESSOR - - DNB_PARENT - - DNB_HEADQUARTER - - DNB_DOMESTIC_ULTIMATE - - DNB_GLOBAL_ULTIMATE - - LEI_DIRECT_PARENT - - LEI_INTERNATIONAL_BRANCH - - LEI_ULTIMATE_PARENT - name: - type: string - description: Named type uniquely identified by its technical key - TypeKeyNameDtoString: - type: object - properties: - technicalKey: - type: string - name: - type: string - description: Named type uniquely identified by its technical key - TypeKeyNameUrlDtoAddressType: - type: object - properties: - technicalKey: - type: string - enum: - - BRANCH_OFFICE - - CARE_OF - - HEADQUARTER - - LEGAL_ALTERNATIVE - - PO_BOX - - REGISTERED - - REGISTERED_AGENT_MAIL - - REGISTERED_AGENT_PHYSICAL - - VAT_REGISTERED - - UNSPECIFIC - name: - type: string - url: - type: string - TypeKeyNameUrlDtoAdministrativeAreaType: - type: object - properties: - technicalKey: - type: string - enum: - - COUNTY - - REGION - - OTHER - name: - type: string - url: - type: string - TypeKeyNameUrlDtoBusinessPartnerType: - type: object - properties: - technicalKey: - type: string - enum: - - BRAND - - LEGAL_ENTITY - - ORGANIZATIONAL_UNIT - - SITE - - UNKNOWN - name: - type: string - url: - type: string - TypeKeyNameUrlDtoBusinessStatusType: - type: object - properties: - technicalKey: - type: string - enum: - - ACTIVE - - DISSOLVED - - IN_LIQUIDATION - - INACTIVE - - INSOLVENCY - - UNKNOWN - name: - type: string - url: - type: string - TypeKeyNameUrlDtoLocalityType: - type: object - properties: - technicalKey: - type: string - enum: - - BLOCK - - CITY - - DISTRICT - - OTHER - - POST_OFFICE_CITY - - QUARTER - name: - type: string - url: - type: string - TypeKeyNameUrlDtoNameType: - type: object - properties: - technicalKey: - type: string - enum: - - ACRONYM - - DOING_BUSINESS_AS - - ESTABLISHMENT - - INTERNATIONAL - - LOCAL - - OTHER - - REGISTERED - - TRANSLITERATED - - VAT_REGISTERED - name: - type: string - url: - type: string - TypeKeyNameUrlDtoPostCodeType: - type: object - properties: - technicalKey: - type: string - enum: - - CEDEX - - LARGE_MAIL_USER - - OTHER - - POST_BOX - - REGULAR - name: - type: string - url: - type: string - TypeKeyNameUrlDtoPostalDeliveryPointType: - type: object - properties: - technicalKey: - type: string - enum: - - INTERURBAN_DELIVERY_POINT - - MAIL_STATION - - MAILBOX - - OTHER - - POST_OFFICE_BOX - name: - type: string - url: - type: string - TypeKeyNameUrlDtoPremiseType: - type: object - properties: - technicalKey: - type: string - enum: - - BUILDING - - OTHER - - LEVEL - - HARBOUR - - ROOM - - SUITE - - UNIT - - WAREHOUSE - name: - type: string - url: - type: string - TypeKeyNameUrlDtoString: - type: object - properties: - technicalKey: - type: string - name: - type: string - url: - type: string - TypeKeyNameUrlDtoThoroughfareType: - type: object - properties: - technicalKey: - type: string - enum: - - INDUSTRIAL_ZONE - - OTHER - - RIVER - - SQUARE - - STREET - name: - type: string - url: - type: string \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/control-api/control-plane-api.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/edc/control-api/control-plane-api.yaml deleted file mode 100644 index 521dd019926..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/control-api/control-plane-api.yaml +++ /dev/null @@ -1,89 +0,0 @@ -openapi: 3.0.1 -info: - title: "EDC Control Plane API" - description: - version: 0.0.1-SNAPSHOT -paths: - /transferprocess/{processId}/complete: - post: - description: "Requests completion of the transfer process. Due to the asynchronous\ - \ nature of transfers, a successful response only indicates that the request\ - \ was successfully received" - operationId: complete - parameters: - - in: path - name: processId - required: true - schema: - type: string - example: null - responses: - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - tags: - - Transfer Process Control Api - /transferprocess/{processId}/fail: - post: - description: "Requests completion of the transfer process. Due to the asynchronous\ - \ nature of transfers, a successful response only indicates that the request\ - \ was successfully received" - operationId: fail - parameters: - - in: path - name: processId - required: true - schema: - type: string - example: null - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TransferProcessFailStateDto' - required: true - responses: - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - tags: - - Transfer Process Control Api -components: - schemas: - ApiErrorDetail: - type: object - example: null - properties: - invalidValue: - type: string - example: null - message: - type: string - example: null - path: - type: string - example: null - type: - type: string - example: null - TransferProcessFailStateDto: - type: object - example: null - properties: - errorMessage: - type: string - example: null - required: - - errorMessage diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/control-api/data-plane-api.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/edc/control-api/data-plane-api.yaml deleted file mode 100644 index 454a1a863e1..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/control-api/data-plane-api.yaml +++ /dev/null @@ -1,161 +0,0 @@ -openapi: 3.0.1 -info: - title: "EDC Data Plane API" - description: - version: 0.0.1-SNAPSHOT -tags: -- description: 'Api targeted by the Control Plane to delegate a data transfer (Provider - Push or Streaming) to the Data Plane after the contract has been successfully - negotiated and agreed between the two participants. ' - name: Data Plane control API -- description: "The public API of the Data Plane is a data proxy enabling a data consumer\ - \ to actively querydata from the provider data source (e.g. backend Rest API,\ - \ internal database...) through its Data Planeinstance. Thus the Data Plane is\ - \ the only entry/output door for the data, which avoids the provider to exposedirectly\ - \ its data externally.The Data Plane public API being a proxy, it supports all\ - \ verbs (i.e. GET, POST, PUT, PATCH, DELETE), whichcan then conveyed until the\ - \ data source is required. This is especially useful when the actual data sourceis\ - \ a Rest API itself.In the same manner, any set of arbitrary query parameters,\ - \ path parameters and request body are supported (in the limits fixed by the HTTP\ - \ server) and can also conveyed to the actual data source." - name: Data Plane public API -paths: - /transfer: - post: - description: Initiates a data transfer for the given request. The transfer will - be performed asynchronously. - operationId: initiateTransfer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DataFlowRequest' - responses: - "200": - description: Data transfer initiated - "400": - description: Failed to validate request - tags: - - Data Plane control API - /transfer/{processId}: - get: - description: Get the current state of a data transfer. - operationId: getTransferState - parameters: - - in: path - name: processId - required: true - schema: - type: string - example: null - responses: - "200": - description: Missing access token - tags: - - Data Plane control API - /{any}: - delete: - description: Send `DELETE` data query to the Data Plane. - operationId: delete - responses: - "400": - description: Missing access token - "403": - description: Access token is expired or invalid - "500": - description: Failed to transfer data - tags: - - Data Plane public API - get: - description: Send `GET` data query to the Data Plane. - operationId: get - responses: - "400": - description: Missing access token - "403": - description: Access token is expired or invalid - "500": - description: Failed to transfer data - tags: - - Data Plane public API - patch: - description: Send `PATCH` data query to the Data Plane. - operationId: patch - responses: - "400": - description: Missing access token - "403": - description: Access token is expired or invalid - "500": - description: Failed to transfer data - tags: - - Data Plane public API - post: - description: Send `POST` data query to the Data Plane. - operationId: post - responses: - "400": - description: Missing access token - "403": - description: Access token is expired or invalid - "500": - description: Failed to transfer data - tags: - - Data Plane public API - put: - description: Send `PUT` data query to the Data Plane. - operationId: put - responses: - "400": - description: Missing access token - "403": - description: Access token is expired or invalid - "500": - description: Failed to transfer data - tags: - - Data Plane public API -components: - schemas: - DataAddress: - type: object - example: null - properties: - properties: - type: object - additionalProperties: - type: string - example: null - example: null - DataFlowRequest: - type: object - example: null - properties: - callbackAddress: - type: string - format: url - example: null - destinationDataAddress: - $ref: '#/components/schemas/DataAddress' - id: - type: string - example: null - processId: - type: string - example: null - properties: - type: object - additionalProperties: - type: string - example: null - example: null - sourceDataAddress: - $ref: '#/components/schemas/DataAddress' - traceContext: - type: object - additionalProperties: - type: string - example: null - example: null - trackable: - type: boolean - example: null diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/control-api/transfer-data-plane.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/edc/control-api/transfer-data-plane.yaml deleted file mode 100644 index 42273d98fd9..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/control-api/transfer-data-plane.yaml +++ /dev/null @@ -1,40 +0,0 @@ -openapi: 3.0.1 -info: - title: "EDC Transfer Data Plane API" - description: - version: 0.0.1-SNAPSHOT -paths: - /token: - get: - description: "Checks that the provided token has been signed by the present\ - \ entity and asserts its validity. If token is valid, then the data address\ - \ contained in its claims is decrypted and returned back to the caller." - operationId: validate - parameters: - - in: header - name: Authorization - required: true - schema: - type: string - example: null - responses: - "200": - description: Token is valid - "400": - description: Request was malformed - "403": - description: Token is invalid - tags: - - Consumer Pull Token Validation -components: - schemas: - DataAddress: - type: object - example: null - properties: - properties: - type: object - additionalProperties: - type: string - example: null - example: null diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/extensions/control-plane-adapter.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/edc/extensions/control-plane-adapter.yaml deleted file mode 100644 index 6447853ea6f..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/extensions/control-plane-adapter.yaml +++ /dev/null @@ -1,45 +0,0 @@ -openapi: 3.0.1 -info: - title: EDC Control Plane Adapter API - description: - license: - name: Apache License v2.0 - url: http://apache.org/v2 - version: 0.0.1-SNAPSHOT -paths: - /adapter/asset/sync/{assetId}: - get: - operationId: getAssetSynchronous - parameters: - - in: path - name: assetId - required: true - schema: - type: string - example: null - - in: query - name: providerUrl - schema: - type: string - example: null - - in: query - name: contractAgreementId - schema: - type: string - example: null - - in: query - name: contractAgreementReuse - schema: - type: boolean - default: true - example: null - - in: query - name: timeout - schema: - type: string - example: null - responses: - default: - description: default response - tags: - - Control Plane Adapter diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/api-observability.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/api-observability.yaml deleted file mode 100644 index 54ee10cc693..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/api-observability.yaml +++ /dev/null @@ -1,109 +0,0 @@ -openapi: 3.0.1 -info: - title: "EDC Observability API" - description: - version: 0.0.1-SNAPSHOT -paths: - /check/health: - get: - description: Performs a liveness probe to determine whether the runtime is working - properly. - operationId: checkHealth - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/HealthStatus' - tags: - - Application Observability - /check/liveness: - get: - description: Performs a liveness probe to determine whether the runtime is working - properly. - operationId: getLiveness - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/HealthStatus' - tags: - - Application Observability - /check/readiness: - get: - description: Performs a readiness probe to determine whether the runtime is - able to accept requests. - operationId: getReadiness - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/HealthStatus' - tags: - - Application Observability - /check/startup: - get: - description: Performs a startup probe to determine whether the runtime has completed - startup. - operationId: getStartup - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/HealthStatus' - tags: - - Application Observability -components: - schemas: - Failure: - type: object - example: null - properties: - failureDetail: - type: string - example: null - messages: - type: array - example: null - items: - type: string - example: null - HealthCheckResult: - type: object - example: null - properties: - component: - type: string - example: null - failure: - $ref: '#/components/schemas/Failure' - isHealthy: - type: boolean - example: null - HealthStatus: - type: object - example: null - properties: - componentResults: - type: array - example: null - items: - $ref: '#/components/schemas/HealthCheckResult' - isSystemHealthy: - type: boolean - example: null diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/asset-api.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/asset-api.yaml deleted file mode 100644 index cafe802d4d0..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/asset-api.yaml +++ /dev/null @@ -1,466 +0,0 @@ -openapi: 3.0.1 -info: - title: "EDC Asset API" - description: - version: 0.0.1-SNAPSHOT -paths: - /assets: - get: - deprecated: true - description: Gets all assets according to a particular query - operationId: getAllAssets - parameters: - - in: query - name: offset - schema: - type: integer - format: int32 - example: null - - in: query - name: limit - schema: - type: integer - format: int32 - example: null - - in: query - name: filter - schema: - type: string - example: null - - in: query - name: sort - schema: - type: string - enum: - - ASC - - DESC - example: null - - in: query - name: sortField - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/AssetResponseDto' - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - tags: - - Asset - post: - description: Creates a new asset together with a data address - operationId: createAsset - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AssetEntryDto' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/IdResponseDto' - description: Asset was created successfully. Returns the asset Id and created - timestamp - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - "409": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Could not create asset, because an asset with that ID already\ - \ exists" - tags: - - Asset - /assets/request: - post: - description: ' all assets according to a particular query' - operationId: requestAssets - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QuerySpecDto' - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/AssetResponseDto' - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - tags: - - Asset - /assets/{assetId}: - put: - description: "Updates an asset with the given ID if it exists. If the asset\ - \ is not found, no further action is taken. DANGER ZONE: Note that updating\ - \ assets can have unexpected results, especially for contract offers that\ - \ have been sent out or are ongoing in contract negotiations." - operationId: updateAsset - parameters: - - in: path - name: assetId - required: true - schema: - type: string - example: null - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AssetUpdateRequestDto' - responses: - "200": - description: Asset was updated successfully - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - description: "Asset could not be updated, because it does not exist." - tags: - - Asset - /assets/{assetId}/dataaddress: - put: - description: Updates a DataAddress for an asset with the given ID. - operationId: updateDataAddress - parameters: - - in: path - name: assetId - required: true - schema: - type: string - example: null - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DataAddressDto' - responses: - "200": - description: Asset was updated successfully - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An asset with the given ID does not exist - tags: - - Asset - /assets/{id}: - delete: - description: "Removes an asset with the given ID if possible. Deleting an asset\ - \ is only possible if that asset is not yet referenced by a contract agreement,\ - \ in which case an error is returned. DANGER ZONE: Note that deleting assets\ - \ can have unexpected results, especially for contract offers that have been\ - \ sent out or ongoing or contract negotiations." - operationId: removeAsset - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - description: Asset was deleted successfully - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An asset with the given ID does not exist - "409": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "The asset cannot be deleted, because it is referenced by a\ - \ contract agreement" - tags: - - Asset - get: - description: Gets an asset with the given ID - operationId: getAsset - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/AssetResponseDto' - description: The asset - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An asset with the given ID does not exist - tags: - - Asset - /assets/{id}/address: - get: - description: Gets a data address of an asset with the given ID - operationId: getAssetDataAddress - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DataAddressDto' - description: The data address - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An asset with the given ID does not exist - tags: - - Asset -components: - schemas: - ApiErrorDetail: - type: object - example: null - properties: - invalidValue: - type: string - example: null - message: - type: string - example: null - path: - type: string - example: null - type: - type: string - example: null - AssetCreationRequestDto: - type: object - example: null - properties: - id: - type: string - example: null - properties: - type: object - additionalProperties: - type: object - example: null - example: null - required: - - properties - AssetEntryDto: - type: object - example: null - properties: - asset: - $ref: '#/components/schemas/AssetCreationRequestDto' - dataAddress: - $ref: '#/components/schemas/DataAddressDto' - required: - - asset - - dataAddress - AssetResponseDto: - type: object - example: null - properties: - createdAt: - type: integer - format: int64 - example: null - id: - type: string - example: null - properties: - type: object - additionalProperties: - type: object - example: null - example: null - AssetUpdateRequestDto: - type: object - example: null - properties: - properties: - type: object - additionalProperties: - type: object - example: null - example: null - required: - - properties - CriterionDto: - type: object - example: null - properties: - operandLeft: - type: object - example: null - operandRight: - type: object - example: null - operator: - type: string - example: null - required: - - operandLeft - - operator - DataAddressDto: - type: object - example: null - properties: - properties: - type: object - additionalProperties: - type: string - example: null - example: null - required: - - properties - IdResponseDto: - type: object - example: null - properties: - createdAt: - type: integer - format: int64 - example: null - id: - type: string - example: null - QuerySpecDto: - type: object - example: null - properties: - filter: - type: string - example: null - filterExpression: - type: array - example: null - items: - $ref: '#/components/schemas/CriterionDto' - limit: - type: integer - format: int32 - example: null - offset: - type: integer - format: int32 - example: null - sortField: - type: string - example: null - sortOrder: - type: string - enum: - - ASC - - DESC - example: null diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/catalog-api.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/catalog-api.yaml deleted file mode 100644 index fc3d7a36476..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/catalog-api.yaml +++ /dev/null @@ -1,402 +0,0 @@ -openapi: 3.0.1 -info: - title: "EDC Catalog API" - description: - version: 0.0.1-SNAPSHOT -paths: - /catalog: - get: - deprecated: true - operationId: getCatalog - parameters: - - in: query - name: providerUrl - required: true - schema: - type: string - example: null - - in: query - name: offset - schema: - type: integer - format: int32 - example: null - - in: query - name: limit - schema: - type: integer - format: int32 - example: null - - in: query - name: filter - schema: - type: string - example: null - - in: query - name: sort - schema: - type: string - enum: - - ASC - - DESC - example: null - - in: query - name: sortField - schema: - type: string - example: null - responses: - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Catalog' - description: Gets contract offers (=catalog) of a single connector - tags: - - Catalog - /catalog/request: - post: - operationId: requestCatalog - requestBody: - content: - '*/*': - schema: - $ref: '#/components/schemas/CatalogRequestDto' - required: true - responses: - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Catalog' - description: Gets contract offers (=catalog) of a single connector - tags: - - Catalog -components: - schemas: - Action: - type: object - example: null - properties: - constraint: - $ref: '#/components/schemas/Constraint' - includedIn: - type: string - example: null - type: - type: string - example: null - Asset: - type: object - example: null - properties: - createdAt: - type: integer - format: int64 - example: null - id: - type: string - example: null - properties: - type: object - additionalProperties: - type: object - example: null - example: null - Catalog: - type: object - example: null - properties: - contractOffers: - type: array - example: null - items: - $ref: '#/components/schemas/ContractOffer' - dataServices: - type: array - example: null - items: - $ref: '#/components/schemas/DataService' - datasets: - type: array - example: null - items: - $ref: '#/components/schemas/Dataset' - id: - type: string - example: null - properties: - type: object - additionalProperties: - type: object - example: null - example: null - CatalogRequestDto: - type: object - example: null - properties: - providerUrl: - type: string - example: null - querySpec: - $ref: '#/components/schemas/QuerySpecDto' - required: - - providerUrl - Constraint: - type: object - discriminator: - propertyName: edctype - example: null - properties: - edctype: - type: string - example: null - required: - - edctype - ContractOffer: - type: object - example: null - properties: - asset: - $ref: '#/components/schemas/Asset' - consumer: - type: string - format: uri - example: null - contractEnd: - type: string - format: date-time - example: null - contractStart: - type: string - format: date-time - example: null - id: - type: string - example: null - offerEnd: - type: string - format: date-time - example: null - offerStart: - type: string - format: date-time - example: null - policy: - $ref: '#/components/schemas/Policy' - provider: - type: string - format: uri - example: null - CriterionDto: - type: object - example: null - properties: - operandLeft: - type: object - example: null - operandRight: - type: object - example: null - operator: - type: string - example: null - required: - - operandLeft - - operator - DataService: - type: object - example: null - properties: - endpointUrl: - type: string - example: null - id: - type: string - example: null - terms: - type: string - example: null - Dataset: - type: object - example: null - properties: - distributions: - type: array - example: null - items: - $ref: '#/components/schemas/Distribution' - id: - type: string - example: null - offers: - type: object - additionalProperties: - $ref: '#/components/schemas/Policy' - example: null - properties: - type: object - additionalProperties: - type: object - example: null - example: null - Distribution: - type: object - example: null - properties: - dataService: - $ref: '#/components/schemas/DataService' - format: - type: string - example: null - Duty: - type: object - example: null - properties: - action: - $ref: '#/components/schemas/Action' - assignee: - type: string - example: null - assigner: - type: string - example: null - consequence: - $ref: '#/components/schemas/Duty' - constraints: - type: array - example: null - items: - $ref: '#/components/schemas/Constraint' - parentPermission: - $ref: '#/components/schemas/Permission' - target: - type: string - example: null - uid: - type: string - example: null - Permission: - type: object - example: null - properties: - action: - $ref: '#/components/schemas/Action' - assignee: - type: string - example: null - assigner: - type: string - example: null - constraints: - type: array - example: null - items: - $ref: '#/components/schemas/Constraint' - duties: - type: array - example: null - items: - $ref: '#/components/schemas/Duty' - target: - type: string - example: null - uid: - type: string - example: null - Policy: - type: object - example: null - properties: - '@type': - type: string - enum: - - SET - - OFFER - - CONTRACT - example: null - assignee: - type: string - example: null - assigner: - type: string - example: null - extensibleProperties: - type: object - additionalProperties: - type: object - example: null - example: null - inheritsFrom: - type: string - example: null - obligations: - type: array - example: null - items: - $ref: '#/components/schemas/Duty' - permissions: - type: array - example: null - items: - $ref: '#/components/schemas/Permission' - prohibitions: - type: array - example: null - items: - $ref: '#/components/schemas/Prohibition' - target: - type: string - example: null - Prohibition: - type: object - example: null - properties: - action: - $ref: '#/components/schemas/Action' - assignee: - type: string - example: null - assigner: - type: string - example: null - constraints: - type: array - example: null - items: - $ref: '#/components/schemas/Constraint' - target: - type: string - example: null - uid: - type: string - example: null - QuerySpecDto: - type: object - example: null - properties: - filter: - type: string - example: null - filterExpression: - type: array - example: null - items: - $ref: '#/components/schemas/CriterionDto' - limit: - type: integer - format: int32 - example: null - offset: - type: integer - format: int32 - example: null - sortField: - type: string - example: null - sortOrder: - type: string - enum: - - ASC - - DESC - example: null diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/contract-agreement-api.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/contract-agreement-api.yaml deleted file mode 100644 index f17c820a442..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/contract-agreement-api.yaml +++ /dev/null @@ -1,373 +0,0 @@ -openapi: 3.0.1 -info: - title: "EDC Contract Agreement API" - description: - version: 0.0.1-SNAPSHOT -paths: - /contractagreements: - get: - deprecated: true - description: Gets all contract agreements according to a particular query - operationId: getAllAgreements - parameters: - - in: query - name: offset - schema: - type: integer - format: int32 - example: null - - in: query - name: limit - schema: - type: integer - format: int32 - example: null - - in: query - name: filter - schema: - type: string - example: null - - in: query - name: sort - schema: - type: string - enum: - - ASC - - DESC - example: null - - in: query - name: sortField - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ContractAgreementDto' - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - tags: - - Contract Agreement - /contractagreements/request: - post: - description: Gets all contract agreements according to a particular query - operationId: queryAllAgreements - requestBody: - content: - '*/*': - schema: - $ref: '#/components/schemas/QuerySpecDto' - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ContractAgreementDto' - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - tags: - - Contract Agreement - /contractagreements/{id}: - get: - description: Gets an contract agreement with the given ID - operationId: getContractAgreement - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ContractAgreementDto' - description: The contract agreement - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An contract agreement with the given ID does not exist - tags: - - Contract Agreement -components: - schemas: - Action: - type: object - example: null - properties: - constraint: - $ref: '#/components/schemas/Constraint' - includedIn: - type: string - example: null - type: - type: string - example: null - ApiErrorDetail: - type: object - example: null - properties: - invalidValue: - type: string - example: null - message: - type: string - example: null - path: - type: string - example: null - type: - type: string - example: null - Constraint: - type: object - discriminator: - propertyName: edctype - example: null - properties: - edctype: - type: string - example: null - required: - - edctype - ContractAgreementDto: - type: object - example: null - properties: - assetId: - type: string - example: null - consumerAgentId: - type: string - example: null - contractEndDate: - type: integer - format: int64 - example: null - contractSigningDate: - type: integer - format: int64 - example: null - contractStartDate: - type: integer - format: int64 - example: null - id: - type: string - example: null - policy: - $ref: '#/components/schemas/Policy' - providerAgentId: - type: string - example: null - required: - - assetId - - consumerAgentId - - id - - policy - - providerAgentId - CriterionDto: - type: object - example: null - properties: - operandLeft: - type: object - example: null - operandRight: - type: object - example: null - operator: - type: string - example: null - required: - - operandLeft - - operator - Duty: - type: object - example: null - properties: - action: - $ref: '#/components/schemas/Action' - assignee: - type: string - example: null - assigner: - type: string - example: null - consequence: - $ref: '#/components/schemas/Duty' - constraints: - type: array - example: null - items: - $ref: '#/components/schemas/Constraint' - parentPermission: - $ref: '#/components/schemas/Permission' - target: - type: string - example: null - uid: - type: string - example: null - Permission: - type: object - example: null - properties: - action: - $ref: '#/components/schemas/Action' - assignee: - type: string - example: null - assigner: - type: string - example: null - constraints: - type: array - example: null - items: - $ref: '#/components/schemas/Constraint' - duties: - type: array - example: null - items: - $ref: '#/components/schemas/Duty' - target: - type: string - example: null - uid: - type: string - example: null - Policy: - type: object - example: null - properties: - '@type': - type: string - enum: - - SET - - OFFER - - CONTRACT - example: null - assignee: - type: string - example: null - assigner: - type: string - example: null - extensibleProperties: - type: object - additionalProperties: - type: object - example: null - example: null - inheritsFrom: - type: string - example: null - obligations: - type: array - example: null - items: - $ref: '#/components/schemas/Duty' - permissions: - type: array - example: null - items: - $ref: '#/components/schemas/Permission' - prohibitions: - type: array - example: null - items: - $ref: '#/components/schemas/Prohibition' - target: - type: string - example: null - Prohibition: - type: object - example: null - properties: - action: - $ref: '#/components/schemas/Action' - assignee: - type: string - example: null - assigner: - type: string - example: null - constraints: - type: array - example: null - items: - $ref: '#/components/schemas/Constraint' - target: - type: string - example: null - uid: - type: string - example: null - QuerySpecDto: - type: object - example: null - properties: - filter: - type: string - example: null - filterExpression: - type: array - example: null - items: - $ref: '#/components/schemas/CriterionDto' - limit: - type: integer - format: int32 - example: null - offset: - type: integer - format: int32 - example: null - sortField: - type: string - example: null - sortOrder: - type: string - enum: - - ASC - - DESC - example: null diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/contract-definition-api.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/contract-definition-api.yaml deleted file mode 100644 index 11308f3525e..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/contract-definition-api.yaml +++ /dev/null @@ -1,390 +0,0 @@ -openapi: 3.0.1 -info: - title: "EDC Contract Definition API" - description: - version: 0.0.1-SNAPSHOT -paths: - /contractdefinitions: - get: - deprecated: true - description: Returns all contract definitions according to a query - operationId: getAllContractDefinitions - parameters: - - in: query - name: offset - schema: - type: integer - format: int32 - example: null - - in: query - name: limit - schema: - type: integer - format: int32 - example: null - - in: query - name: filter - schema: - type: string - example: null - - in: query - name: sort - schema: - type: string - enum: - - ASC - - DESC - example: null - - in: query - name: sortField - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ContractDefinitionResponseDto' - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request was malformed - tags: - - Contract Definition - post: - description: Creates a new contract definition - operationId: createContractDefinition - requestBody: - content: - '*/*': - schema: - $ref: '#/components/schemas/ContractDefinitionCreateDto' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/IdResponseDto' - description: contract definition was created successfully. Returns the Contract - Definition Id and created timestamp - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - "409": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Could not create contract definition, because a contract definition\ - \ with that ID already exists" - tags: - - Contract Definition - /contractdefinitions/request: - post: - description: Returns all contract definitions according to a query - operationId: queryAllContractDefinitions - requestBody: - content: - '*/*': - schema: - $ref: '#/components/schemas/QuerySpecDto' - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ContractDefinitionResponseDto' - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request was malformed - tags: - - Contract Definition - /contractdefinitions/{contractDefinitionId}: - put: - description: Updated a contract definition with the given ID - operationId: updateContractDefinition - parameters: - - in: path - name: contractDefinitionId - required: true - schema: - type: string - example: null - requestBody: - content: - '*/*': - schema: - $ref: '#/components/schemas/ContractDefinitionUpdateDto' - responses: - "204": - description: Contract definition was updated successfully - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: A contract definition with the given ID does not exist - tags: - - Contract Definition - /contractdefinitions/{id}: - delete: - description: "Removes a contract definition with the given ID if possible. DANGER\ - \ ZONE: Note that deleting contract definitions can have unexpected results,\ - \ especially for contract offers that have been sent out or ongoing or contract\ - \ negotiations." - operationId: deleteContractDefinition - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - description: Contract definition was deleted successfully - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: A contract definition with the given ID does not exist - tags: - - Contract Definition - get: - description: Gets an contract definition with the given ID - operationId: getContractDefinition - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ContractDefinitionResponseDto' - description: The contract definition - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An contract agreement with the given ID does not exist - tags: - - Contract Definition -components: - schemas: - ApiErrorDetail: - type: object - example: null - properties: - invalidValue: - type: string - example: null - message: - type: string - example: null - path: - type: string - example: null - type: - type: string - example: null - ContractDefinitionCreateDto: - type: object - example: null - properties: - accessPolicyId: - type: string - example: null - contractPolicyId: - type: string - example: null - criteria: - type: array - example: null - items: - $ref: '#/components/schemas/CriterionDto' - id: - type: string - example: null - validity: - type: integer - format: int64 - example: null - required: - - accessPolicyId - - contractPolicyId - - criteria - ContractDefinitionResponseDto: - type: object - example: null - properties: - accessPolicyId: - type: string - example: null - contractPolicyId: - type: string - example: null - createdAt: - type: integer - format: int64 - example: null - criteria: - type: array - example: null - items: - $ref: '#/components/schemas/CriterionDto' - id: - type: string - example: null - validity: - type: integer - format: int64 - example: null - ContractDefinitionUpdateDto: - type: object - example: null - properties: - accessPolicyId: - type: string - example: null - contractPolicyId: - type: string - example: null - criteria: - type: array - example: null - items: - $ref: '#/components/schemas/CriterionDto' - validity: - type: integer - format: int64 - example: null - required: - - accessPolicyId - - contractPolicyId - - criteria - CriterionDto: - type: object - example: null - properties: - operandLeft: - type: object - example: null - operandRight: - type: object - example: null - operator: - type: string - example: null - required: - - operandLeft - - operator - IdResponseDto: - type: object - example: null - properties: - createdAt: - type: integer - format: int64 - example: null - id: - type: string - example: null - QuerySpecDto: - type: object - example: null - properties: - filter: - type: string - example: null - filterExpression: - type: array - example: null - items: - $ref: '#/components/schemas/CriterionDto' - limit: - type: integer - format: int32 - example: null - offset: - type: integer - format: int32 - example: null - sortField: - type: string - example: null - sortOrder: - type: string - enum: - - ASC - - DESC - example: null diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/contract-negotiation-api.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/contract-negotiation-api.yaml deleted file mode 100644 index 8851f72cf02..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/contract-negotiation-api.yaml +++ /dev/null @@ -1,715 +0,0 @@ -openapi: 3.0.1 -info: - title: "EDC Contract Negotiation API" - description: - version: 0.0.1-SNAPSHOT -paths: - /contractnegotiations: - get: - deprecated: true - description: Returns all contract negotiations according to a query - operationId: getNegotiations - parameters: - - in: query - name: offset - schema: - type: integer - format: int32 - example: null - - in: query - name: limit - schema: - type: integer - format: int32 - example: null - - in: query - name: filter - schema: - type: string - example: null - - in: query - name: sort - schema: - type: string - enum: - - ASC - - DESC - example: null - - in: query - name: sortField - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ContractNegotiationDto' - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request was malformed - tags: - - Contract Negotiation - post: - description: "Initiates a contract negotiation for a given offer and with the\ - \ given counter part. Please note that successfully invoking this endpoint\ - \ only means that the negotiation was initiated. Clients must poll the /{id}/state\ - \ endpoint to track the state" - operationId: initiateContractNegotiation - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NegotiationInitiateRequestDto' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/IdResponseDto' - description: The negotiation was successfully initiated. Returns the contract - negotiation ID and created timestamp - links: - poll-state: - operationId: getNegotiationState - parameters: - id: $response.body#/id - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - tags: - - Contract Negotiation - /contractnegotiations/request: - post: - description: Returns all contract negotiations according to a query - operationId: queryNegotiations - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QuerySpecDto' - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ContractNegotiationDto' - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request was malformed - tags: - - Contract Negotiation - /contractnegotiations/{id}: - get: - description: Gets an contract negotiation with the given ID - operationId: getNegotiation - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ContractNegotiationDto' - description: The contract negotiation - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An contract negotiation with the given ID does not exist - tags: - - Contract Negotiation - /contractnegotiations/{id}/agreement: - get: - description: Gets a contract agreement for a contract negotiation with the given - ID - operationId: getAgreementForNegotiation - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ContractAgreementDto' - description: "The contract agreement that is attached to the negotiation,\ - \ or null" - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An contract negotiation with the given ID does not exist - tags: - - Contract Negotiation - /contractnegotiations/{id}/cancel: - post: - description: "Requests aborting the contract negotiation. Due to the asynchronous\ - \ nature of contract negotiations, a successful response only indicates that\ - \ the request was successfully received. Clients must poll the /{id}/state\ - \ endpoint to track the state." - operationId: cancelNegotiation - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - description: Request to cancel the Contract negotiation was successfully - received - links: - poll-state: - operationId: getNegotiationState - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: A contract negotiation with the given ID does not exist - tags: - - Contract Negotiation - /contractnegotiations/{id}/decline: - post: - description: "Requests cancelling the contract negotiation. Due to the asynchronous\ - \ nature of contract negotiations, a successful response only indicates that\ - \ the request was successfully received. Clients must poll the /{id}/state\ - \ endpoint to track the state." - operationId: declineNegotiation - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - description: Request to decline the Contract negotiation was successfully - received - links: - poll-state: - operationId: getNegotiationState - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: A contract negotiation with the given ID does not exist - tags: - - Contract Negotiation - /contractnegotiations/{id}/state: - get: - description: Gets the state of a contract negotiation with the given ID - operationId: getNegotiationState - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/NegotiationState' - description: The contract negotiation's state - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An contract negotiation with the given ID does not exist - tags: - - Contract Negotiation -components: - schemas: - Action: - type: object - example: null - properties: - constraint: - $ref: '#/components/schemas/Constraint' - includedIn: - type: string - example: null - type: - type: string - example: null - ApiErrorDetail: - type: object - example: null - properties: - invalidValue: - type: string - example: null - message: - type: string - example: null - path: - type: string - example: null - type: - type: string - example: null - CallbackAddress: - type: object - example: null - properties: - events: - type: array - example: null - items: - type: string - example: null - uniqueItems: true - transactional: - type: boolean - example: null - uri: - type: string - example: null - CallbackAddressDto: - type: object - example: null - properties: - events: - type: array - example: null - items: - type: string - example: null - uniqueItems: true - transactional: - type: boolean - example: null - uri: - type: string - example: null - required: - - events - - uri - Constraint: - type: object - discriminator: - propertyName: edctype - example: null - properties: - edctype: - type: string - example: null - required: - - edctype - ContractAgreementDto: - type: object - example: null - properties: - assetId: - type: string - example: null - consumerAgentId: - type: string - example: null - contractEndDate: - type: integer - format: int64 - example: null - contractSigningDate: - type: integer - format: int64 - example: null - contractStartDate: - type: integer - format: int64 - example: null - id: - type: string - example: null - policy: - $ref: '#/components/schemas/Policy' - providerAgentId: - type: string - example: null - required: - - assetId - - consumerAgentId - - id - - policy - - providerAgentId - ContractNegotiationDto: - type: object - example: null - properties: - callbackAddresses: - type: array - example: null - items: - $ref: '#/components/schemas/CallbackAddress' - contractAgreementId: - type: string - example: null - counterPartyAddress: - type: string - example: null - createdAt: - type: integer - format: int64 - example: null - errorDetail: - type: string - example: null - id: - type: string - example: null - protocol: - type: string - example: null - state: - type: string - example: null - type: - type: string - enum: - - CONSUMER - - PROVIDER - example: null - updatedAt: - type: integer - format: int64 - example: null - ContractOfferDescription: - type: object - example: null - properties: - assetId: - type: string - example: null - offerId: - type: string - example: null - policy: - $ref: '#/components/schemas/Policy' - validity: - type: integer - format: int64 - example: null - required: - - assetId - - offerId - - policy - CriterionDto: - type: object - example: null - properties: - operandLeft: - type: object - example: null - operandRight: - type: object - example: null - operator: - type: string - example: null - required: - - operandLeft - - operator - Duty: - type: object - example: null - properties: - action: - $ref: '#/components/schemas/Action' - assignee: - type: string - example: null - assigner: - type: string - example: null - consequence: - $ref: '#/components/schemas/Duty' - constraints: - type: array - example: null - items: - $ref: '#/components/schemas/Constraint' - parentPermission: - $ref: '#/components/schemas/Permission' - target: - type: string - example: null - uid: - type: string - example: null - IdResponseDto: - type: object - example: null - properties: - createdAt: - type: integer - format: int64 - example: null - id: - type: string - example: null - NegotiationInitiateRequestDto: - type: object - example: null - properties: - callbackAddresses: - type: array - example: null - items: - $ref: '#/components/schemas/CallbackAddressDto' - connectorAddress: - type: string - example: null - connectorId: - type: string - example: null - consumerId: - type: string - example: null - offer: - $ref: '#/components/schemas/ContractOfferDescription' - protocol: - type: string - example: null - providerId: - type: string - example: null - required: - - connectorAddress - - connectorId - - offer - - protocol - NegotiationState: - type: object - example: null - properties: - state: - type: string - example: null - Permission: - type: object - example: null - properties: - action: - $ref: '#/components/schemas/Action' - assignee: - type: string - example: null - assigner: - type: string - example: null - constraints: - type: array - example: null - items: - $ref: '#/components/schemas/Constraint' - duties: - type: array - example: null - items: - $ref: '#/components/schemas/Duty' - target: - type: string - example: null - uid: - type: string - example: null - Policy: - type: object - example: null - properties: - '@type': - type: string - enum: - - SET - - OFFER - - CONTRACT - example: null - assignee: - type: string - example: null - assigner: - type: string - example: null - extensibleProperties: - type: object - additionalProperties: - type: object - example: null - example: null - inheritsFrom: - type: string - example: null - obligations: - type: array - example: null - items: - $ref: '#/components/schemas/Duty' - permissions: - type: array - example: null - items: - $ref: '#/components/schemas/Permission' - prohibitions: - type: array - example: null - items: - $ref: '#/components/schemas/Prohibition' - target: - type: string - example: null - Prohibition: - type: object - example: null - properties: - action: - $ref: '#/components/schemas/Action' - assignee: - type: string - example: null - assigner: - type: string - example: null - constraints: - type: array - example: null - items: - $ref: '#/components/schemas/Constraint' - target: - type: string - example: null - uid: - type: string - example: null - QuerySpecDto: - type: object - example: null - properties: - filter: - type: string - example: null - filterExpression: - type: array - example: null - items: - $ref: '#/components/schemas/CriterionDto' - limit: - type: integer - format: int32 - example: null - offset: - type: integer - format: int32 - example: null - sortField: - type: string - example: null - sortOrder: - type: string - enum: - - ASC - - DESC - example: null diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/data-plane-selector-api.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/data-plane-selector-api.yaml deleted file mode 100644 index 2121a17cd76..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/data-plane-selector-api.yaml +++ /dev/null @@ -1,115 +0,0 @@ -openapi: 3.0.1 -info: - title: EDC Data Plane Selector API - description: - license: - name: Apache License v2.0 - url: http://apache.org/v2 - version: 0.0.1-SNAPSHOT -paths: - /instances: - get: - operationId: getAll - responses: - default: - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/DataPlaneInstance' - description: default response - tags: - - Dataplane Selector - post: - operationId: addEntry - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DataPlaneInstance' - responses: - default: - description: default response - tags: - - Dataplane Selector - /instances/select: - post: - operationId: find - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SelectionRequest' - responses: - default: - content: - application/json: - schema: - $ref: '#/components/schemas/DataPlaneInstance' - description: default response - tags: - - Dataplane Selector -components: - schemas: - DataAddress: - type: object - example: null - properties: - properties: - type: object - additionalProperties: - type: string - example: null - example: null - DataPlaneInstance: - type: object - example: null - properties: - allowedDestTypes: - type: array - example: null - items: - type: string - example: null - uniqueItems: true - allowedSourceTypes: - type: array - example: null - items: - type: string - example: null - uniqueItems: true - id: - type: string - example: null - lastActive: - type: integer - format: int64 - example: null - properties: - type: object - additionalProperties: - type: object - example: null - example: null - turnCount: - type: integer - format: int32 - example: null - url: - type: string - format: url - example: null - SelectionRequest: - type: object - example: null - properties: - destination: - $ref: '#/components/schemas/DataAddress' - source: - $ref: '#/components/schemas/DataAddress' - strategy: - type: string - example: null diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/policy-definition-api.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/policy-definition-api.yaml deleted file mode 100644 index 6daeb9e7de6..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/policy-definition-api.yaml +++ /dev/null @@ -1,823 +0,0 @@ -openapi: 3.0.1 -info: - title: "EDC Policy Definition API" - description: - version: 0.0.1-SNAPSHOT -paths: - /policydefinitions: - get: - deprecated: true - description: Returns all policy definitions according to a query - operationId: getAllPolicies - parameters: - - in: query - name: offset - schema: - type: integer - format: int32 - example: null - - in: query - name: limit - schema: - type: integer - format: int32 - example: null - - in: query - name: filter - schema: - type: string - example: null - - in: query - name: sort - schema: - type: string - enum: - - ASC - - DESC - example: null - - in: query - name: sortField - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/PolicyDefinitionResponseDto' - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request was malformed - tags: - - Policy - post: - deprecated: true - description: Creates a new policy definition - operationId: createPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PolicyDefinitionRequestDto' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/IdResponseDto' - description: policy definition was created successfully. Returns the Policy - Definition Id and created timestamp - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - "409": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Could not create policy definition, because a contract definition\ - \ with that ID already exists" - tags: - - Policy - /policydefinitions/request: - post: - deprecated: true - description: Returns all policy definitions according to a query - operationId: queryAllPolicies - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QuerySpecDto' - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/PolicyDefinitionResponseDto' - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request was malformed - tags: - - Policy - /policydefinitions/{id}: - delete: - deprecated: true - description: "Removes a policy definition with the given ID if possible. Deleting\ - \ a policy definition is only possible if that policy definition is not yet\ - \ referenced by a contract definition, in which case an error is returned.\ - \ DANGER ZONE: Note that deleting policy definitions can have unexpected results,\ - \ do this at your own risk!" - operationId: deletePolicy - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - description: Policy definition was deleted successfully - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An policy definition with the given ID does not exist - "409": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "The policy definition cannot be deleted, because it is referenced\ - \ by a contract definition" - tags: - - Policy - get: - deprecated: true - description: Gets a policy definition with the given ID - operationId: getPolicy - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/PolicyDefinitionResponseDto' - description: The policy definition - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An policy definition with the given ID does not exist - tags: - - Policy - /policydefinitions/{policyId}: - put: - deprecated: true - description: "Updates an existing Policy, If the Policy is not found, an error\ - \ is reported" - operationId: updatePolicy - parameters: - - in: path - name: policyId - required: true - schema: - type: string - example: null - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PolicyDefinitionUpdateDto' - responses: - "200": - description: policy definition was updated successfully. Returns the Policy - Definition Id and updated timestamp - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDetail' - description: "policy definition could not be updated, because it does not\ - \ exists" - tags: - - Policy - /v2/policydefinitions: - post: - description: Creates a new policy definition - operationId: createPolicyDefinition - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PolicyDefinitionNewRequestDto' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/IdResponseDto' - description: policy definition was created successfully. Returns the Policy - Definition Id and created timestamp - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - "409": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Could not create policy definition, because a contract definition\ - \ with that ID already exists" - tags: - - Policy Definition - /v2/policydefinitions/request: - post: - description: Returns all policy definitions according to a query - operationId: queryPolicyDefinitions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QuerySpecDto' - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/PolicyDefinitionNewResponseDto' - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request was malformed - tags: - - Policy Definition - /v2/policydefinitions/{id}: - delete: - description: "Removes a policy definition with the given ID if possible. Deleting\ - \ a policy definition is only possible if that policy definition is not yet\ - \ referenced by a contract definition, in which case an error is returned.\ - \ DANGER ZONE: Note that deleting policy definitions can have unexpected results,\ - \ do this at your own risk!" - operationId: deletePolicyDefinition - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - description: Policy definition was deleted successfully - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An policy definition with the given ID does not exist - "409": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "The policy definition cannot be deleted, because it is referenced\ - \ by a contract definition" - tags: - - Policy Definition - get: - description: Gets a policy definition with the given ID - operationId: getPolicyDefinition - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/PolicyDefinitionNewResponseDto' - description: The policy definition - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An policy definition with the given ID does not exist - tags: - - Policy Definition - put: - description: "Updates an existing Policy, If the Policy is not found, an error\ - \ is reported" - operationId: updatePolicyDefinition - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PolicyDefinitionNewUpdateDto' - responses: - "200": - description: policy definition was updated successfully. Returns the Policy - Definition Id and updated timestamp - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDetail' - description: "policy definition could not be updated, because it does not\ - \ exists" - tags: - - Policy Definition -components: - schemas: - Action: - type: object - example: null - properties: - constraint: - $ref: '#/components/schemas/Constraint' - includedIn: - type: string - example: null - type: - type: string - example: null - ApiErrorDetail: - type: object - example: null - properties: - invalidValue: - type: string - example: null - message: - type: string - example: null - path: - type: string - example: null - type: - type: string - example: null - Constraint: - type: object - discriminator: - propertyName: edctype - example: null - properties: - edctype: - type: string - example: null - required: - - edctype - CriterionDto: - type: object - example: null - properties: - operandLeft: - type: object - example: null - operandRight: - type: object - example: null - operator: - type: string - example: null - required: - - operandLeft - - operator - Duty: - type: object - example: null - properties: - action: - $ref: '#/components/schemas/Action' - assignee: - type: string - example: null - assigner: - type: string - example: null - consequence: - $ref: '#/components/schemas/Duty' - constraints: - type: array - example: null - items: - $ref: '#/components/schemas/Constraint' - parentPermission: - $ref: '#/components/schemas/Permission' - target: - type: string - example: null - uid: - type: string - example: null - IdResponseDto: - type: object - example: null - properties: - createdAt: - type: integer - format: int64 - example: null - id: - type: string - example: null - JsonObject: - type: object - additionalProperties: - $ref: '#/components/schemas/JsonValue' - example: null - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - JsonValue: - type: object - example: null - properties: - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - Permission: - type: object - example: null - properties: - action: - $ref: '#/components/schemas/Action' - assignee: - type: string - example: null - assigner: - type: string - example: null - constraints: - type: array - example: null - items: - $ref: '#/components/schemas/Constraint' - duties: - type: array - example: null - items: - $ref: '#/components/schemas/Duty' - target: - type: string - example: null - uid: - type: string - example: null - Policy: - type: object - example: null - properties: - '@type': - type: string - enum: - - SET - - OFFER - - CONTRACT - example: null - assignee: - type: string - example: null - assigner: - type: string - example: null - extensibleProperties: - type: object - additionalProperties: - type: object - example: null - example: null - inheritsFrom: - type: string - example: null - obligations: - type: array - example: null - items: - $ref: '#/components/schemas/Duty' - permissions: - type: array - example: null - items: - $ref: '#/components/schemas/Permission' - prohibitions: - type: array - example: null - items: - $ref: '#/components/schemas/Prohibition' - target: - type: string - example: null - PolicyDefinitionNewRequestDto: - type: object - example: null - properties: - id: - type: string - example: null - policy: - type: object - additionalProperties: - $ref: '#/components/schemas/JsonValue' - example: null - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - required: - - policy - PolicyDefinitionNewResponseDto: - type: object - example: null - properties: - createdAt: - type: integer - format: int64 - example: null - id: - type: string - example: null - policy: - type: object - additionalProperties: - $ref: '#/components/schemas/JsonValue' - example: null - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - required: - - policy - PolicyDefinitionNewUpdateDto: - type: object - example: null - properties: - policy: - type: object - additionalProperties: - $ref: '#/components/schemas/JsonValue' - example: null - properties: - empty: - type: boolean - example: null - valueType: - type: string - enum: - - ARRAY - - OBJECT - - STRING - - NUMBER - - "TRUE" - - "FALSE" - - "NULL" - example: null - required: - - policy - PolicyDefinitionRequestDto: - type: object - example: null - properties: - id: - type: string - example: null - policy: - $ref: '#/components/schemas/Policy' - required: - - policy - PolicyDefinitionResponseDto: - type: object - example: null - properties: - createdAt: - type: integer - format: int64 - example: null - id: - type: string - example: null - policy: - $ref: '#/components/schemas/Policy' - required: - - policy - PolicyDefinitionUpdateDto: - type: object - example: null - properties: - policy: - $ref: '#/components/schemas/Policy' - required: - - policy - Prohibition: - type: object - example: null - properties: - action: - $ref: '#/components/schemas/Action' - assignee: - type: string - example: null - assigner: - type: string - example: null - constraints: - type: array - example: null - items: - $ref: '#/components/schemas/Constraint' - target: - type: string - example: null - uid: - type: string - example: null - QuerySpecDto: - type: object - example: null - properties: - filter: - type: string - example: null - filterExpression: - type: array - example: null - items: - $ref: '#/components/schemas/CriterionDto' - limit: - type: integer - format: int32 - example: null - offset: - type: integer - format: int32 - example: null - sortField: - type: string - example: null - sortOrder: - type: string - enum: - - ASC - - DESC - example: null diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/provision-http.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/provision-http.yaml deleted file mode 100644 index f193e68d521..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/provision-http.yaml +++ /dev/null @@ -1,104 +0,0 @@ -openapi: 3.0.1 -info: - title: EDC Provision HTTP - description: - license: - name: Apache License v2.0 - url: http://apache.org/v2 - version: 0.0.1-SNAPSHOT -paths: - /callback/{processId}/deprovision: - post: - operationId: callDeprovisionWebhook - parameters: - - in: path - name: processId - required: true - schema: - type: string - example: null - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeprovisionedResource' - responses: - default: - description: default response - tags: - - HTTP Provisioner Webhook - /callback/{processId}/provision: - post: - operationId: callProvisionWebhook - parameters: - - in: path - name: processId - required: true - schema: - type: string - example: null - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ProvisionerWebhookRequest' - responses: - default: - description: default response - tags: - - HTTP Provisioner Webhook -components: - schemas: - DataAddress: - type: object - example: null - properties: - properties: - type: object - additionalProperties: - type: string - example: null - example: null - DeprovisionedResource: - type: object - example: null - properties: - error: - type: boolean - example: null - errorMessage: - type: string - example: null - inProcess: - type: boolean - example: null - provisionedResourceId: - type: string - example: null - ProvisionerWebhookRequest: - type: object - example: null - properties: - apiKeyJwt: - type: string - example: null - assetId: - type: string - example: null - contentDataAddress: - $ref: '#/components/schemas/DataAddress' - hasToken: - type: boolean - example: null - resourceDefinitionId: - type: string - example: null - resourceName: - type: string - example: null - required: - - apiKeyJwt - - assetId - - contentDataAddress - - resourceDefinitionId - - resourceName diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/transfer-process-api.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/transfer-process-api.yaml deleted file mode 100644 index e72bb95ba5d..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/edc/management-api/transfer-process-api.yaml +++ /dev/null @@ -1,597 +0,0 @@ -openapi: 3.0.1 -info: - title: "EDC Transfer Process API" - description: - version: 0.0.1-SNAPSHOT -paths: - /transferprocess: - get: - deprecated: true - description: Returns all transfer process according to a query - operationId: getAllTransferProcesses - parameters: - - in: query - name: offset - schema: - type: integer - format: int32 - example: null - - in: query - name: limit - schema: - type: integer - format: int32 - example: null - - in: query - name: filter - schema: - type: string - example: null - - in: query - name: sort - schema: - type: string - enum: - - ASC - - DESC - example: null - - in: query - name: sortField - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/TransferProcessDto' - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request was malformed - tags: - - Transfer Process - post: - description: "Initiates a data transfer with the given parameters. Please note\ - \ that successfully invoking this endpoint only means that the transfer was\ - \ initiated. Clients must poll the /{id}/state endpoint to track the state" - operationId: initiateTransfer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TransferRequestDto' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/IdResponseDto' - description: The transfer was successfully initiated. Returns the transfer - process ID and created timestamp - links: - poll-state: - operationId: getTransferProcessState - parameters: - id: $response.body#/id - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request body was malformed - tags: - - Transfer Process - /transferprocess/request: - post: - description: Returns all transfer process according to a query - operationId: queryAllTransferProcesses - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QuerySpecDto' - responses: - "200": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/TransferProcessDto' - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: Request was malformed - tags: - - Transfer Process - /transferprocess/{id}: - get: - description: Gets an transfer process with the given ID - operationId: getTransferProcess - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/TransferProcessDto' - description: The transfer process - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: A transfer process with the given ID does not exist - tags: - - Transfer Process - /transferprocess/{id}/cancel: - post: - deprecated: true - description: "Requests aborting the transfer process. Due to the asynchronous\ - \ nature of transfers, a successful response only indicates that the request\ - \ was successfully received. Clients must poll the /{id}/state endpoint to\ - \ track the state." - operationId: cancelTransferProcess - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - description: Request to cancel the transfer process was successfully received - links: - poll-state: - operationId: getTransferProcessState - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: A contract negotiation with the given ID does not exist - tags: - - Transfer Process - /transferprocess/{id}/deprovision: - post: - description: "Requests the deprovisioning of resources associated with a transfer\ - \ process. Due to the asynchronous nature of transfers, a successful response\ - \ only indicates that the request was successfully received. This may take\ - \ a long time, so clients must poll the /{id}/state endpoint to track the\ - \ state." - operationId: deprovisionTransferProcess - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - description: Request to deprovision the transfer process was successfully - received - links: - poll-state: - operationId: getTransferProcessState - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: A contract negotiation with the given ID does not exist - tags: - - Transfer Process - /transferprocess/{id}/state: - get: - description: Gets the state of a transfer process with the given ID - operationId: getTransferProcessState - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/TransferState' - description: The transfer process's state - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: An transfer process with the given ID does not exist - tags: - - Transfer Process - /transferprocess/{id}/terminate: - post: - description: "Requests the termination of a transfer process. Due to the asynchronous\ - \ nature of transfers, a successful response only indicates that the request\ - \ was successfully received. Clients must poll the /{id}/state endpoint to\ - \ track the state." - operationId: terminateTransferProcess - parameters: - - in: path - name: id - required: true - schema: - type: string - example: null - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TerminateTransferDto' - responses: - "200": - description: Request to cancel the transfer process was successfully received - links: - poll-state: - operationId: getTransferProcessState - "400": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Request was malformed, e.g. id was null" - "404": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: A contract negotiation with the given ID does not exist - "409": - content: - application/json: - schema: - type: array - example: null - items: - $ref: '#/components/schemas/ApiErrorDetail' - description: "Could not terminate transfer process, because it is already\ - \ completed or terminated." - tags: - - Transfer Process -components: - schemas: - ApiErrorDetail: - type: object - example: null - properties: - invalidValue: - type: string - example: null - message: - type: string - example: null - path: - type: string - example: null - type: - type: string - example: null - CallbackAddress: - type: object - example: null - properties: - events: - type: array - example: null - items: - type: string - example: null - uniqueItems: true - transactional: - type: boolean - example: null - uri: - type: string - example: null - CallbackAddressDto: - type: object - example: null - properties: - events: - type: array - example: null - items: - type: string - example: null - uniqueItems: true - transactional: - type: boolean - example: null - uri: - type: string - example: null - required: - - events - - uri - CriterionDto: - type: object - example: null - properties: - operandLeft: - type: object - example: null - operandRight: - type: object - example: null - operator: - type: string - example: null - required: - - operandLeft - - operator - DataAddress: - type: object - example: null - properties: - properties: - type: object - additionalProperties: - type: string - example: null - example: null - DataAddressInformationDto: - type: object - example: null - properties: - properties: - type: object - additionalProperties: - type: string - example: null - example: null - DataRequestDto: - type: object - example: null - properties: - assetId: - type: string - example: null - connectorId: - type: string - example: null - contractId: - type: string - example: null - id: - type: string - example: null - IdResponseDto: - type: object - example: null - properties: - createdAt: - type: integer - format: int64 - example: null - id: - type: string - example: null - QuerySpecDto: - type: object - example: null - properties: - filter: - type: string - example: null - filterExpression: - type: array - example: null - items: - $ref: '#/components/schemas/CriterionDto' - limit: - type: integer - format: int32 - example: null - offset: - type: integer - format: int32 - example: null - sortField: - type: string - example: null - sortOrder: - type: string - enum: - - ASC - - DESC - example: null - TerminateTransferDto: - type: object - example: null - properties: - reason: - type: string - example: null - required: - - reason - TransferProcessDto: - type: object - example: null - properties: - callbackAddresses: - type: array - example: null - items: - $ref: '#/components/schemas/CallbackAddress' - createdAt: - type: integer - format: int64 - example: null - dataDestination: - $ref: '#/components/schemas/DataAddressInformationDto' - dataRequest: - $ref: '#/components/schemas/DataRequestDto' - errorDetail: - type: string - example: null - id: - type: string - example: null - state: - type: string - example: null - stateTimestamp: - type: integer - format: int64 - example: null - type: - type: string - example: null - updatedAt: - type: integer - format: int64 - example: null - TransferRequestDto: - type: object - example: null - properties: - assetId: - type: string - example: null - callbackAddresses: - type: array - example: null - items: - $ref: '#/components/schemas/CallbackAddressDto' - connectorAddress: - type: string - example: null - connectorId: - type: string - example: null - contractId: - type: string - example: null - dataDestination: - $ref: '#/components/schemas/DataAddress' - id: - type: string - example: null - managedResources: - type: boolean - example: null - properties: - type: object - additionalProperties: - type: string - example: null - example: null - protocol: - type: string - example: null - transferType: - $ref: '#/components/schemas/TransferType' - required: - - assetId - - connectorAddress - - connectorId - - contractId - - dataDestination - - protocol - - transferType - TransferState: - type: object - example: null - properties: - state: - type: string - example: null - TransferType: - type: object - example: null - properties: - contentType: - type: string - example: null - isFinite: - type: boolean - example: null diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/irs/irs-v1.0.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/irs/irs-v1.0.yaml deleted file mode 100644 index e50ecb745c2..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/irs/irs-v1.0.yaml +++ /dev/null @@ -1,2042 +0,0 @@ -openapi: 3.0.1 -info: - description: The API of the Item Relationship Service (IRS) for retrieving item - graphs along the value chain of CATENA-X partners. - title: IRS API - version: "2.0" -servers: - - url: http://localhost:8080 -security: - - oAuth2: - - profile email -paths: - /ess/bpn/investigations: - post: - description: Registers an IRS job to start an investigation if a given bpn is - contained in a part chain of a given globalAssetId. - operationId: registerBPNInvestigation - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterBpnInvestigationJob' - required: true - responses: - "201": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/job-handle' - schema: - $ref: '#/components/schemas/JobHandle' - description: Returns id of registered job. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Job registration failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - security: - - oAuth2: - - profile email - summary: Registers an IRS job to start an investigation if a given bpn is contained - in a part chain of a given globalAssetId. - tags: - - Environmental- and Social Standards - /ess/bpn/investigations/{id}: - get: - description: Return job with additional supplyChainImpacted information. - operationId: getBPNInvestigation - parameters: - - description: Id of the job. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: id - required: true - schema: - type: string - format: uuid - responses: - "200": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/complete-job-result' - schema: - $ref: '#/components/schemas/Jobs' - description: Return job with item graph for the requested id. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Return job failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - "404": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-404' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Job with the requested jobId not found. - security: - - oAuth2: - - profile email - summary: Return job with additional supplyChainImpacted information. - tags: - - Environmental- and Social Standards - /ess/notification/receive: - post: - description: Accepts notifications via EDC. Notifications are filtered by their - type and processed accordingly. - operationId: receiveEdcNotification - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/EdcNotification' - required: true - responses: - "200": - description: Notification received successfully. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Notification malformed. - summary: Accepts notifications sent via EDC. - tags: - - Environmental- and Social Standards - /irs/jobs: - get: - description: Returns paginated jobs with state and execution times. - operationId: getJobsByJobStates - parameters: - - description: Requested job states. - explode: false - in: query - name: states - required: false - schema: - type: array - items: - type: string - enum: - - UNSAVED - - INITIAL - - RUNNING - - TRANSFERS_FINISHED - - COMPLETED - - CANCELED - - ERROR - maxItems: 2147483647 - - description: Zero-based page index (0..N) - in: query - name: page - schema: - type: integer - default: 0 - - description: The size of the page to be returned - in: query - name: size - schema: - type: integer - default: 20 - - description: "Sorting criteria in the format: property,(asc|desc). Default\ - \ sort order is ascending. Multiple sort criteria are supported." - in: query - name: sort - schema: - type: array - items: - type: string - responses: - "200": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/complete-job-list-processing-state' - schema: - $ref: '#/components/schemas/PageResult' - description: Paginated list of jobs with state and execution times for requested - job states. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Return jobs for requested job states failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - security: - - oAuth2: - - profile email - summary: Returns paginated jobs with state and execution times. - tags: - - Item Relationship Service - post: - description: "Register an IRS job to retrieve an item graph for given {globalAssetId}." - operationId: registerJobForGlobalAssetId - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterJob' - required: true - responses: - "201": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/job-handle' - schema: - $ref: '#/components/schemas/JobHandle' - description: Returns id of registered job. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Job registration failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - security: - - oAuth2: - - profile email - summary: "Register an IRS job to retrieve an item graph for given {globalAssetId}." - tags: - - Item Relationship Service - /irs/jobs/{id}: - get: - description: Return job with optional item graph result for requested id. - operationId: getJobForJobId - parameters: - - description: Id of the job. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: id - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 - - description: " Return job with current processed item graph. \ - \ Return job with item graph if job is in state , otherwise job." - in: query - name: returnUncompletedJob - required: false - schema: - type: boolean - default: true - responses: - "200": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/complete-job-result' - schema: - $ref: '#/components/schemas/Jobs' - description: Return job with item graph for the requested id. - "206": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/partial-job-result' - schema: - $ref: '#/components/schemas/Jobs' - description: Return job with current processed item graph for the requested - id. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Return job failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - "404": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-404' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Job with the requested jobId not found. - security: - - oAuth2: - - profile email - summary: Return job with optional item graph result for requested id. - tags: - - Item Relationship Service - put: - description: Cancel job for requested jobId. - operationId: cancelJobByJobId - parameters: - - description: Id of the job. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: id - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 - responses: - "200": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/canceled-job-response' - schema: - $ref: '#/components/schemas/Job' - description: Job with requested jobId canceled. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Cancel job failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - "404": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-404' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Job for requested jobId not found. - security: - - oAuth2: - - profile email - summary: Cancel job for requested jobId. - tags: - - Item Relationship Service - /irs/aspectmodels: - get: - description: Get all available aspect models from semantic hub or local models. - operationId: getAllAspectModels - responses: - "200": - content: - application/json: - examples: - complete: - $ref: "#/components/examples/aspect-models-list" - schema: - $ref: "#/components/schemas/AspectModels" - description: Returns all available aspect models. - "401": - content: - application/json: - examples: - error: - $ref: "#/components/examples/error-response-401" - schema: - $ref: "#/components/schemas/ErrorResponse" - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: "#/components/examples/error-response-403" - schema: - $ref: "#/components/schemas/ErrorResponse" - description: Authorization refused by server. - security: - - oAuth2: - - profile email - summary: Get all available aspect models from semantic hub or local models. - tags: - - Aspect Models - /irs/orders: - post: - description: "Registers an IRS order with an array of {globalAssetIds}.\ - \ Each globalAssetId will be processed in an IRS Job, grouped in batches." - operationId: registerOrder - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterBatchOrder' - required: true - responses: - "201": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/job-handle' - schema: - $ref: '#/components/schemas/BatchOrderCreated' - description: Returns orderId of registered Batch order. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Batch Order registration failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - security: - - oAuth2: - - profile email - summary: "Registers an IRS order with an array of {globalAssetIds}.\ - \ Each globalAssetId will be processed in an IRS Job, grouped in batches." - tags: - - Item Relationship Service - /irs/orders/{orderId}: - get: - description: Get a batch order for a given orderId. - operationId: getBatchOrder - parameters: - - description: Id of the order. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: orderId - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 - responses: - "200": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/complete-order-result' - schema: - $ref: '#/components/schemas/BatchOrderResponse' - description: Get a batch order for a given orderId. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Return Batch Order failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - "404": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-404' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Batch Order with the requested orderId not found. - security: - - oAuth2: - - profile email - summary: Get a batch order for a given orderId. - tags: - - Item Relationship Service - put: - description: Cancel a batch order for a given orderId. - operationId: cancelBatchOrder - parameters: - - description: Id of the order. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: orderId - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 - responses: - "200": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/complete-order-result' - schema: - $ref: '#/components/schemas/BatchOrderResponse' - description: Cancel a batch order for a given orderId. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Return Batch Order failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - "404": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-404' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Batch Order with the requested orderId not found. - security: - - oAuth2: - - profile email - summary: Cancel a batch order for a given orderId. - tags: - - Item Relationship Service - /irs/orders/{orderId}/batches/{batchId}: - get: - description: Get a batch with a given batchId for a given orderId. - operationId: getBatch - parameters: - - description: Id of the order. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: orderId - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 - - description: Id of the batch. - example: 4bce40b8-64c7-41bf-9ca3-e9432c7fef98 - in: path - name: batchId - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 - responses: - "200": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/complete-batch-result' - schema: - $ref: '#/components/schemas/BatchResponse' - description: Get a batch with a given batchId for a given orderId. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Return batch failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - "404": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-404' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Batch with the requested orderId and batchId not found. - security: - - oAuth2: - - profile email - summary: Get a batch with a given batchId for a given orderId. - tags: - - Item Relationship Service -components: - examples: - canceled-job-response: - value: - completedOn: 2022-02-03T14:48:54.709Z - globalAssetId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - id: 6c311d29-5753-46d4-b32c-19b918ea93b0 - lastModifiedOn: 2022-02-03T14:48:54.709Z - startedOn: 2022-02-03T14:48:54.709Z - state: CANCELED - canceled-job-result: - value: - bpns: [ ] - job: - completedOn: 2022-02-03T14:48:54.709Z - createdOn: 2022-02-03T14:48:54.709Z - exception: - errorDetail: Timeout while requesting Digital Registry - exception: IrsTimeoutException - exceptionDate: 2022-02-03T14:48:54.709Z - globalAssetId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - id: e5347c88-a921-11ec-b909-0242ac120002 - lastModifiedOn: 2022-02-03T14:48:54.709Z - owner: "" - parameter: - aspects: - - SerialPartTypization - - AddressAspect - bomLifecycle: asBuilt - collectAspects: false - depth: 1 - direction: downward - lookupBPNs: false - startedOn: 2022-02-03T14:48:54.709Z - state: CANCELED - summary: - asyncFetchedItems: - completed: 0 - failed: 0 - running: 0 - relationships: [ ] - submodels: [ ] - tombstones: [ ] - complete-batch-result: - value: - batchId: f253718e-a270-4367-901b-9d50d9bd8462 - batchNumber: 1 - batchProcessingState: COMPLETED - batchTotal: 1 - completedOn: 2022-02-03T14:48:54.709Z - jobs: - - completedOn: 2022-02-03T14:48:54.709Z - id: 6c311d29-5753-46d4-b32c-19b918ea93b0 - startedOn: 2022-02-03T14:48:54.709Z - state: COMPLETED - jobsInBatchChecksum: 1 - orderId: f253718e-a270-4367-901b-9d50d9bd8462 - startedOn: 2022-02-03T14:48:54.709Z - totalJobs: 1 - complete-job-list-processing-state: - value: - content: - - completedOn: 2022-02-03T14:48:54.709Z - id: 6c311d29-5753-46d4-b32c-19b918ea93b0 - startedOn: 2022-02-03T14:48:54.709Z - state: COMPLETED - pageCount: 1 - pageNumber: 0 - pageSize: 10 - totalElements: 1 - complete-job-result: - value: - bpns: - - manufacturerId: BPNL00000003AYRE - manufacturerName: OEM A - job: - completedOn: 2022-02-03T14:48:54.709Z - createdOn: 2022-02-03T14:48:54.709Z - exception: - errorDetail: Timeout while requesting Digital Registry - exception: IrsTimeoutException - exceptionDate: 2022-02-03T14:48:54.709Z - globalAssetId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - id: e5347c88-a921-11ec-b909-0242ac120002 - lastModifiedOn: 2022-02-03T14:48:54.709Z - owner: "" - parameter: - aspects: - - SerialPartTypization - - AddressAspect - bomLifecycle: asBuilt - collectAspects: false - depth: 1 - direction: downward - lookupBPNs: false - startedOn: 2022-02-03T14:48:54.709Z - state: COMPLETED - summary: - asyncFetchedItems: - completed: 0 - failed: 0 - running: 0 - relationships: - - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - linkedItem: - assembledOn: 2022-02-03T14:48:54.709Z - childCatenaXId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 - lastModifiedOn: 2022-02-03T14:48:54.709Z - lifecycleContext: asBuilt - quantity: - measurementUnit: - datatypeURI: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece - lexicalValue: piece - quantityNumber: 1.0 - shells: - - description: - - language: en - text: The shell for a vehicle - globalAssetId: - value: - - urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 - idShort: future concept x - identification: 882fc530-b69b-4707-95f6-5dbc5e9baaa8 - specificAssetIds: - - key: engineserialid - value: "12309481209312" - submodelDescriptors: - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - endpointAddress: https://catena-x.net/vehicle/basedetails/ - endpointProtocol: HTTPS - endpointProtocolVersion: "1.0" - idShort: vehicle base details - identification: 4a738a24-b7d8-4989-9cd6-387772f40565 - semanticId: - value: - - urn:bamm:com.catenax.vehicle:0.1.1 - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - endpointAddress: https://catena-x.net/vehicle/partdetails/ - endpointProtocol: HTTPS - endpointProtocolVersion: "1.0" - idShort: vehicle part details - identification: dae4d249-6d66-4818-b576-bf52f3b9ae90 - semanticId: - value: - - urn:bamm:com.catenax.vehicle:0.1.1#PartDetails - submodels: - - aspectType: urn:bamm:io.catenax.assembly_part_relationship:1.0.0 - identification: urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff - payload: - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - childParts: - - createdOn: 2022-02-03T14:48:54.709Z - childCatenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - lastModifiedOn: 2022-02-03T14:48:54.709Z - lifecycleContext: AsBuilt - quantity: - measurementUnit: - datatypeURI: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece - lexicalValue: piece - quantityNumber: 1 - tombstones: - - catenaXId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - endpointURL: https://catena-x.net/vehicle/partdetails/ - processingError: - errorDetail: Details to reason of Failure - lastAttempt: 2022-02-03T14:48:54.709Z - processStep: SchemaValidation - retryCounter: 0 - complete-order-result: - value: - batchChecksum: 1 - batches: - - batchId: f253718e-a270-4367-901b-9d50d9bd8462 - batchNumber: 1 - batchProcessingState: PARTIAL - batchUrl: https://../irs/orders/f253718e-a270-4367-901b-9d50d9bd8462/batches/f253718e-a270-4367-901b-9d50d9bd8462 - jobsInBatchChecksum: 1 - orderId: f253718e-a270-4367-901b-9d50d9bd8462 - state: COMPLETED - error-response-400: - value: - error: Bad request - messages: - - BadRequestException - statusCode: 400 BAD_REQUEST - error-response-401: - value: - error: Unauthorized - messages: - - UnauthorizedException - statusCode: 401 UNAUTHORIZED - error-response-403: - value: - error: Forbidden - messages: - - ForbiddenException - statusCode: 403 FORBIDDEN - error-response-404: - value: - error: Not found - messages: - - NotFoundException - statusCode: 404 NOT_FOUND - failed-job-result: - value: - bpns: [ ] - job: - createdOn: 2022-02-03T14:48:54.709Z - exception: - errorDetail: Timeout while requesting Digital Registry - exception: IrsTimeoutException - exceptionDate: 2022-02-03T14:48:54.709Z - globalAssetId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - id: e5347c88-a921-11ec-b909-0242ac120002 - lastModifiedOn: 2022-02-03T14:48:54.709Z - owner: "" - parameter: - aspects: - - SerialPartTypization - - AddressAspect - bomLifecycle: asBuilt - collectAspects: false - depth: 1 - direction: downward - lookupBPNs: false - startedOn: 2022-02-03T14:48:54.709Z - state: ERROR - summary: - asyncFetchedItems: - completed: 0 - failed: 0 - running: 0 - relationships: [ ] - submodels: [ ] - tombstones: [ ] - job-handle: - value: - id: 6c311d29-5753-46d4-b32c-19b918ea93b0 - job-result-without-uncompleted-result-tree: - value: - bpns: - - manufacturerId: BPNL00000003AYRE - manufacturerName: OEM A - job: - completedOn: 2022-02-03T14:48:54.709Z - createdOn: 2022-02-03T14:48:54.709Z - exception: - errorDetail: Timeout while requesting Digital Registry - exception: IrsTimeoutException - exceptionDate: 2022-02-03T14:48:54.709Z - globalAssetId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - id: e5347c88-a921-11ec-b909-0242ac120002 - lastModifiedOn: 2022-02-03T14:48:54.709Z - owner: "" - parameter: - aspects: - - SerialPartTypization - - AddressAspect - bomLifecycle: asBuilt - collectAspects: false - depth: 1 - direction: downward - lookupBPNs: false - startedOn: 2022-02-03T14:48:54.709Z - state: COMPLETED - summary: - asyncFetchedItems: - completed: 0 - failed: 0 - running: 0 - relationships: - - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - linkedItem: - assembledOn: 2022-02-03T14:48:54.709Z - childCatenaXId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 - lastModifiedOn: 2022-02-03T14:48:54.709Z - lifecycleContext: asBuilt - quantity: - measurementUnit: - datatypeURI: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece - lexicalValue: piece - quantityNumber: 1.0 - shells: - - description: - - language: en - text: The shell for a vehicle - globalAssetId: - value: - - urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 - idShort: future concept x - identification: 882fc530-b69b-4707-95f6-5dbc5e9baaa8 - specificAssetIds: - - key: engineserialid - value: "12309481209312" - submodelDescriptors: - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - endpointAddress: https://catena-x.net/vehicle/basedetails/ - endpointProtocol: HTTPS - endpointProtocolVersion: "1.0" - idShort: vehicle base details - identification: 4a738a24-b7d8-4989-9cd6-387772f40565 - semanticId: - value: - - urn:bamm:com.catenax.vehicle:0.1.1 - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - endpointAddress: https://catena-x.net/vehicle/partdetails/ - endpointProtocol: HTTPS - endpointProtocolVersion: "1.0" - idShort: vehicle part details - identification: dae4d249-6d66-4818-b576-bf52f3b9ae90 - semanticId: - value: - - urn:bamm:com.catenax.vehicle:0.1.1#PartDetails - submodels: - - aspectType: urn:bamm:io.catenax.assembly_part_relationship:1.0.0 - identification: urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff - payload: - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - childParts: - - createdOn: 2022-02-03T14:48:54.709Z - childCatenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - lastModifiedOn: 2022-02-03T14:48:54.709Z - lifecycleContext: AsBuilt - quantity: - measurementUnit: - datatypeURI: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece - lexicalValue: piece - quantityNumber: 1 - tombstones: - - catenaXId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - endpointURL: https://catena-x.net/vehicle/partdetails/ - processingError: - errorDetail: Details to reason of Failure - lastAttempt: 2022-02-03T14:48:54.709Z - processStep: SchemaValidation - retryCounter: 0 - partial-job-result: - value: - bpns: [ ] - job: - completedOn: 2022-02-03T14:48:54.709Z - createdOn: 2022-02-03T14:48:54.709Z - exception: - errorDetail: Timeout while requesting Digital Registry - exception: IrsTimeoutException - exceptionDate: 2022-02-03T14:48:54.709Z - globalAssetId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - id: e5347c88-a921-11ec-b909-0242ac120002 - lastModifiedOn: 2022-02-03T14:48:54.709Z - owner: "" - parameter: - aspects: - - SerialPartTypization - - AddressAspect - bomLifecycle: asBuilt - collectAspects: false - depth: 1 - direction: downward - lookupBPNs: false - startedOn: 2022-02-03T14:48:54.709Z - state: RUNNING - summary: - asyncFetchedItems: - completed: 0 - failed: 0 - running: 0 - relationships: [ ] - submodels: [ ] - tombstones: [ ] - aspect-models-list: - value: - lastUpdated: 2023-02-13T08:18:11.990659500Z - models: - - urn: urn:bamm:io.catenax.assembly_part_relationship:1.1.1#AssemblyPartRelationship - name: AssemblyPartRelationship - status: RELEASED - type: BAMM - version: 1.1.1 - - urn: urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization - name: SerialPartTypization - status: RELEASED - type: BAMM - version: 1.1.0 - schemas: - AdministrativeInformation: - type: object - additionalProperties: false - properties: - revision: - type: string - version: - type: string - AssetAdministrationShellDescriptor: - type: object - additionalProperties: false - description: AAS shells. - properties: - administration: - $ref: '#/components/schemas/AdministrativeInformation' - description: - type: array - items: - $ref: '#/components/schemas/LangString' - maxItems: 2147483647 - globalAssetId: - $ref: '#/components/schemas/Reference' - idShort: - type: string - identification: - type: string - specificAssetIds: - type: array - items: - $ref: '#/components/schemas/IdentifierKeyValuePair' - maxItems: 2147483647 - submodelDescriptors: - type: array - items: - $ref: '#/components/schemas/SubmodelDescriptor' - maxItems: 2147483647 - AsyncFetchedItems: - type: object - additionalProperties: false - description: Statistics of job execution. - properties: - completed: - type: integer - format: int32 - description: Number of completed item transfers. - maximum: 2147483647 - minimum: 0 - failed: - type: integer - format: int32 - description: Number of failed item transfers. - maximum: 2147483647 - minimum: 0 - running: - type: integer - format: int32 - description: Number of running item transfers. - maximum: 2147483647 - minimum: 0 - BatchOrderCreated: - type: object - additionalProperties: false - properties: - id: - type: string - format: uuid - description: Id of the Batch Order. - BatchOrderResponse: - type: object - additionalProperties: false - description: BatchOrderAck Payload Response. - properties: - batchChecksum: - type: integer - format: int32 - description: Expected number of batches in order. - batches: - type: array - description: Array of batches. - items: - $ref: '#/components/schemas/BatchResponse' - maxItems: 2147483647 - orderId: - type: string - format: uuid - description: Id of the order. - maxLength: 36 - minLength: 36 - pattern: "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i" - state: - type: string - description: The state of the order. - enum: - - INITIALIZED - - COMPLETED - - PROCESSING - - PARTIAL - - ERROR - BatchResponse: - type: object - additionalProperties: false - description: Batch model. - properties: - batchId: - type: string - format: uuid - description: Id of the batch. - maxLength: 36 - minLength: 36 - pattern: "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i" - batchNumber: - type: integer - format: int32 - description: Sequential number begins with first (1.) batch. - batchProcessingState: - type: string - description: The state of the batch. - enum: - - INITIALIZED - - COMPLETED - - PROCESSING - - PARTIAL - - ERROR - batchTotal: - type: integer - format: int32 - description: The total number of batches. - completedOn: - type: string - format: date-time - jobs: - type: array - description: Array of jobs. - items: - $ref: '#/components/schemas/JobStatusResult' - maxItems: 2147483647 - jobsInBatchChecksum: - type: integer - format: int32 - description: Expected number of jobs in batch. - orderId: - type: string - format: uuid - description: Id of the order. - maxLength: 36 - minLength: 36 - pattern: "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i" - startedOn: - type: string - format: date-time - totalJobs: - type: integer - format: int32 - description: Total amount of jobs inside the order. - Bpn: - type: object - additionalProperties: false - description: Business partner id with name - properties: - manufacturerId: - type: string - manufacturerName: - type: string - EdcNotification: - type: object - additionalProperties: false - properties: - content: - type: object - additionalProperties: - type: object - header: - $ref: '#/components/schemas/EdcNotificationHeader' - required: - - content - - header - EdcNotificationHeader: - type: object - additionalProperties: false - description: EDC notification header information - properties: - notificationId: - type: string - notificationType: - type: string - originalNotificationId: - type: string - recipientBpn: - type: string - replyAssetId: - type: string - replyAssetSubPath: - type: string - senderBpn: - type: string - senderEdc: - type: string - required: - - notificationId - - notificationType - - recipientBpn - - senderBpn - Endpoint: - type: object - additionalProperties: false - properties: - interface: - type: string - protocolInformation: - $ref: '#/components/schemas/ProtocolInformation' - ErrorResponse: - type: object - additionalProperties: false - description: Error response. - properties: - error: - type: string - description: Error. - messages: - type: array - description: List of error messages. - items: - type: string - maxItems: 2147483647 - statusCode: - type: string - description: Error code. - enum: - - 100 CONTINUE - - 101 SWITCHING_PROTOCOLS - - 102 PROCESSING - - 103 EARLY_HINTS - - 103 CHECKPOINT - - 200 OK - - 201 CREATED - - 202 ACCEPTED - - 203 NON_AUTHORITATIVE_INFORMATION - - 204 NO_CONTENT - - 205 RESET_CONTENT - - 206 PARTIAL_CONTENT - - 207 MULTI_STATUS - - 208 ALREADY_REPORTED - - 226 IM_USED - - 300 MULTIPLE_CHOICES - - 301 MOVED_PERMANENTLY - - 302 FOUND - - 302 MOVED_TEMPORARILY - - 303 SEE_OTHER - - 304 NOT_MODIFIED - - 305 USE_PROXY - - 307 TEMPORARY_REDIRECT - - 308 PERMANENT_REDIRECT - - 400 BAD_REQUEST - - 401 UNAUTHORIZED - - 402 PAYMENT_REQUIRED - - 403 FORBIDDEN - - 404 NOT_FOUND - - 405 METHOD_NOT_ALLOWED - - 406 NOT_ACCEPTABLE - - 407 PROXY_AUTHENTICATION_REQUIRED - - 408 REQUEST_TIMEOUT - - 409 CONFLICT - - 410 GONE - - 411 LENGTH_REQUIRED - - 412 PRECONDITION_FAILED - - 413 PAYLOAD_TOO_LARGE - - 413 REQUEST_ENTITY_TOO_LARGE - - 414 URI_TOO_LONG - - 414 REQUEST_URI_TOO_LONG - - 415 UNSUPPORTED_MEDIA_TYPE - - 416 REQUESTED_RANGE_NOT_SATISFIABLE - - 417 EXPECTATION_FAILED - - 418 I_AM_A_TEAPOT - - 419 INSUFFICIENT_SPACE_ON_RESOURCE - - 420 METHOD_FAILURE - - 421 DESTINATION_LOCKED - - 422 UNPROCESSABLE_ENTITY - - 423 LOCKED - - 424 FAILED_DEPENDENCY - - 425 TOO_EARLY - - 426 UPGRADE_REQUIRED - - 428 PRECONDITION_REQUIRED - - 429 TOO_MANY_REQUESTS - - 431 REQUEST_HEADER_FIELDS_TOO_LARGE - - 451 UNAVAILABLE_FOR_LEGAL_REASONS - - 500 INTERNAL_SERVER_ERROR - - 501 NOT_IMPLEMENTED - - 502 BAD_GATEWAY - - 503 SERVICE_UNAVAILABLE - - 504 GATEWAY_TIMEOUT - - 505 HTTP_VERSION_NOT_SUPPORTED - - 506 VARIANT_ALSO_NEGOTIATES - - 507 INSUFFICIENT_STORAGE - - 508 LOOP_DETECTED - - 509 BANDWIDTH_LIMIT_EXCEEDED - - 510 NOT_EXTENDED - - 511 NETWORK_AUTHENTICATION_REQUIRED - IdentifierKeyValuePair: - type: object - additionalProperties: false - properties: - key: - type: string - semanticId: - $ref: '#/components/schemas/Reference' - subjectId: - $ref: '#/components/schemas/Reference' - value: - type: string - Job: - type: object - additionalProperties: false - description: Executable unit with meta information and item graph result. - properties: - completedOn: - type: string - format: date-time - createdOn: - type: string - format: date-time - exception: - $ref: '#/components/schemas/JobErrorDetails' - globalAssetId: - type: string - description: Part global unique id in the format urn:uuid:uuid4. - example: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - maxLength: 45 - minLength: 45 - pattern: "^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - id: - type: string - format: uuid - description: Id of the job. - maxLength: 36 - minLength: 36 - pattern: "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i" - lastModifiedOn: - type: string - format: date-time - owner: - type: string - description: The IRS api consumer. - parameter: - $ref: '#/components/schemas/JobParameter' - startedOn: - type: string - format: date-time - state: - type: string - enum: - - UNSAVED - - INITIAL - - RUNNING - - TRANSFERS_FINISHED - - COMPLETED - - CANCELED - - ERROR - summary: - $ref: '#/components/schemas/Summary' - required: - - globalAssetId - - id - - state - JobErrorDetails: - type: object - additionalProperties: false - description: Job error details. - properties: - errorDetail: - type: string - description: Detailed exception information. - maxLength: 4000 - exception: - type: string - description: Exception name. - maxLength: 100 - exceptionDate: - type: string - format: date-time - description: Datetime error occurs. - JobHandle: - type: object - additionalProperties: false - properties: - id: - type: string - format: uuid - description: Id of the job. - maxLength: 36 - minLength: 36 - pattern: "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i" - JobParameter: - type: object - additionalProperties: false - description: Job parameter of job processing. - properties: - aspects: - type: string - bomLifecycle: - type: string - description: The lifecycle context in which the child part was assembled - into the parent part. - enum: - - asBuilt - - asPlanned - callbackUrl: - type: string - collectAspects: - type: boolean - depth: - type: integer - format: int32 - maximum: 2147483647 - minimum: 0 - direction: - type: string - description: Item graph traversal direction. - enum: - - upward - - downward - lookupBPNs: - type: boolean - JobStatusResult: - type: object - additionalProperties: false - properties: - completedOn: - type: string - format: date-time - id: - type: string - format: uuid - startedOn: - type: string - format: date-time - state: - type: string - enum: - - UNSAVED - - INITIAL - - RUNNING - - TRANSFERS_FINISHED - - COMPLETED - - CANCELED - - ERROR - Jobs: - type: object - additionalProperties: false - description: Container for a job with item graph. - properties: - bpns: - type: array - description: Collection of bpn mappings - items: - $ref: '#/components/schemas/Bpn' - maxItems: 2147483647 - uniqueItems: true - job: - $ref: '#/components/schemas/Job' - relationships: - type: array - description: Relationships between parent and child items. - items: - $ref: '#/components/schemas/Relationship' - maxItems: 2147483647 - shells: - type: array - description: AAS shells. - items: - $ref: '#/components/schemas/AssetAdministrationShellDescriptor' - maxItems: 2147483647 - submodels: - type: array - description: Collection of requested Submodels - items: - $ref: '#/components/schemas/Submodel' - maxItems: 2147483647 - tombstones: - type: array - description: Collection of not resolvable endpoints as tombstones. Including - cause of error and endpoint URL. - items: - $ref: '#/components/schemas/Tombstone' - maxItems: 2147483647 - LangString: - type: object - additionalProperties: false - properties: - language: - type: string - text: - type: string - LinkedItem: - type: object - additionalProperties: false - description: Set of child parts the parent object is assembled by (one structural - level down). - properties: - assembledOn: - type: string - format: date-time - description: Datetime of assembly. - childCatenaXId: - type: string - description: CatenaX child global asset id in the format urn:uuid:uuid4. - example: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - maxLength: 45 - minLength: 45 - pattern: "^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - lastModifiedOn: - type: string - format: date-time - description: Last datetime item was modified. - lifecycleContext: - type: string - description: The lifecycle context in which the child part was assembled - into the parent part. - enum: - - asBuilt - - asPlanned - quantity: - $ref: '#/components/schemas/Quantity' - MeasurementUnit: - type: object - additionalProperties: false - properties: - datatypeURI: - type: string - lexicalValue: - type: string - PageResult: - type: object - additionalProperties: false - properties: - content: - type: array - items: - $ref: '#/components/schemas/JobStatusResult' - pageCount: - type: integer - format: int32 - pageNumber: - type: integer - format: int32 - pageSize: - type: integer - format: int32 - totalElements: - type: integer - format: int32 - ProcessingError: - type: object - additionalProperties: false - properties: - errorDetail: - type: string - lastAttempt: - type: string - format: date-time - processStep: - type: string - enum: - - SubmodelRequest - - DigitalTwinRequest - - SchemaValidation - - SchemaRequest - - BpdmRequest - - BpdmValidation - - UsagePolicyValidation - retryCounter: - type: integer - format: int32 - maximum: 2147483647 - minimum: 0 - ProtocolInformation: - type: object - additionalProperties: false - properties: - endpointAddress: - type: string - endpointProtocol: - type: string - endpointProtocolVersion: - type: string - subprotocol: - type: string - subprotocolBody: - type: string - subprotocolBodyEncoding: - type: string - Quantity: - type: object - additionalProperties: false - description: Quantity component. - properties: - measurementUnit: - $ref: '#/components/schemas/MeasurementUnit' - quantityNumber: - type: number - format: double - maximum: 2147483647 - minimum: 0 - Reference: - type: object - additionalProperties: false - properties: - value: - type: array - items: - type: string - maxItems: 2147483647 - RegisterBatchOrder: - type: object - additionalProperties: false - description: Request body for registering a new Batch Order. - properties: - aspects: - type: array - items: - type: string - maxItems: 2147483647 - batchSize: - type: integer - format: int32 - default: 20 - description: Size of the batch. - maximum: 100 - minimum: 10 - batchStrategy: - type: string - description: The strategy how the batch is processed internally in IRS. - enum: - - PRESERVE_BATCH_JOB_ORDER - - PRESERVE_JOB_ORDER - - PRESERVE_BATCH_ORDER - bomLifecycle: - type: string - description: The lifecycle context in which the child part was assembled - into the parent part. - enum: - - asBuilt - - asPlanned - callbackUrl: - type: string - description: "Callback url to notify requestor when job processing is finished.\ - \ There are four uri variable placeholders that can be used: orderId,\ - \ batchId, orderState and batchState." - example: "https://hostname.com/callback?orderId={orderId}&batchId={batchId}&orderState={orderState}&batchState={batchState}" - collectAspects: - type: boolean - description: Flag to specify whether aspects should be requested and collected. - Default is false. - depth: - type: integer - format: int32 - description: Max depth of the item graph returned. If no depth is set item - graph with max depth is returned. - maximum: 100 - minimum: 1 - direction: - type: string - default: downward - description: Item graph traversal direction. - enum: - - upward - - downward - globalAssetIds: - type: array - items: - type: string - maxItems: 2147483647 - jobTimeout: - type: integer - format: int32 - default: 3600 - description: Timeout in seconds for each job processing inside the complete - order. - maximum: 7200 - minimum: 60 - lookupBPNs: - type: boolean - description: Flag to specify whether BPNs should be collected and resolved - via the configured BPDM URL. Default is false. - timeout: - type: integer - format: int32 - default: 43200 - description: Timeout in seconds for the complete batch order processing. - maximum: 86400 - minimum: 60 - required: - - globalAssetIds - RegisterBpnInvestigationJob: - type: object - additionalProperties: false - description: The requested job definition. - properties: - bomLifecycle: - type: string - description: The lifecycle context in which the child part was assembled - into the parent part. - enum: - - asBuilt - - asPlanned - callbackUrl: - type: string - description: "Callback url to notify requestor when job processing is finished.\ - \ There are two uri variable placeholders that can be used: jobId and\ - \ jobState." - example: "https://hostname.com/callback?jobId={jobId}&jobState={jobState}" - globalAssetId: - type: string - description: Id of global asset. - example: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - maxLength: 45 - minLength: 45 - pattern: "^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - incidentBpns: - type: array - items: - type: string - maxItems: 2147483647 - required: - - globalAssetId - - incidentBpns - RegisterJob: - type: object - additionalProperties: false - description: The requested job definition. - properties: - aspects: - type: array - items: - type: string - maxItems: 2147483647 - bomLifecycle: - type: string - description: The lifecycle context in which the child part was assembled - into the parent part. - enum: - - asBuilt - - asPlanned - callbackUrl: - type: string - description: "Callback url to notify requestor when job processing is finished.\ - \ There are two uri variable placeholders that can be used: id and state." - example: "https://hostname.com/callback?id={id}&state={state}" - collectAspects: - type: boolean - description: Flag to specify whether aspects should be requested and collected. - Default is false. - depth: - type: integer - format: int32 - description: Max depth of the item graph returned. If no depth is set item - graph with max depth is returned. - maximum: 100 - minimum: 1 - direction: - type: string - default: downward - description: Item graph traversal direction. - enum: - - upward - - downward - globalAssetId: - type: string - description: Id of global asset. - example: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - maxLength: 45 - minLength: 45 - pattern: "^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - lookupBPNs: - type: boolean - description: Flag to specify whether BPNs should be collected and resolved - via the configured BPDM URL. Default is false. - required: - - globalAssetId - Relationship: - type: object - additionalProperties: false - description: Relationships between parent and child items. - properties: - aspectType: - type: string - catenaXId: - type: string - description: CATENA-X global asset id in the format urn:uuid:uuid4. - example: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - maxLength: 45 - minLength: 45 - pattern: "^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - linkedItem: - $ref: '#/components/schemas/LinkedItem' - Submodel: - type: object - additionalProperties: false - description: "Submodel with identification of SubmodelDescriptor, aspect type\ - \ and payload as String" - properties: - aspectType: - type: string - identification: - type: string - payload: - type: object - additionalProperties: - type: object - SubmodelDescriptor: - type: object - additionalProperties: false - properties: - administration: - $ref: '#/components/schemas/AdministrativeInformation' - description: - type: array - items: - $ref: '#/components/schemas/LangString' - maxItems: 2147483647 - endpoints: - type: array - items: - $ref: '#/components/schemas/Endpoint' - maxItems: 2147483647 - idShort: - type: string - identification: - type: string - semanticId: - $ref: '#/components/schemas/Reference' - Summary: - type: object - additionalProperties: false - description: Summary of the job with statistics of the job processing. - properties: - asyncFetchedItems: - $ref: '#/components/schemas/AsyncFetchedItems' - bpnLookups: - $ref: '#/components/schemas/AsyncFetchedItems' - Tombstone: - type: object - additionalProperties: false - description: Tombstone with information about request failure - properties: - catenaXId: - type: string - description: CATENA-X global asset id in the format urn:uuid:uuid4. - example: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - maxLength: 45 - minLength: 45 - pattern: "^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - endpointURL: - type: string - processingError: - $ref: '#/components/schemas/ProcessingError' - AspectModel: - type: object - additionalProperties: false - properties: - name: - type: string - status: - type: string - type: - type: string - urn: - type: string - version: - type: string - AspectModels: - type: object - additionalProperties: false - properties: - lastUpdated: - type: string - models: - type: array - items: - $ref: '#/components/schemas/AspectModel' - securitySchemes: - oAuth2: - flows: - clientCredentials: - scopes: - profile email: "" - tokenUrl: https://localhost - type: oauth2 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/traceability/notifications.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/traceability/notifications.yaml deleted file mode 100644 index abb17495be5..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/traceability/notifications.yaml +++ /dev/null @@ -1,333 +0,0 @@ -openapi: 3.0.1 -info: - title: Notification API - description: Notification API - license: - name: Apache License v2.0 - url: http://apache.org/v2 - version: 1.1.0 -servers: -- url: / -tags: -- name: Notification API - description: 'Api to receive, update and fetch a notification. At the moment, quality notifications are supported. Those support two types of quality notifications: quality investigations and quality alerts.' -paths: - /qualitynotifications/receive: - post: - tags: - - Quality notification - description: Receives a new quality notification - operationId: receiveQualityNotification - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QualityNotificationReceiveRequestBody' - responses: - "201": - description: Quality notification was received successfully - "400": - description: Request body was malformed - "401": - description: Not authorized - "403": - description: Forbidden - "405": - description: Method not allowed - "409": - description: Could not accept the send quality notification, because a quality notification with that notificationId already exists - "422": - description: Could not accept the send quality notification even though it is syntactically correct. The quality notification is not accepted, because of semantic reasons (e.g., an affected item is not known by the receiver). - /qualitynotifications/update: - post: - tags: - - Quality notification - description: Updates a quality notification - operationId: updateQualityNotification - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QualityNotificationUpdateRequestBody' - responses: - "200": - description: Quality notification was updated successfully - "400": - description: Request body was malformed - "401": - description: Not authorized - "403": - description: Forbidden - "405": - description: Method not allowed - "404": - description: Could not update the quality notification, because a quality notification with that notificationId does not exist - "422": - description: Could not update the quality notification even though the request is syntactically correct. The quality notification update is not accepted, because of semantic reasons (e.g., status cannot be changed). - /qualitynotifications/resolve: - post: - tags: - - Quality notification - description: Resolves a quality notification - operationId: getQualityNotification - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QualityNotificationGetRequestHeader' - responses: - "200": - description: Quality notification was resolved successfully - content: - application/json: - schema: - $ref: '#/components/schemas/QualityNotificationGetResponseHeader' - "400": - description: Request body was malformed - "401": - description: Not authorized - "403": - description: Forbidden - "404": - description: Could not resolve the quality notification, because a quality notification with that notificationId does not exist - "405": - description: Method not allowed -components: - schemas: - QualityNotificationReceiveRequestHeader: - type: object - required: - - notificationId - - senderBPN - - senderAddress - - recipientBPN - - classification - - severity - - status - - messageId - properties: - notificationId: - type: string - format: uuid - example: "a7954026-3aff-4b6c-92bf-04671ef2fa46" - description: A UUIDv4 to uniquely identify a quality notification. - senderBPN: - type: string - example: "BPNL00000003BW3S" - description: The business partner number (BPN) of the sender. - senderAddress: - type: string - format: uri - example: "https://edc.company-xyz.io/BPNL00000003BW3S" - description: The Eclipse Dataspace Connector (EDC) URL of the sender. - recipientBPN: - type: string - example: "BPNL00000003BV4H" - description: The business partner number (BPN) of the receiver. - classification: - $ref: '#/components/schemas/QualityClassification' - severity: - $ref: '#/components/schemas/QualitySeverity' - relatedNotificationId: - type: string - format: uuid - example: "7895a39d-c4ef-4b75-b39f-cae8207a262f" - description: A UUIDv4 to uniquely identify a related quality notification. - status: - $ref: '#/components/schemas/QualityStatus' - targetDate: - type: string - format: date-time - example: "2022-07-28T14:41:13.214Z" - description: The date and time when a processing of the notification is expected by the sender. - messageId: - type: string - format: uuid - example: "c2801472-5f87-41a7-9a25-b0939c4e0dff" - description: A UUIDv4 to uniquely identify an individual quality notification message. In case of an initial sending of a notification the messageId has to be a newly generated UUIDv4. - QualityNotificationGetResponseHeader: - type: object - required: - - notificationId - - senderBPN - - senderAddress - - recipientBPN - - severity - - status - - messageId - properties: - notificationId: - type: string - format: uuid - example: "a7954026-3aff-4b6c-92bf-04671ef2fa46" - description: A UUIDv4 to uniquely identify a quality notification. - senderBPN: - type: string - example: "BPNL00000003BW3S" - description: The business partner number (BPN) of the sender. - senderAddress: - type: string - format: uri - example: "https://edc.company-xyz.io/BPNL00000003BW3S" - description: The Eclipse Dataspace Connector (EDC) URL of the sender. - recipientBPN: - type: string - example: "BPNL00000003BV4H" - description: The business partner number (BPN) of the receiver. - severity: - $ref: '#/components/schemas/QualitySeverity' - status: - $ref: '#/components/schemas/QualityStatus' - targetDate: - type: string - format: date-time - example: "2022-07-28T14:41:13.214Z" - description: The date and time when a processing of the notification is expected by the sender. - messageId: - type: string - format: uuid - example: "c2801472-5f87-41a7-9a25-b0939c4e0dff" - description: A UUIDv4 to uniquely identify an individual quality notification message. - QualityNotificationUpdateRequestHeader: - type: object - required: - - notificationId - - senderBPN - - senderAddress - - recipientBPN - - status - - messageId - properties: - notificationId: - type: string - format: uuid - example: "a7954026-3aff-4b6c-92bf-04671ef2fa46" - description: A UUIDv4 to uniquely identify a quality notification. Actually, this value cannot be updated. Rather, it is used to do a plausibility check. - senderBPN: - type: string - example: "BPNL00000003BW3S" - description: The business partner number (BPN) of the sender. Actually, this value cannot be updated. Rather, it is used to do a plausibility check. - senderAddress: - type: string - format: uri - example: "https://edc.company-xyz.io/BPNL00000003BW3S" - description: The Eclipse Dataspace Connector (EDC) URL of the sender. Actually, this value cannot be updated. Rather, it is used to do a plausibility check. - recipientBPN: - type: string - example: "BPNL00000003BV4H" - description: The business partner number (BPN) of the receiver. Actually, this value cannot be updated. Rather, it is used to do a plausibility check. - severity: - $ref: '#/components/schemas/QualitySeverity' - status: - $ref: '#/components/schemas/QualityStatus' - targetDate: - type: string - format: date-time - example: "2022-07-28T14:41:13.214Z" - description: The date and time when a processing of the notification is expected by the sender. - messageId: - type: string - format: uuid - example: "c2801472-5f87-41a7-9a25-b0939c4e0dff" - description: A UUIDv4 to uniquely identify an individual quality notification message. In case of an update of a notification the messageId must be a newly generated UUIDv4. It must not be an existing messageId. - QualityNotificationGetRequestHeader: - type: object - required: - - notificationId - - senderBPN - - senderAddress - - recipientBPN - properties: - notificationId: - type: string - format: uuid - example: "a7954026-3aff-4b6c-92bf-04671ef2fa46" - description: A UUIDv4 to uniquely identify a quality notification. - senderBPN: - type: string - example: "BPNL00000003BW3S" - description: The business partner number (BPN) of the sender. Actually, this value is not used to resolve the quality notification. Rather, it is used to do a plausibility check. - senderAddress: - type: string - format: uri - example: "https://edc.company-xyz.io/BPNL00000003BW3S" - description: The Eclipse Dataspace Connector (EDC) URL of the sender. Actually, this value is not used to resolve the quality notification. Rather, it is used to do a plausibility check. - recipientBPN: - type: string - example: "BPNL00000003BV4H" - description: The business partner number (BPN) of the receiver. Actually, this value is not used to resolve the quality notification. Rather, it is used to do a plausibility check. - messageId: - type: string - format: uuid - example: "c2801472-5f87-41a7-9a25-b0939c4e0dff" - description: A UUIDv4 to uniquely identify an individual quality notification message. If this parameter is provided, the message for this messageId is resolved. If this parameter is not provided, then the last available message is resolved. - QualityNotificationReceivePayload: - type: object - required: - - listOfAffectedItems - properties: - information: - type: string - maxLength: 1000 - example: "Gear boxes loose oil while driving." - listOfAffectedItems: - type: array - items: - type: string - example: - - "urn:uuid:57e4e3c1-a6f0-46a0-90df-1fb17cbc157d" - - "urn:uuid:e4da568b-8cf1-4f5f-a96a-cf26265b2c72" - QualityNotificationUpdatePayload: - type: object - properties: - information: - type: string - maxLength: 1000 - example: "Gear boxes loose oil while driving." - QualityNotificationReceiveRequestBody: - required: - - header - - content - type: object - properties: - header: - $ref: '#/components/schemas/QualityNotificationReceiveRequestHeader' - content: - $ref: '#/components/schemas/QualityNotificationReceivePayload' - QualityNotificationUpdateRequestBody: - required: - - header - type: object - properties: - header: - $ref: '#/components/schemas/QualityNotificationUpdateRequestHeader' - content: - $ref: '#/components/schemas/QualityNotificationUpdatePayload' - QualityClassification: - type: string - enum: - - QM-Investigation - - QM-Alert - example: QM-Investigation - description: The classification defines the type of quality notification. - QualitySeverity: - type: string - enum: - - MINOR - - MAJOR - - CRITICAL - - LIFE-THREATENING - example: CRITICAL - description: The severity of the quality notification describes its criticality. - QualityStatus: - type: string - enum: - - CREATED - - SENT - - RECEIVED - - ACKNOWLEDGED - - ACCEPTED - - DECLINED - - CLOSED - example: SENT - description: The status of the quality notification. diff --git a/docs-kits_versioned_docs/version-3.1.0/openApi/traceability/unique-id-push.yaml b/docs-kits_versioned_docs/version-3.1.0/openApi/traceability/unique-id-push.yaml deleted file mode 100644 index 233aacf11d4..00000000000 --- a/docs-kits_versioned_docs/version-3.1.0/openApi/traceability/unique-id-push.yaml +++ /dev/null @@ -1,158 +0,0 @@ -openapi: 3.0.1 -info: - title: Unique ID Push Notification API - description: API documentation for Traceability Unique ID Push Notifications - license: - name: Apache License v2.0 - url: http://apache.org/v2 - version: 1.0.0 -servers: -- url: / -tags: -- name: Catena-X Traceability Unique ID Push Notification - description: 'API to receive Unique ID push notifications for Catena-X Traceability.' -paths: - /uniqueidpush/receive: - post: - tags: - - Unique ID Push Notification - description: Receives a Traceability Unique Id push notification - operationId: receiveUniqueIdPushNotification - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UniqueIdPushNotificationReceiveRequestBody' - responses: - "201": - description: Notification was received successfully - "400": - description: Request body was malformed - "401": - description: Not authorized - "403": - description: Forbidden - "405": - description: Method not allowed - "409": - description: Could not accept the send notification, because a notification with that notificationId already exists - "422": - description: Could not accept the send notification even though it is syntactically correct. The notification is not accepted, because of semantic reasons (e.g., an item is not known by the receiver). -components: - schemas: - UniqueIdPushNotificationReceiveRequestBody: - required: - - header - - content - type: object - properties: - header: - $ref: '#/components/schemas/UniqueIdPushNotificationReceiveRequestHeader' - content: - $ref: '#/components/schemas/UniqueIdPushNotificationReceivePayload' - UniqueIdPushNotificationReceiveRequestHeader: - type: object - required: - - notificationId - - senderBPN - - senderAddress - - recipientBPN - - classification - properties: - notificationId: - type: string - format: uuid - example: "a7954026-3aff-4b6c-92bf-04671ef2fa46" - description: A UUIDv4 to uniquely identify a Unique ID push notification. - senderBPN: - type: string - example: "BPNL00000003BW3S" - description: The business partner number (BPN) of the sender. - senderAddress: - type: string - format: uri - example: "https://edc.company-xyz.io/BPNL00000003BW3S" - description: The Eclipse Dataspace Connector (EDC) URL of the sender. - recipientBPN: - type: string - example: "BPNL00000003BV4H" - description: The business partner number (BPN) of the receiver. - classification: - $ref: '#/components/schemas/UniqueIdPushClassification' - UniqueIdPushNotificationReceivePayload: - type: object - required: - - listOfItems - properties: - information: - type: string - maxLength: 1000 - example: "Update of serialized parts and batches for which digital twins were created." - listOfItems: - type: array - items: - oneOf: - - $ref: '#/components/schemas/SerializedPartItem' - - $ref: '#/components/schemas/BatchItem' - UniqueIdPushClassification: - type: string - enum: - - Child-Relationship - example: Child-Relationship - description: The classification defines the type of the Unique ID push notification. - SerializedPartItem: - type: object - required: - - manufacturerId - - manufacturerPartId - - partInstanceId - - catenaxId - properties: - manufacturerId: - type: string - example: "BPNL00000003BW3S" - description: The Business Partner Number (BPNL) of the manufacturer of the serialized part, i.e., the companies main entry. - manufacturerPartId: - type: string - example: "8840838-04" - description: The ID of the type/catalog part (of which the serialized part is an instance of) from the manufacturer. - customerPartId: - type: string - example: "AAX178378" - description: The ID of the type/catalog part (of which the serialized part is an instance of) from the customer. - partInstanceId: - type: string - example: "NO-009284492099792129568369" - description: The serial number of the serialized part from the manufacturer. We assume here that the customer does not have or create its own serial number for a part, but just used the manufacturer's serial number. - catenaxId: - type: string - example: "urn:uuid:d32d3b55-d222-41e9-8d19-554af53124dd" - description: Catena-X ID for a serialized part. - BatchItem: - type: object - required: - - manufacturerId - - manufacturerPartId - - batchId - - catenaxId - properties: - manufacturerId: - type: string - example: "BPNL00000003BW3S" - description: The Business Partner Number (BPNL) of the manufacturer of the batch, i.e., the companies main entry. - manufacturerPartId: - type: string - example: "8840838-04" - description: The ID of the type/catalog part (of which the batch is an instance of) from the manufacturer. - customerPartId: - type: string - example: "AAX178378" - description: The ID of the type/catalog part (of which the batch is an instance of) from the customer. - batchId: - type: string - example: "NO-009284492099792129568369" - description: The serial number of the batch from the manufacturer. We assume here that the customer does not have or create its own serial number for a batch, but just used the manufacturer's serial number. - catenaxId: - type: string - example: "urn:uuid:d32d3b55-d222-41e9-8d19-554af53124dd" - description: Catena-X ID for a batch. diff --git a/docs-kits_versioned_sidebars/version-23.09-sidebars.json b/docs-kits_versioned_sidebars/version-23.09-sidebars.json deleted file mode 100644 index 99b4f21f5b9..00000000000 --- a/docs-kits_versioned_sidebars/version-23.09-sidebars.json +++ /dev/null @@ -1,902 +0,0 @@ -{ - "kits": [ - { - "type": "category", - "label": "Business Partner KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/Business Partner Kit/Changelog", - "kits/Business Partner Kit/Adoption View", - "kits/Business Partner Kit/Operation View", - { - "type": "category", - "label": "Development View", - "link": { - "type": "generated-index" - }, - "items": [ - "kits/Business Partner Kit/Software Development View/Specification", - { - "type": "category", - "label": "Gate API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate" - }, - { - "type": "category", - "label": "sharing-state-controller", - "link": { - "type": "generated-index", - "title": "sharing-state-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/sharing-state-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-sharing-states", - "label": "Get sharing states (including error info and BPN) for business partners, optionally filtered by LSA type and external ID", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-sharing-state", - "label": "Insert/update sharing state (including error info and BPN) for business partner with LSA type and external ID", - "className": "api-method put" - } - ] - }, - { - "type": "category", - "label": "site-controller", - "link": { - "type": "generated-index", - "title": "site-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/site-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites-output", - "label": "Create or update output sites.", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-sites", - "label": "Get page of sites", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites", - "label": "Create or update sites.", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-sites-output", - "label": "Get page of sites", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-sites-by-external-ids", - "label": "Get page of sites filtered by a collection of externalIds", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-site-by-external-id", - "label": "Get site by external identifier", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "legal-entity-controller", - "link": { - "type": "generated-index", - "title": "legal-entity-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/legal-entity-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities-output", - "label": "Create or update output legal entities.", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities", - "label": "Get page of legal entities", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities", - "label": "Create or update legal entities.", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-output", - "label": "Get page of legal entities", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-by-external-ids", - "label": "Get page of legal-entities filtered by a collection of externalIds", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entity-by-external-id", - "label": "Get legal entity by external identifier", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "address-controller", - "link": { - "type": "generated-index", - "title": "address-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/address-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/put-addresses-output", - "label": "Create or update output addresses.", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-addresses", - "label": "Get page of addresses", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-addresses", - "label": "Create or update addresses.", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-output", - "label": "Get page of addresses (Output)", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-by-external-ids", - "label": "Get page of addresses filtered by a collection of externalIds", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-address-by-external-id", - "label": "Get address by external identifier", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "changelog-controller", - "link": { - "type": "generated-index", - "title": "changelog-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/changelog-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-output-changelog", - "label": "Get business partner changelog entries for changes to the business partner output data", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-input-changelog", - "label": "Get business partner changelog entries for changes to the business partner input data", - "className": "api-method post" - } - ] - } - ] - }, - { - "type": "category", - "label": "Pool API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool" - }, - { - "type": "category", - "label": "site-controller", - "link": { - "type": "generated-index", - "title": "site-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/site-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/update-site", - "label": "Update existing site business partners", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-site", - "label": "Create new site business partners", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-sites", - "label": "Search site partners by BPNs and/or parent BPNs", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-main-addresses", - "label": "Search Main Addresses", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-site", - "label": "Get site partners by bpn", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "legal-entity-controller", - "link": { - "type": "generated-index", - "title": "legal-entity-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/legal-entity-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities", - "label": "Get page of legal entity business partners matching the search criteria", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners", - "label": "Update existing legal entity business partners", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners", - "label": "Create new legal entity business partners", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/set-legal-entity-currentness", - "label": "Confirms that the data of a legal entity business partner is still up to date.", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-sites-1", - "label": "Search legal entity partners by BPNLs", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-legal-addresses", - "label": "Search Legal Addresses", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity", - "label": "Get legal entity business partner by identifier", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-sites", - "label": "Get site partners of a legal entity", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-addresses", - "label": "Get address partners of a legal entity", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "address-controller", - "link": { - "type": "generated-index", - "title": "address-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/address-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1", - "label": "Get page of addresses matching the search criteria", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/update-addresses", - "label": "Update existing address business partners", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-addresses", - "label": "Create new address business partners", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-addresses", - "label": "Search address partners by BPNs and/or parent BPNs", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-address", - "label": "Get address partners by bpna", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "open-search-controller", - "link": { - "type": "generated-index", - "title": "open-search-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/open-search-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-business-partners", - "label": "Fetch information about the latest OpenSearch export", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/export", - "label": "Index new business partner records on OpenSearch", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/clear", - "label": "Clear business partner index on OpenSearch", - "className": "api-method delete" - } - ] - }, - { - "type": "category", - "label": "metadata-controller", - "link": { - "type": "generated-index", - "title": "metadata-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/metadata-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms", - "label": "Get page of legal forms", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form", - "label": "Create new legal form", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types", - "label": "Get page of identifier types filtered by lsaType and (optionally) country (specified by its ISO 3166-1 alpha-2 country code)", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type", - "label": "Create new identifier type", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-field-quality-rules", - "label": "Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code)", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "changelog-controller", - "link": { - "type": "generated-index", - "title": "changelog-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/changelog-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries", - "label": "Get business partner changelog entries from time, by BPN and/or LSA type", - "className": "api-method post" - } - ] - }, - { - "type": "category", - "label": "bpn-controller", - "link": { - "type": "generated-index", - "title": "bpn-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/bpn-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers", - "label": "Find business partner numbers by identifiers", - "className": "api-method post" - } - ] - } - ] - }, - { - "type": "category", - "label": "Bridge Dummy API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Bridge Dummy Api/business-partner-data-management-bridge-dummy" - }, - { - "type": "category", - "label": "bridge-controller", - "link": { - "type": "generated-index", - "title": "bridge-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/bridge-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Bridge Dummy Api/trigger-sync", - "label": "Start sync between Gate and Pool", - "className": "api-method post" - } - ] - } - ] - }, - "kits/Business Partner Kit/Software Development View/Use Cases" - ] - }, - { - "type": "category", - "label": "Success Stories", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Business Partner Kit/Success Stories" - } - ] - }, - { - "type": "category", - "label": "Documentation", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Business Partner Kit/Documentation BPDM" - } - ] - } - ] - }, - { - "type": "category", - "label": "Connector KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/tractusx-edc/CHANGELOG", - "kits/tractusx-edc/docs/kit/adoption-view/Adoption View", - { - "type": "category", - "label": "Development View", - "link": { - "type": "doc", - "id": "kits/tractusx-edc/docs/kit/operation-view/page10_extensions" - }, - "collapsed": true, - "items": [ - "kits/tractusx-edc/docs/README", - "kits/tractusx-edc/docs/kit/adoption-view/Domain Model", - { - "type": "category", - "label": "openAPI", - "collapsed": true, - "items": [ - { - "type": "category", - "label": "management-api-v2-walkthrough", - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/tractusx-edc/docs/samples/management-api-v2-walkthrough" - } - ] - }, - { - "type": "autogenerated", - "dirName": "kits/tractusx-edc/docs/kit/development-view/openAPI" - } - ] - }, - { - "type": "category", - "label": "edc-controlplane", - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/tractusx-edc/edc-controlplane" - } - ] - }, - { - "type": "category", - "label": "edc-dataplane", - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/tractusx-edc/edc-dataplane" - } - ] - }, - { - "type": "category", - "label": "edc-extensions", - "collapsed": true, - "link": { - "type": "doc", - "id": "kits/tractusx-edc/docs/kit/operation-view/page10_extensions" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/tractusx-edc/edc-extensions" - } - ] - }, - "kits/tractusx-edc/core/edr-core/README", - "kits/tractusx-edc/docs/development/Release" - ] - }, - { - "type": "category", - "label": "Operation View", - "link": { - "type": "doc", - "id": "kits/tractusx-edc/docs/kit/operation-view/page00_operation_view" - }, - "collapsed": true, - "items": [ - "kits/tractusx-edc/docs/kit/operation-view/page02_technical_prerequisites", - { - "type": "category", - "label": "Setting up from source", - "collapsed": true, - "items": [ - "kits/tractusx-edc/docs/kit/operation-view/page03_local_setup_controlplane", - "kits/tractusx-edc/docs/kit/operation-view/page04_local_setup_dataplane" - ] - }, - { - "type": "category", - "label": "Deployment via Helm", - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/tractusx-edc/charts" - }, - "kits/tractusx-edc/docs/samples/example-dataspace/README", - "kits/tractusx-edc/docs/samples/edr-api-overview/edr-api-overview" - ] - }, - { - "type": "category", - "label": "Test your setup", - "collapsed": true, - "items": [ - "kits/tractusx-edc/docs/development/postman/README", - "kits/tractusx-edc/docs/kit/operation-view/page08_api", - "kits/tractusx-edc/docs/samples/Transfer Data" - ] - }, - { - "type": "category", - "label": "Migration", - "collapsed": true, - "link": { - "type": "doc", - "id": "kits/tractusx-edc/docs/kit/operation-view/page09_upgrading" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/tractusx-edc/docs/migration" - } - ] - } - ] - }, - { - "type": "category", - "label": "Documentation", - "collapsed": true, - "items": [ - "kits/tractusx-edc/docs/kit/development-view/page02_repository_structure", - "kits/tractusx-edc/docs/kit/development-view/page03_project_structure", - "kits/tractusx-edc/docs/development/coding-principles", - "kits/tractusx-edc/pr_etiquette", - "kits/tractusx-edc/styleguide" - ] - } - ] - }, - { - "type": "category", - "label": "Data Chain KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/Data Chain Kit/data chain kit changelog", - "kits/Data Chain Kit/Adoption View Data Chain Kit", - "kits/Data Chain Kit/Operation View", - { - "type": "category", - "label": "Development View", - "link": { - "type": "doc", - "id": "kits/Data Chain Kit/Software Development View/Specification" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Data Chain Kit/Software Development View/Job Api" - } - ] - }, - { - "type": "category", - "label": "Success Stories", - "items": [ - "kits/Data Chain Kit/Success Stories/Trace-X Sucess Story", - "kits/Data Chain Kit/Success Stories/Circularity Dashboard Sucess Story" - ] - }, - { - "type": "category", - "label": "Documentation", - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Data Chain Kit/Documentation" - } - ] - } - ] - }, - { - "type": "category", - "label": "DCM KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/DCM Kit" - } - ] - }, - { - "type": "category", - "label": "Digital Twin KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Digital Twin Kit" - } - ] - }, - { - "type": "category", - "label": "Eco Pass KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Eco_Pass_KIT" - } - ] - }, - { - "type": "category", - "label": "OSim Kit", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/OSim Kit" - } - ] - }, - { - "type": "category", - "label": "PCF Exchange KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/PCF Exchange Kit/PCF Exchange Kit Changelog", - "kits/PCF Exchange Kit/Adoption View", - "kits/PCF Exchange Kit/Operation View", - { - "type": "category", - "label": "Development View", - "link": { - "type": "generated-index" - }, - "items": [ - "kits/PCF Exchange Kit/Software Development View/Specification", - { - "type": "category", - "label": "PCF Exchange API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/catena-x-pcf-request-endpoint" - }, - { - "type": "category", - "label": "PCF Exchange API", - "items": [ - { - "type": "doc", - "id": "kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/get-pcf", - "label": "get_pcf", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/set-pcf", - "label": "set_pcf", - "className": "api-method put" - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "category", - "label": "Quality KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Quality-Kit" - } - ] - }, - { - "type": "category", - "label": "Remaining Useful Life (RuL) KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Behaviour Twin RuL Kit" - } - ] - }, - { - "type": "category", - "label": "Traceability KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Traceability Kit" - } - ] - } - ] -} diff --git a/docs-kits_versioned_sidebars/version-3.1.0-sidebars.json b/docs-kits_versioned_sidebars/version-3.1.0-sidebars.json deleted file mode 100644 index 1511a6e7d4c..00000000000 --- a/docs-kits_versioned_sidebars/version-3.1.0-sidebars.json +++ /dev/null @@ -1,849 +0,0 @@ -{ - "kits": [ - { - "type": "category", - "label": "Business Partner KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/Business Partner Kit/Changelog", - "kits/Business Partner Kit/Adoption View", - "kits/Business Partner Kit/Operation View", - { - "type": "category", - "label": "Documentation", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Business Partner Kit/Documentation BPDM" - } - ] - }, - { - "type": "category", - "label": "Development View", - "link": { - "type": "generated-index" - }, - "items": [ - "kits/Business Partner Kit/Software Development View/Specification", - { - "type": "category", - "label": "Gate API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate" - }, - { - "type": "category", - "label": "site-controller", - "link": { - "type": "generated-index", - "title": "site-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/site-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-sites", - "label": "Get page of sites", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites", - "label": "Create or update sites.", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-sites-output", - "label": "Get page of sites", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/validate-site", - "label": "Validate a site", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-site-by-external-id", - "label": "Get site by external identifier", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "legal-entity-controller", - "link": { - "type": "generated-index", - "title": "legal-entity-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/legal-entity-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities", - "label": "Get page of legal entities", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities", - "label": "Create or update legal entities.", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-output", - "label": "Get page of legal entities", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/validate-legal-entity", - "label": "Validate a legal entity", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entity-by-external-id", - "label": "Get legal entity by external identifier", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "address-controller", - "link": { - "type": "generated-index", - "title": "address-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/address-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-addresses", - "label": "Get page of addresses", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-addresses", - "label": "Create or update addresses.", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-output", - "label": "Get page of addresses", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/validate-site-1", - "label": "Validate an address partner", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-address-by-external-id", - "label": "Get address by external identifier", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "business-partner-controller", - "link": { - "type": "generated-index", - "title": "business-partner-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/determine-lsa-type", - "label": "Determine the LSA type of a business partner candidate", - "className": "api-method post" - } - ] - } - ] - }, - { - "type": "category", - "label": "Pool API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool" - }, - { - "type": "category", - "label": "site-controller", - "link": { - "type": "generated-index", - "title": "site-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/site-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/update-site", - "label": "Update existing site business partners", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-site", - "label": "Create new site business partners", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-sites", - "label": "Search site partners by BPNs and/or parent BPNs", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-main-addresses", - "label": "Search Main Addresses", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-site", - "label": "Get site partners by bpn", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "legal-entity-controller", - "link": { - "type": "generated-index", - "title": "legal-entity-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/legal-entity-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities", - "label": "Get page of legal entity business partners matching the search criteria", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners", - "label": "Update existing legal entity business partners", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners", - "label": "Create new legal entity business partners", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/set-legal-entity-currentness", - "label": "Confirms that the data of a legal entity business partner is still up to date.", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-sites-1", - "label": "Search legal entity partners by BPNLs", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-legal-addresses", - "label": "Search Legal Addresses", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity", - "label": "Get legal entity business partner by identifier", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-sites", - "label": "Get site partners of a legal entity", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-addresses", - "label": "Get address partners of a legal entity", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "address-controller", - "link": { - "type": "generated-index", - "title": "address-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/address-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1", - "label": "Get page of addresses matching the search criteria", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/update-addresses", - "label": "Update existing address business partners", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-addresses", - "label": "Create new address business partners", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-addresses", - "label": "Search address partners by BPNs and/or parent BPNs", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-address", - "label": "Get address partners by bpn", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "saas-controller", - "link": { - "type": "generated-index", - "title": "saas-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/saas-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-sync-status", - "label": "Fetch information about the SaaS synchronization", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/import-business-partners", - "label": "Import new business partner records from SaaS", - "className": "api-method post" - } - ] - }, - { - "type": "category", - "label": "open-search-controller", - "link": { - "type": "generated-index", - "title": "open-search-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/open-search-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-business-partners", - "label": "Fetch information about the latest OpenSearch export", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/export", - "label": "Index new business partner records on OpenSearch", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/clear", - "label": "Clear business partner index on OpenSearch", - "className": "api-method delete" - } - ] - }, - { - "type": "category", - "label": "metadata-controller", - "link": { - "type": "generated-index", - "title": "metadata-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/metadata-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms", - "label": "Get page of legal forms", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form", - "label": "Create new legal form", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-issuing-bodies", - "label": "Get page of issuing bodies", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-issuing-body", - "label": "Create new issuing body", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types", - "label": "Get page of identifier types", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type", - "label": "Create new identifier type", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-stati", - "label": "Get page of identifier statuses", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-status", - "label": "Create new identifier status", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-valid-identifier-types-for-country", - "label": "Get valid identifier types for a country", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "bpn-controller", - "link": { - "type": "generated-index", - "title": "bpn-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/bpn-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers", - "label": "Find business partner numbers by identifiers", - "className": "api-method post" - } - ] - }, - { - "type": "category", - "label": "suggestion-controller", - "link": { - "type": "generated-index", - "title": "suggestion-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/suggestion-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-site-suggestion", - "label": "Find best matches for given text in business partner sites", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-status-suggestion", - "label": "Find best matches for given text in business statuses", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-name-suggestion", - "label": "Find best matches for given text in business partner names", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-legal-form-suggestion", - "label": "Find best matches for given text in business partner legal forms", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-classification-suggestion", - "label": "Find best matches for given text in business partner classifications", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-thoroughfare-suggestion", - "label": "Find best matches for given text in thoroughfares", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-premise-suggestion", - "label": "Find best matches for given text in premises", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-postcode-suggestion", - "label": "Find best matches for given text in postcodes", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-postal-deliver-point-suggestion", - "label": "Find best matches for given text in postal delivery points", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-locality-suggestion", - "label": "Find best matches for given text in localities", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-admin-area-suggestion", - "label": "Find best matches for given text in administrative areas", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "business-partner-controller", - "link": { - "type": "generated-index", - "title": "business-partner-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries", - "label": "Get business partner changelog entries by bpn", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "business-partner-legacy-controller", - "link": { - "type": "generated-index", - "title": "business-partner-legacy-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-legacy-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-business-partners", - "label": "Get page of business partners matching the search criteria", - "className": "menu__list-item--deprecated api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity-1", - "label": "Get business partner by identifier", - "className": "menu__list-item--deprecated api-method get" - } - ] - } - ] - } - ] - }, - { - "type": "category", - "label": "Success Stories", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Business Partner Kit/Success Stories" - } - ] - } - ] - }, - { - "type": "category", - "label": "Connector KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/tractusx-edc/CHANGELOG", - "kits/tractusx-edc/docs/kit/adoption-view/Adoption View", - { - "type": "category", - "label": "Development View", - "link": { - "type": "doc", - "id": "kits/tractusx-edc/docs/kit/development-view/page00_development_view" - }, - "collapsed": true, - "items": [ - "kits/tractusx-edc/docs/README", - "kits/tractusx-edc/docs/kit/adoption-view/Domain Model", - { - "type": "category", - "label": "openAPI", - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/tractusx-edc/docs/kit/development-view/openAPI" - } - ] - }, - { - "type": "category", - "label": "edc-controlplane", - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/tractusx-edc/edc-controlplane" - } - ] - }, - { - "type": "category", - "label": "edc-dataplane", - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/tractusx-edc/edc-dataplane" - } - ] - }, - { - "type": "category", - "label": "edc-extensions", - "collapsed": true, - "link": { - "type": "doc", - "id": "kits/tractusx-edc/docs/kit/development-view/page10_extensions" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/tractusx-edc/edc-extensions" - } - ] - }, - "kits/tractusx-edc/docs/development/Release" - ] - }, - { - "type": "category", - "label": "Operation View", - "link": { - "type": "doc", - "id": "kits/tractusx-edc/docs/kit/operation-view/page00_operation_view" - }, - "collapsed": true, - "items": [ - "kits/tractusx-edc/docs/kit/operation-view/page02_technical_prerequisites", - { - "type": "category", - "label": "Setting up from source", - "collapsed": true, - "items": [ - "kits/tractusx-edc/docs/kit/operation-view/page03_local_setup_controlplane", - "kits/tractusx-edc/docs/kit/operation-view/page04_local_setup_dataplane" - ] - }, - { - "type": "category", - "label": "Deployment via Helm", - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/tractusx-edc/charts" - }, - "kits/tractusx-edc/edc-tests/deployment/omejdn/README", - "kits/tractusx-edc/edc-tests/deployment/test-infrastructure/README" - ] - }, - { - "type": "category", - "label": "Test your setup", - "collapsed": true, - "items": [ - "kits/tractusx-edc/docs/development/postman/README", - "kits/tractusx-edc/docs/kit/operation-view/page08_api", - "kits/tractusx-edc/docs/samples/Transfer Data" - ] - }, - { - "type": "category", - "label": "Migration", - "collapsed": true, - "link": { - "type": "doc", - "id": "kits/tractusx-edc/docs/kit/operation-view/page09_upgrading" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/tractusx-edc/docs/migration" - } - ] - } - ] - }, - { - "type": "category", - "label": "Documentation", - "collapsed": true, - "items": [ - "kits/tractusx-edc/docs/kit/development-view/page02_repository_structure", - "kits/tractusx-edc/docs/kit/development-view/page03_project_structure", - "kits/tractusx-edc/docs/development/coding-principles", - "kits/tractusx-edc/pr_etiquette", - "kits/tractusx-edc/styleguide" - ] - } - ] - }, - { - "type": "category", - "label": "Data Chain KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/Data Chain Kit/data chain kit changelog", - "kits/Data Chain Kit/Adoption View", - "kits/Data Chain Kit/Operation View", - { - "type": "category", - "label": "Development View", - "link": { - "type": "doc", - "id": "kits/Data Chain Kit/Software Development View/Specification" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Data Chain Kit/Software Development View/Job Api" - } - ] - }, - { - "type": "category", - "label": "Success Stories", - "items": [ - "kits/Data Chain Kit/Success Stories/Trace-X Sucess Story", - "kits/Data Chain Kit/Success Stories/Circularity Dashboard Sucess Story" - ] - }, - { - "type": "category", - "label": "Documentation", - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Data Chain Kit/Documentation" - } - ] - } - ] - }, - { - "type": "category", - "label": "DCM KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/DCM Kit" - } - ] - }, - { - "type": "category", - "label": "Traceability KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Traceability Kit" - } - ] - }, - { - "type": "category", - "label": "Resiliency", - "link": { - "type": "doc", - "id": "kits/Resiliency/resiliency" - }, - "items": [ - "kits/Resiliency/maas", - "kits/Resiliency/OSIM", - "kits/Resiliency/PURIS", - "kits/Resiliency/mp kit" - ] - } - ] -} diff --git a/docs-kits_versions.json b/docs-kits_versions.json index 5268c2eefbb..d9f96818186 100644 --- a/docs-kits_versions.json +++ b/docs-kits_versions.json @@ -1,6 +1,4 @@ [ "24.03", - "23.12", - "23.09", - "3.1.0" + "23.12" ] diff --git a/docs/kit-process/coverpage.md b/docs/kit-process/coverpage.md deleted file mode 100644 index b2e8d4c9650..00000000000 --- a/docs/kit-process/coverpage.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: KIT - Guidelines ---- - -In this section you find out KIT Guidelines here you find the basic concepts and requirements. If you are new and want to create or contribute to a KIT, start with our [Graduation Process](/docs/kit-process/graduation-process.md)! - -If you need additional help consult our [FAQ](/docs/kit-process/processes/contribute.md). - -**Wellcome to Tractus-X!** diff --git a/docs/kit-process/graduation-process.md b/docs/kit-process/graduation-process.md deleted file mode 100644 index 4f76a08e1f0..00000000000 --- a/docs/kit-process/graduation-process.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: Graduation Process -sidebar_position: 1 ---- - -```md - ********************************************** - ** DISCLAIMER ** - ** THIS PROCESS IS STILL UNDER DEVELOPMENT ** - ** FEEDBACK IS APPRECIATED ** - ********************************************** -``` - -At this point we describe the development process of a KIT. Since the KITs are to be developed in opensource we have decided to use the Graduation Process of the [cncf](https://www.cncf.io) in a slightly modified version. The goal is to track the progress of each kit and to achieve a certain level of quality. - -## Stages - -In our version we use three stages Sandbox, Incubating and Graduated. In each stage, different goals have to be achieved. - -### Stage: Sandbox - -In the Sandbox stage, the developers have identified a problem or have an idea on how to extend the usefulness of the data space to the community. They develop an solution for this problem together with a vison/mission. - -### Stage: Incubating - -In the next stage, the Incubating stage, the solution plan is implemented, and the developers must create various artifacts and deliverables required by the community. Once the KIT is promited to the incubating stage it must implement the defined [versioning scheme](versioning) starting with the version `0.0.0`. - -### Stage: Graduated - -In the final stage, the Graduated stage, the KIT is production ready, published and maintained by the community. - -## Promotion Process - -As described, a KIT passes through different stages. In order to be promoted from one level to the next, the developers must fulfill various criteria. For each stage, different artifacts and deliverables are defined that have to be completed. A distinction is made between mandatory (✓) and recommended ((✓)) deliverables. In order to be promoted to the next level, a kit must have completed all necessary items of the lower level and at least one necessary item of the following level. As soon as this criteria is met a promotion has to be requested. To achieve graduated status, additionaly a case study must be completed with a partner from the community. The aim of this case study is to verify the content of the KIT. The performing partner tries to solve the problem only with the help of the KIT and, if necessary, to make suggestions for improvement that have to be implemented. - -## Artfacts & Deliverables - -In the table below shows which artefacts must be completed to progress to the next stage . [here](artefacts) you will find the more detailed descriptions. - -| Artefact/Stage | Sandbox → Incubating | Incubating → Graduated | -| :----------------------------------------------------------------------- | :------------------: | :--------------------: | -| [Vision/Mission](artefacts/#vision--mission) | ✓ | ✓ | -| [Business Value(s)](artefacts/#business-value) | ✓ | ✓ | -| [Use Case/ Domain explanation](artefacts/#use-case--domain-explanation)  | ✓ | ✓ | -| [Standarts](artefacts/#standards) | | ✓ | -| [API-Specification/Protocols](artefacts/#api-specifications) | | ✓ | -| [Logic/Schema](artefacts/#logic--schema) | | ✓ | -| [Documentation](artefacts/#documentation-in-the-context-of-development) | | ✓ | -| [Tutorials/Videos](artefacts/#tutorials) | | (✓) | -| [Semantic Models](artefacts/#semantic-models) | | (✓)  | -| [Buisiness Processes](artefacts/#business-process) | | (✓) | -| [Sample Data](artefacts/#sample-data) | | (✓) | -| [Reference Implementation](artefacts/#reference-implementation) | | (✓) | -| Quick Setup Guide | | ✓ \* | -| Architecture | | (✓) | -| [Whitepaper](artefacts/#whitepaper) | | (✓) | - -### Legend - -| Symbol | Meaning | -| :----: | :-------------------------------------: | -| ✓ | mandatory to progress to the next stage | -| (✓) | recommended | -| \* | if a reference implementation exists | diff --git a/docs/kit-process/processes/coverpage.md b/docs/kit-process/processes/coverpage.md deleted file mode 100644 index 83f2bf53d30..00000000000 --- a/docs/kit-process/processes/coverpage.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: KIT - FAQ ---- - -In this section you find our FAQ and How Tos! - -If you still have an issue or question left to answer we invite you to raise your question in the discussion section of our community [GitHub](https://github.com/eclipse-tractusx/community)! diff --git a/docs/kit-process/processes/kit-faq.md b/docs/kit-process/processes/kit-faq.md deleted file mode 100644 index 125d896f62c..00000000000 --- a/docs/kit-process/processes/kit-faq.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -title: KIT FAQ ---- - -:::info -This page is currently under construction! -::: - -On this page you will find an FAQ focused on questions related to the KIT documentation. There is also a general [FAQ for Tractus-X](/docs/dev_faq) and the [Tractus-X link collection](/docs/dev_links). - -## How do I start? - -There are several resources providing information about contributing to the Eclipse Tractus-X project. Before you begin, please familiarize yourself with the following documentation: - -- [Getting started](/docs/oss/getting-started) -- [How to contribute](/docs/oss/how-to-contribute) -- [Eclipse project roles](/docs/oss/contributor-committer) -- [Tractus-X link collection](/docs/dev_links) - -Tractus-X is an Eclipse project, the [Eclipse Foundation Project Handbook](https://www.eclipse.org/projects/handbook/#legaldoc) is the leading documentation. - -## How do I get support? - -If you have any questions not answered here, in the general [FAQ](/docs/dev_faq) or in the documentation, please feel free to ask questions in our community channels: - -- [Tractus-X General Chat Room](https://chat.eclipse.org/#/room/#tools.tractus-x:matrix.eclipse.org) -- [Tractus-X Developer Mailingliste](https://accounts.eclipse.org/mailing-list/tractusx-dev) - -There are several issue tracker for different purpose, please see the [issue tracker documentation](/docs/oss/issues). - -## How do I become a Tractus-X contributor? - -See [here](/docs/kit-process/processes/kit-faq#how-to-start) - -:::info -You are an Eclipse contributor once you have signed the Eclipse Contributor Agreement (ECA). -GitHub has automated checks that check your contributions. Without a signed ECA, the [checks will fail](/docs/dev_faq#the-eca-check-is-failing-while-merging-a-pr-what-to-do). -::: - -## How to contribute ? - -If you and your team want to contribute to an existing KIT or suggest a new KIT you have to fulfill a small set of prerequisites. - -1. See the process for creating a new KIT (TBD) - -1. Become an Eclipse Tractus-X project contributor, see [here](/docs/kit-process/processes/kit-faq#how-to-start) - - - -## How do I get a Tractus-X repository? - -After your KIT suggestion is accepted you need to [request a Tractus-X repository](/docs/oss/issues#create-manage-a-repository-in-eclipse-tractusx). Tractus-X is an Eclipse project, the repositories are managed by the Eclipse Foundation. - -## How to update the KIT documentation on the Tractus-X website ? - -We have a page where we explain the process. You find it [here](/docs/kit-process/processes/update-documentation.md) - -## How to suggest a new KIT ? - -(TBD) - -## How to version your KIT ? - -(TBD) - - -## How to create a new KIT release ? - -(TBD) - - - -## General KIT workflow - -(TBD) - diff --git a/docs/kit-process/processes/resources/click-create-pr-final.png b/docs/kit-process/processes/resources/click-create-pr-final.png deleted file mode 100644 index 216fa91da69..00000000000 Binary files a/docs/kit-process/processes/resources/click-create-pr-final.png and /dev/null differ diff --git a/docs/kit-process/processes/resources/click-create-pr.png b/docs/kit-process/processes/resources/click-create-pr.png deleted file mode 100644 index 2b88c3031a0..00000000000 Binary files a/docs/kit-process/processes/resources/click-create-pr.png and /dev/null differ diff --git a/docs/kit-process/processes/resources/click-on-new-pr.png b/docs/kit-process/processes/resources/click-on-new-pr.png deleted file mode 100644 index d8b7ee7e037..00000000000 Binary files a/docs/kit-process/processes/resources/click-on-new-pr.png and /dev/null differ diff --git a/docs/kit-process/processes/resources/click-on-pr-first.png b/docs/kit-process/processes/resources/click-on-pr-first.png deleted file mode 100644 index e4ff512edfc..00000000000 Binary files a/docs/kit-process/processes/resources/click-on-pr-first.png and /dev/null differ diff --git a/docs/kit-process/processes/resources/create-new-fork.png b/docs/kit-process/processes/resources/create-new-fork.png deleted file mode 100644 index c0189b5575f..00000000000 Binary files a/docs/kit-process/processes/resources/create-new-fork.png and /dev/null differ diff --git a/docs/kit-process/processes/resources/import-repository.png b/docs/kit-process/processes/resources/import-repository.png deleted file mode 100644 index 8616ccbe2d5..00000000000 Binary files a/docs/kit-process/processes/resources/import-repository.png and /dev/null differ diff --git a/docs/kit-process/processes/resources/select-branch-to-merge.png b/docs/kit-process/processes/resources/select-branch-to-merge.png deleted file mode 100644 index 385e061e941..00000000000 Binary files a/docs/kit-process/processes/resources/select-branch-to-merge.png and /dev/null differ diff --git a/docs/kit-process/processes/update-documentation.md b/docs/kit-process/processes/update-documentation.md deleted file mode 100644 index 97be6afd47f..00000000000 --- a/docs/kit-process/processes/update-documentation.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: Update Documentation ---- - -```md - ********************************************** - ** DISCLAIMER ** - ** THIS PROCESS IS STILL UNDER DEVELOPMENT ** - ** FEEDBACK IS APPRECIATED ** - ********************************************** -``` - -On this page you find a description on how to create/update your KITs documentation. - -Before you can generate KIT documentation on the Tractus-X website repository, ensure that a dedicated repository exists for your product ([How to obtain a Tractus-X repository](/docs/kit-process/processes/kit-faq/#how-to-obtain-a-tractus-x-repository-)). This repository will serve as a storage space for your files and provide a platform for your work. - -Subsequently, the KIT documentation will be duplicated to the Tractus-X website repository. The specific process for accomplishing this will be elucidated in the subsequent documentation. - -## Process - -Currently the documentation has to be manually maintained by the process described below. This is only a temporary solution as we are still in process on finding the perfect fitting process. - -### Overview - -1. Create a fork of the [Tractus-X website repository](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io) by clicking on the "fork" button on the top right - ![IMG: how to create fork](resources/create-new-fork.png) - -2. Edit your documentation with regard to the schema. Note that you **only** apply changes to the content within the `docs-kits` directory! If you modify your or other content outside of this directory your changes will be rejected! -3. create a pull request - - 1. click on "Pull Requests" - - ![IMG: Click on Pull request first](resources/click-on-pr-first.png) - - 2. click on "New Pull Request" - - ![IMG: Click on New Pull request](resources/click-on-new-pr.png) - - 3. Select Branch which should be merge into the base repository - - ![IMG: Select Branch to Merge](resources/select-branch-to-merge.png) - - 4. Click on Create Pull request - - ![IMG: Click on Create Pull Request second](resources/click-create-pr.png) - - 5. Add Description, what you add/change/improve. If available link an Issue with "#\. Then click on "Create Pull request" - - ![IMG: Click on Create Pull Request final](resources/click-create-pr-final.png) - -4. The process owners ([@danielmiehle](https://github.com/danielmiehle) / [@maximilianong](https://github.com/maximilianong)) of publishing a KIT will review your pull request. - -The pull request will be approved if it meets our schema, liniting requirements and follows the [open source governance](/docs/release/trg-7/trg-7-00/). - -### Schema - -In order to have a uniform apperance we expect the documentation to be in a similar structure. You find the template in the template folder, a structural overview is below: - -```md - . - └── - ├── changelog.md - ├── page-adoption-view.md - ├── page-software-development-view.md - ├── page-documentation.md - └── page-software-operation-view.md -``` - -The sections within these files are the aligned with the artefacts described [here](/docs/kit-process/artefacts). - -Additionaly we apply linter for to the submitted code which will atomatically reject your pull request if these fail. - -## Notes - -- The documentation is only a copy thus it will not be automatically updated! diff --git a/docs/kit-process/versioning.md b/docs/kit-process/versioning.md deleted file mode 100644 index 7cb61afdf41..00000000000 --- a/docs/kit-process/versioning.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Versioning scheme -sidebar_position: 2 ---- - -```md - ********************************************** - ** DISCLAIMER ** - ** THIS PROCESS IS STILL UNDER DEVELOPMENT ** - ** FEEDBACK IS APPRECIATED ** - ********************************************** -``` - -To achieve some uniformity, we prescribe a versioning scheme for KITs. Here we use a modified semantic versioning. With semantic versioning, the version is composed of three parts as follows: - -`MAJOR.MINOR.PATCH` - -An increment in Major component marks a change that makes the current version incompatible with the previous versions. A minor increment, on the other hand, indicates the addition of a new feature or component. An increment in the Patch component marks an unimportant change. - -For a kit we distinguish between two phases incubating and graduated. - -## Incubating Phase - -During the incubating phase, the major version must be 0. This means that the version of a KIT that is not yet graduated always has the format 0.x.y. The minor component is incremented exactly when an artifact is completed and the patch component is incremented for all other changes. - -As soon as a KIT moves to the Graduated stage its version is set to 1.0.0. after that the Graduated Phase Versioning applies. - -## Graduated Phase - -Upon reaching the Graduation Phase, a KIT is production ready and can be in use. Since the KITs are maintained and further developed by the community, changes can be made that result in an incompatibility. In the Graduation phase we use the same versioning as in the incubating phase only that we extend it by a rule. We have defined a set of central artifacts that can trigger a major increment. I.e. by updating artifacts or adding optional artifacts that do not yet exist, only the minor component is increased. The major component must be increased if one of the defined artifacts is changed in such a way that an incompatibility arises. In the rules these are components that define interfaces, schemas or similar. Below you will find a list of these artifacts. - -### Major-Artefacts - -These may trigger a major increase if they exists. - -- Semantic Model -- Logic/Schema -- API Specification diff --git a/docs/release/trg-0/trg-9-01.md b/docs/release/trg-0/trg-9-01.md new file mode 100644 index 00000000000..3a7efaec678 --- /dev/null +++ b/docs/release/trg-0/trg-9-01.md @@ -0,0 +1,26 @@ +--- +title: TRG 9.01 - KITS +--- + +| Status | Created | Post-History | +|------------|--------------|----------------------------------------| +| Draft | 12-Apr-2024 | Initial contribution | + +## Why + +This TRG serves to maintain a **consistent structure** and ensure **content quality** for the stakeholders. + +KIT means Keep It Together. A KIT contains all the artifacts that are relevant to participate in the Catena-X data space as an operator, data provider or solution / app provider. These stakeholders have one place with all the information they need. For example an explanation of an API, the specification of it and the deployment instructions. The goal of a KIT should be that you have no need to visit any other information source. + +A detailed explanation can be found here: +[KIT General Introduction](https://eclipse-tractusx.github.io/Kits) + +## Description + +- A KIT must have a changelog.md following semantic versioning - see [TRG 1.03 - CHANGELOG.md](https://eclipse-tractusx.github.io/docs/release/trg-1/trg-1-3) +- A KIT must have, at minimum, an adoption view (Sandbox stage) - see [KIT Maturity Levels](documentation/kit-maturity-levels.md) +- KIT artifacts must be structured according to the respective views (i.e. adoption, development, operations) - see [KIT Artifacts](documentation/kit-artifacts.md) +- Linked documents (e.g., Catena-X standards, Whitepapers) must include the current valid version (e.g. Business Partner Number (Version 2.0.0)) +- Each KIT view (business, development, ..) must include a license notice and adhere to the CY BB 4.0 license - see [TRG 7.08 - Legal notice for KIT documentation (CC-BY-4.0)](https://eclipse-tractusx.github.io/docs/release/trg-7/trg-7-08) +- Images must be neutral without any branding, and displayed on a. Images need to follow a the legal notice TRG - see [Legal notice for non-code](https://eclipse-tractusx.github.io/docs/release/trg-7/trg-7-07) +- A KIT must indicate its maturity level (sandbox, incubating, graduated) - see [KIT Maturity Levels](documentation/kit-maturity-levels.md) diff --git a/docs/release/trg-6/trg-6-1.md b/docs/release/trg-6/trg-6-1.md index e14897574e4..6a60bf15c8e 100644 --- a/docs/release/trg-6/trg-6-1.md +++ b/docs/release/trg-6/trg-6-1.md @@ -39,6 +39,14 @@ the [central Tractus-X Helm repository](https://eclipse-tractusx.github.io/chart To get the GitHub Chart Releaser Action working, the following prerequisites must be met: - A branch named `gh-pages` in your repository +- Change the GitHub Pages source branch to `gh-pages` in your repository settings. Submit request via Otterdog, ensure following are set: + + ```json + gh_pages_build_type:"legacy", + gh_pages_source_branch:"gh-pages", + gh_pages_source_path:"/", + ``` + - Helm charts must be located in folder `/charts` - A GitHub Actions Workflow (see section [Implementaion](#implementation)) diff --git a/docs/kit-process/processes/create_KIT_page.md b/docs/website-guidelines/kit-structure.md similarity index 68% rename from docs/kit-process/processes/create_KIT_page.md rename to docs/website-guidelines/kit-structure.md index 20cbb3d33e5..41024a124dd 100644 --- a/docs/kit-process/processes/create_KIT_page.md +++ b/docs/website-guidelines/kit-structure.md @@ -1,19 +1,10 @@ --- -title: Create KIT website +title: KIT Structure +sidebar_position: 8 --- - - -```md - ********************************************** - ** DISCLAIMER ** - ** THIS PROCESS IS STILL UNDER DEVELOPMENT ** - ** FEEDBACK IS APPRECIATED ** - ********************************************** -``` - ## Project Structure -Following our project structure, the collection of our KITs documentation is developed in the `./docs-kits/kits` folder, where each KIT is a subfolder called by its name for organisation purposes. The `Data Chain KIT`, for example, is defined here: `./docs-kits/kits/Data Chain Kit`. +Following our project structure, the collection of our KITs documentation is developed in the `./docs-kits/kits` folder, where each KIT is a subfolder called by its name for organisation purposes. The name / naming convention of the folder for the KIT needs to follow [kebab-case](https://juniortoexpert.com/en/naming-convention/). Each folder/KIT's content is structured in at least four pages/subfolders: @@ -22,7 +13,7 @@ Each folder/KIT's content is structured in at least four pages/subfolders: - Documentation -> `page_documentation.md` - Software Development View/ - Specification -> `page_software-development-view.md` - - OpenAPI definition/ + - OpenAPI link to SwaggerHub - Another OpenAPI definition/ - ... @@ -70,7 +61,7 @@ Each folder/KIT's content is structured in at least four pages/subfolders: └── page_documentation.md ``` -5. Inside the `NewKIT` folder, add a `Software Development View` folder that contains a `page_software-development-view.md` file with the content that suits your use case +5. Inside the `NewKIT` folder, add a `SoftwareDevelopmentView` folder that contains a `page_software-development-view.md` file with the content that suits your use case ```md root @@ -84,11 +75,32 @@ Each folder/KIT's content is structured in at least four pages/subfolders: └──page_software-development-view.md ``` -6. To generate the `OpenAPI` based documentation of your KIT, please consult the [Plugins section](/docs/website-guidelines/wiki#plugins) to configure your instance of the `Docusaurus-OpenAPI-Docs` in the `docusaurus.config.js`. +6. To generate the `OpenAPI` based documentation of your KIT, please publish the API on SwaggerHub -7. Add your newly created KIT documentation to the Kits `sidebar` page, by incorporating the following declaration in the sidebar object of the `sidebar.js` file: +**For KITs without reference implementation:** - ```javascript +After evaluation, a "semi-automated" or "manual" solution is not considered effective. +Please place the openAPI.yaml file directly in your KIT folder and link it to the appropriate location in your .md file. +Optional for short APIs: Integrate your API in-line as a code block, for example: [Agent KIT](https://eclipse-tractusx.github.io/docs-kits/kits/knowledge-agents/development-view/api/agent/agent-get/). +Future: Standardized APIs will be released with yaml file in the Standard library. KIT links to standard and yaml published by the Catena-X e.V. + +**For KITs with reference implementation:** + +Please use (or adapt existing) automated workflows to publish on SwaggerHub. Maintain your openAPI.yaml and the publishing workflow in the repository of the reference implementation. Remove everything related to that from the website repo and only link to SwaggerHub in your KIT from now on. We utilize a user provided by the Eclipse Foundation to publish on SwaggerHub. Credentials for this user can be used through in the eclipse-tractusx GitHub org secrets and can be utilized in automated workflows. Pay special attention to the "swaggerHub" CLI commands. The location where the openAPI file is maintained may vary. The BPDM example showcases how the application is initiated to download and publish the current file from that location. + +SWAGGERHUB_API_KEY: ${{ secrets.SWAGGERHUB_API_KEY }} + SWAGGERHUB_USER: ${{ secrets.SWAGGERHUB_USER }} + +Examples: +[BPDM Certificate Management](https://github.com/eclipse-tractusx/bpdm-certificate-management/blob/main/.github/workflows/publish-swagger-hub.yaml) +[Digital Product Pass](https://github.com/eclipse-tractusx/digital-product-pass/blob/main/.github/workflows/publish-swagger-hub.yaml) +[Tractus-X EDC](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/.github/workflows/publish-swaggerhub.yaml) + +If you have any questions, please use our [“Tractus-X community call”](https://eclipse-tractusx.github.io/community/open-meetings) and prepare accordingly before merging. + +7.Add your newly created KIT documentation to the Kits `sidebar` page, by incorporating the following declaration in the sidebar object of the `sidebar.js` file: + +```javascript const sidebars = { // other sidebars kits: [ @@ -133,7 +145,7 @@ Each folder/KIT's content is structured in at least four pages/subfolders: type: 'dropdown', label: 'KITs', position: 'left', - to: '/Kits', + to: '/developer', items: [ { to: '/docs-kits/kits/Business%20Partner%20Kit/Adoption%20View', diff --git a/docs/kit-process/artefacts.md b/documentation/kit-artifacts.md similarity index 55% rename from docs/kit-process/artefacts.md rename to documentation/kit-artifacts.md index 2523807ba31..c2417196e02 100644 --- a/docs/kit-process/artefacts.md +++ b/documentation/kit-artifacts.md @@ -1,92 +1,95 @@ --- -title: Artefacts +title: KIT Artifacts --- +| Status | Created | Post-History | +|------------|--------------|----------------------------------------| +| Draft | 04-Apr-2024 | Initial contribution | -- The documentation of a KIT can grow and change -- Think about the customer perspective / who will be using this kit and needs to understand it -- How to create the kit documentation in Github is explained [here](/docs/kit-process/processes/create_KIT_page) +This explains each artifact a KIT can or must follow - depending on the graduation stage [TRG 9.02](docs/release/trg-0/trg-9-02.md). An artifact is textual content or a technical component that is part of a KIT (e.g. a Vision statement). -## ADOPTION VIEW +## CHANGELOG -### Vision & Mission +To achieve uniformity, we use [semantic versioning](https://semver.org/). Concrete examples in our already published [KITs](https://eclipse-tractusx.github.io/Kits). +For a KIT we distinguish between three phases sandbox, incubating and graduated. -The vision describes the strategic objectives of a KIT and how it aims to inspire solution providers. +### Sandbox Phase + +Has no changelog - it´s a preview for the KIT. + +### Incubating Phase + +The first released version of the KIT. It´s ready to be used by data providers / consumers, app-/service providers or operators. + +### Graduated Phase +Upon reaching the Graduation Phase, a KIT got verified by a data providers / consumers, app-/service providers or operators. Since the KITs are maintained and further developed by the community, changes can be made that result in an incompatibility. + +## Business View + +The business view gives a general introduction to the KIT. It aims to provide insights to industry problems, the KIT is addressing. +Mandatory for every KIT and all graduation stages +The vision describes the strategic objectives of a KIT and how it aims to inspire solution providers. Deliverables: - Vision catch phrase + context - Mission catch phrase - Context to the use case - Starting with the **vision of the KIT** (one or two catching phrases) - `Example from BPDM:` Unique business partner data sets for the whole data space. Basis for integration value-adding services in the area of business partner data management. -#### The missions of the KIT +### The missions of the KIT +Mandatory for every KIT and all graduation stages The mission explains why we are providing the KIT describing a concrete industry problem. - -`Example from BPDM:` “The Kit provides a homogenous semantic with an open data model, high data quality and one access point to the business partner data sets.” +`Example from BPDM:` “The KIT provides a homogenous semantic with an open data model, high data quality and one access point to the business partner data sets.” #### Giving more context with explaining the connection to the use case `Example from BPDM:` -The BusinessPartner Kit provides high-quality data records of business partners called golden record, including a unique identifier, the business partner number (BPN). +The BusinessPartner KIT provides high-quality data records of business partners called golden record, including a unique identifier, the business partner number (BPN). … ### Business Value +Mandatory for every KIT that is related to a use case and all graduation stages The business value describes the benefits for an service provider by using a KIT in order to create a commercial or non-profit solution for the Catena-X marketplaces. - Deliverable: About 3 to 5 top business values (title + description) - `Example from BPDM:` - One open data model: Application and Service provider can 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. - +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. ### Use Case / Domain explanation +Mandatory for every KIT that is related to a use case and all graduation stages This gives more insights into the use case or domain itself. - Todays challenge - Values for taking the challenge - Benefits for OEM, SME, Solution Provider - Deliverable: Status quo, challenge and the benefits from different perspectives - `Example from BPDM:` Business Partner KIT comes from the use case Business Partner Data Management. - Status Quo / Todays challenge: Most of today’s automotive companies have to invest a significant amount 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 and proactively reduce Business Partner risk via collaborative value-add services. - 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 can: - - Reduce today’s individual investments in master data mgt. - 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. +- 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. ### Tutorials +Mandatory for the 'Graduated' stage. Optional for 'sandbox' and 'incubating' A tutorial provides educational resources that provides step-by-step guidance on how to use a KIT. Tutorials can be delivered in various formats, such as videos or written text. It may also provide additional resources for further exploration of the topic. - Deliverables: - Description @@ -94,8 +97,8 @@ Deliverables: ### Whitepaper +Optional A whitepaper outlines the overall objectives of a KIT regarding a specific business problem. It provides readers with background information on the topic, identifies key challenges and solutions to those challenges, evaluates alternative approaches to solving the business problem at hand, and offers recommendations for action. - Deliverable: - Description @@ -103,42 +106,69 @@ Deliverable: ### Semantic Models +Mandatory for every KIT that is related to a use case + for the 'incubating' stage The semantic data models are a method of structuring data that includes semantic information that adds a basic meaning to the data and the relationships that lie between them to enable interoperability. - Deliverables: - Description - Link to the semantic data models (GitHub) +`Example from Traceability:` +[Traceability Semantic Models](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Adoption%20View%20Traceability%20Kit#semantic-models) ### Logic / Schema +Mandatory for every KIT that is related to a use case + for the 'incubating' stage Logic / schemas provides a definition of the minimum viable business process that must be implemented to enable interoperability. - Deliverables: Description ### Business Process +Mandatory for every KIT that is related to a use case + for the 'incubating' stage +Data sovereignty is one of the main principles of Catena-X and a major topic for the participants in the data space. This part should help to understand how the business process works and provides a blue print on how access & usage policies **could** look like. + - Business Architecture - Access & Usage Policies ### Standards -Links to the relevant standards (Association Library) +Mandatory for every KIT that wants to go to the 'incubating' stage +Links to the relevant standards (Association Library). Add the relevant number of the standard, the name and version of the standard. +`Example:` +CX - 001 Standardname (Version 2.0) + +### Notice + +Mandatory for every KIT and all graduation stages +KIT documentation works under the CC-BY-4.0 license. Therefore you need to add the "notice" part to make transparent which companies worked on this KIT. +`Example:` +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023,2024 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023,2024 SAP SE +- SPDX-FileCopyrightText: 2023,2024 Volkswagen AG +- SPDX-FileCopyrightText: 2023,2024 Robert Bosch GmbH +- SPDX-FileCopyrightText: 2023,2024 Mercedes Benz Group +- SPDX-FileCopyrightText: 2023,2024 BASF SE +- SPDX-FileCopyrightText: 2023,2024 Schaeffler AG +- SPDX-FileCopyrightText: 2023,2024 Contributors to the Eclipse Foundation +- Source URL: [BPDM GitHub repository](https://github.com/eclipse-tractusx/bpdm) ## Development View -... provides developers with resources to accelerate the development of apps and services. +The development view provides developers with resources to accelerate the development of apps and services. ### API Specifications -Deliverable: +Mandatory for every KIT that wants to go to the 'incubating' stage +Deliverables: -- Introduction to the API +- Introduction to the API / specification of the API - Whats the main focus of the API - Integration of the OpenAPI file - -`Example from DataChain KIT:` The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners. - +- Use case examples for the API endpoints and how to use them +`Example from DataChain KIT:` The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of Catena-X partners. [`Example for OpenAPI integration:`](/docs-kits/kits/Business%20Partner%20Kit/Software%20Development%20View/Pool%20Api/business-partner-data-management-pool) ### Sample Data @@ -161,12 +191,11 @@ Deliverable: - Arch42 - Usage examples -- More explaination on how to use the API in different scenarios +- More explanation on how to use the API in different scenarios ## Operations View ... provides resources to deploy and operate centralized & decentralized Catena-X offerings in your IT environment (e.g., on-prem, cloud). - Deliverables: **Quick Setup Guide / Installation Instructions** @@ -174,3 +203,8 @@ Deliverables: - Authorization information - Deployment **Deployment Scripts** + +## Architecture View + +The architecture view is an optional chapter. It offers an architecture perspective including the main building blocks and the runtime view. It can be extended with more architecture documentation like an ARC42. +[`Example for an Architecture View:`](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Architecture%20View%20Traceability%20Kit#scope-and-context). diff --git a/documentation/kit-getting-started.md b/documentation/kit-getting-started.md new file mode 100644 index 00000000000..eb91db9c395 --- /dev/null +++ b/documentation/kit-getting-started.md @@ -0,0 +1,21 @@ +--- +title: KIT Getting started +--- +| Status | Created | Post-History | +|------------|--------------|----------------------------------------| +| Draft | 04-Apr-2024 | Initial contribution | + +## Why + +This TRG serves to maintain a **consistent structure** and ensure **content quality** for the stakeholders. +KIT means Keep It Together. A KIT contains all the artifacts that are relevant to participate in the Catena-X data space as an operator, data provider or solution / app provider. These stakeholders have one place with all the information they need. For example an explanation of an API, the specification of it and the deployment instructions. The goal of a KIT should be that you have no need to visit any other information source. +A detailed explanation can be found here: +[KIT General Introduction](https://eclipse-tractusx.github.io/Kits) + +## Description + +For providing a KIT to the Eclipse project Tractus-X please be aware of the "getting started" as a contributor. +Prerequisites: [Tractus-X getting started](https://eclipse-tractusx.github.io/docs/oss/getting-started) + +- **TRG 9.02 KIT Maturity Levels** A KIT is always structured the same way and follows three graduation stages +- **TRG 9.03 KIT Artifacts** Each of the artifacts in a KIT are explained with examples diff --git a/documentation/kit-maturity-levels.md b/documentation/kit-maturity-levels.md new file mode 100644 index 00000000000..cf860fcfde2 --- /dev/null +++ b/documentation/kit-maturity-levels.md @@ -0,0 +1,137 @@ +--- +title: KIT Maturity Levels +--- +| Status | Created | Post-History | +|------------|--------------|----------------------------------------| +| Draft | 04-Apr-2024 | Initial contribution | + +## KIT Maturity Levels + +KITs have a maturity level of **sandbox, incubating, or graduated.** +The maturity levels of KITs signals the quality, completeness and proof that the use case solves specific business problem and provides value to all stakeholders. +In order to be promoted from one level to the next, the developers must fulfill various criteria. For each stage, different artifacts and deliverables are defined that must be completed. A distinction is made between mandatory (✓) and recommended ((✓)) deliverables. In order to be promoted to the next level, a KIT must have completed all necessary items of the lower level and at least one necessary item of the following level. As soon as this criteria is met a promotion has to be requested. To achieve graduated status, additionally a case study must be completed with a partner from the community. The aim of this case study is to verify the content of the KIT. The performing partner tries to solve the problem only with the help of the KIT and, if necessary, to make suggestions for improvement that have to be implemented. + +## Initiating a new KIT + +To start a KIT or to be in Sandbox phase you could also be in one of two categories. +Option 1: High maturity. The reason to establish a KIT is clear, you have a scope and other interested companies in contributing to that KIT. Please go directly to Sandbox or Incubating stage. +Option 2: You have an idea and want to see if there is any relevance for this KIT. You still need to find other interested companies for contributing to this KIT: + +1. Create a discussion in the SIG-Release repository under the "Ideas" category [SIG-Release repository - discussions](https://github.com/eclipse-tractusx/sig-release/discussions/categories/ideas ). +2. Provide information on the industry problem that this KIT will solve and the domain it should be placed in. +3. Seek feedback from the community and find other supporters (recommended four companies). +4. Wait for approval from corresponding committer, who will review the repository and new KIT requests./ +Create request for new repository +Once approved, you can start with the Sandbox or move directly into Incubating. + +## Sandbox Stage + +First step is Sandbox stage. This is the starting point of the three stages for a KIT. A defined vision and mission, and business value should be clearly established. In perspective this is a preview of a dormant business innovation. (Please see the mandatory artifacts list). +Ensure the following steps have been addressed to be able to move onto the second phase: Most importantly, you need to be able to participate in open source. +[Getting started to contribute to Tractus-X](https://eclipse-tractusx.github.io/docs/oss/getting-started/) +If the KIT is directly ready to provide more than just a vision, mission and business value - than start directly with Incubating. + +### Steps + +- Step 1: Create an issue (template is available) within the following repository:[Tractus-X Github.io repository](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io) +- Step 2: Check for the list of mandatory facts of the Sandbox phase +- Step 3: Raise a pull request to the repository [Tractus-X Github.io repository](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io) +- Step 4: Your artifacts will undergo an approval phase, quality checks will be done by the committers thereafter the approval phase + +## Incubating Stage + +The incubation phase requires to establish a fully functioning open-source project. Incubating is the first released version of a KIT that can be used for development. +Steps of the Incubating phase: + +- Step 1: Create an issue within the following repository:[Tractus-X Github.io repository](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io) +- Step 2: Check for the list of mandatory artifacts for this stage +- Step 3: Raise a pull request to the repository ([Tractus-X Github.io repository](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io)) +- Step 4: Your artifacts will undergo an approval phase, quality checks will be done by the committers thereafter the approval phase + +## Artifacts + +This an overview - for the details and examples please check the TRG 8.03 - KIT Artifacts. +Legend: +Mandatory ✓ +Optional ✓ * +| Artifact / Stage | Sandbox | Incubating | Graduated | Additional Info | +|---|---|---|---|---| +| Changelog | | ✓ | ✓ | | +| Vision / Mission | ✓ | ✓ | ✓ | | +| Business Value(s) | ✓ | ✓ | ✓ | Supposedly not relevant for Network Services | +| Use Case / Domain explanation | ✓ | ✓ | ✓ | Supposedly not relevant for Network Services | +| Notice | ✓ | ✓ | ✓ | | +| Standards | | ✓ | ✓ | | +| API-Specification / Protocols | | ✓ | ✓ | | +| Logic / Schema | | ✓ | ✓ | Supposedly not relevant for Network Services | +| Documentation | | ✓ | ✓ | | +| Tutorials / Videos | | ✓* | ✓* | | +| Semantic Models | | ✓ | ✓ | Supposedly not relevant for Network Services | +| Business Processes | | ✓ | ✓ | Supposedly not relevant for Network Services | +| Sample Data | | ✓* | ✓* | | +| Reference Implementation | | ✓* | ✓* | | +| Quick Setup Guide | | ✓ | ✓ | Exception if you don´t have reference implementation | +| Architecture | | ✓ | ✓ | Exception if you don´t have reference implementation | +| Whitepaper | | ✓* | ✓* | | + +## Graduation Stage + +How to graduate a KIT? +Graduation is the highest quality level to achieve, all the artifacts in the table above should be completed. It has passed expert testing and been approved. Thereafter, please follow the next steps in how to graduate a KIT. + +### Step 1: Raise a issue to graduate + +[KIT issue](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/issues) +You should provide information such as; + +1. KIT owner’s email address +2. Solution provider / Developer’s email address +3. The KIT name + +### Step 2: Kick off meeting + +1. Introduction into the graduation process +2. What problems / challenges are you facing at the moment? +3. Why is the development of this KIT so relevant for you? What opportunities do you see? +4. What is in the Kick off meeting? (need to make the process slides : agenda so on) + 1. Introduction of the people (adopter and developer) + 2. Basic overview of the KIT (KIT-expert) + 3. Process of the Graduation + 4. Arrange two touch point meetings + 5. Send out the feedback survey + +### Step 3: Start execution + +The solution provider starts on working with the KIT. + +### Step 4: Touch point meetings + +1st Touch point meeting (1 week after start of the execution) + +1. How long did it take to find the relevant information? +2. What do you think should be the next thing to add to help your development to become easier and faster? +3. Do you find the navigation through the pages user friendly? If not, how would you change the structure? +4. Do you think your expected time frame will be met? If not, how much more time do you expect until completion? +2nd touch point meeting (2,5 weeks after start) +1.What were some of the difficulties faced when an outsider company tested it? If there were any. +2.What are some additional remarks from the outside company testing that you would like to share with us? + +### Step 5: Feedback (survey and meeting) + +1. Why did you decide to participate in the KIT study? +2. What were the objectives that needed to be met? +3. What were your expectations? +4. How long did it take you? +5. How many FTEs did you need to integrate your service? +6. Do you need other functions on the API? +7. What major technical difficulties did you face during your tasks to prepare, register and get data? +8. Where there any organizational challenges? If so, what were they? +9. Anything else you would like to share with us? + +### Step 6: closing meeting + +Gathered information thus far. A presentation of the main points validating the KIT (summary presentation) + +### Step 7: Validation + +### Step 8: Publication diff --git a/docusaurus.config.js b/docusaurus.config.js index 9125c92bef2..78ef68ac7db 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -75,7 +75,18 @@ const config = { docLayoutComponent: "@theme/DocPage", docItemComponent: "@theme/ApiItem" // Derived from docusaurus-theme-openapi-docs }, - ], + ], + // -- documentation-kits -- + [ + '@docusaurus/plugin-content-docs', + { + id: 'docs-documentation', + path: 'documentation', + routeBasePath: 'documentation', + editUrl: 'https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/documentation', + sidebarPath: './sidebarsDocumentation.js', + }, + ], // -- Community -- [ '@docusaurus/plugin-content-blog', @@ -383,6 +394,11 @@ const config = { position: 'left', to: '/Kits', items: [ + { + to: '/Kits', + label: 'Kits General', + }, + { to: '/docs-kits/kits/knowledge-agents/adoption-view/intro', label: 'Agents', @@ -427,6 +443,10 @@ const config = { to: '/docs-kits/kits/Behaviour%20Twin%20HI%20Kit/Adoption%20View%20Health%20Indicator%20Kit', label: 'Health Indicator', }, + { + to: '/docs-kits/kits/Industry%20Core%20Kit/Business%20View%20Industry%20Core%20Kit', + label: 'Industry Core', + }, { to: '/docs-kits/kits/Behaviour%20Twin%20MDP%20Kit/Adoption%20View%20Model%20Based%20Development%20and%20Data%20Processing%20Kit', label: 'Model Based Development', @@ -516,32 +536,36 @@ const config = { title: 'Eclipse Foundation', items: [ { - label: "Main Eclipse Foundation website", + label: "About", href: "http://www.eclipse.org", }, { - label: "Privacy policy", + label: "Privacy Policy", href: "http://www.eclipse.org/legal/privacy.php", }, { - label: "Website terms of use", + label: "Terms of Use", href: "http://www.eclipse.org/legal/termsofuse.php", }, { - label: "Copyright agent", - href: "http://www.eclipse.org/legal/copyright.php", + label: "Compliance", + href: "https://www.eclipse.org/legal/compliance/", }, { - label: "Legal", + label: "Legal Resources", href: "http://www.eclipse.org/legal", }, + { + label: "Contact", + href: "https://www.eclipse.org/org/foundation/contact.php", + }, ], }, { - title: 'Community', + title: 'Eclipse Tractus-X', items: [ { - label: "Eclipse Foundation project", + label: "Eclipse Project", href: "https://projects.eclipse.org/projects/automotive.tractusx", }, { @@ -553,21 +577,25 @@ const config = { href: "https://catena-x.net/", }, { - label: "Icons used from svgrepo with CC0 License", - href: "https://www.svgrepo.com/", - } + label: "Mailing List", + href: "https://accounts.eclipse.org/mailing-list/tractusx-dev", + }, + { + label: "Report a Bug", + href: "https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/issues", + }, ], }, { - title: 'Useful Links', + title: 'More', items: [ { - label: "Report a Bug", - href: "https://bugs.eclipse.org/bugs", + label: "Code of Conduct", + href: "https://www.eclipse.org/org/documents/Community_Code_of_Conduct.php", }, { - label: "Documentation", - href: "https://help.eclipse.org/latest/index.jsp", + label: "Report a Vulnerability", + href: "https://github.com/eclipse-tractusx/sig-security/issues/new/choose", }, { label: "How to Contribute", @@ -578,8 +606,8 @@ const config = { href: "https://accounts.eclipse.org/mailing-list", }, { - label: "Forums", - href: "https://www.eclipse.org/forums/", + label: "Matrix Chat", + href: "https://chat.eclipse.org/#/home/", }, ], }, diff --git a/openApi/bpdm/pool.yaml b/openApi/bpdm/pool.yaml deleted file mode 100644 index 901fcbff642..00000000000 --- a/openApi/bpdm/pool.yaml +++ /dev/null @@ -1,5572 +0,0 @@ -openapi: 3.0.1 -info: - title: Business Partner Data Management Pool - description: Service that manages and shares business partner data with other CatenaX services - version: 5.0.1-SNAPSHOT -servers: - - url: http://localhost:8080 - description: Generated server url -paths: - /api/catena/sites: - get: - tags: - - site-controller - summary: Get page of sites matching the pagination search criteria - description: This endpoint retrieves all existing business partners of type sites. - operationId: getSitesPaginated - parameters: - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Page of business partners matching the search criteria, may be empty - content: - application/json: - schema: - $ref: '#/components/schemas/PageDtoSiteMatchVerboseDto' - '400': - description: On malformed pagination request - put: - tags: - - site-controller - summary: Updates an existing site - description: Update existing business partner records of type site referenced via BPNS. The endpoint expects to receive the full updated record, including values that didn't change. - operationId: updateSite - requestBody: - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/SitePartnerUpdateRequest' - required: true - responses: - '200': - description: Update sites request was processed successfully, possible errors are returned - content: - application/json: - schema: - $ref: '#/components/schemas/SitePartnerUpdateResponseWrapper' - '400': - description: On malformed requests - post: - tags: - - site-controller - summary: Creates a new site - description: Create new business partners of type site by specifying the BPNL of the legal entity each site belongs to. If the legal entitiy cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. - operationId: createSite - requestBody: - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/SitePartnerCreateRequest' - required: true - responses: - '200': - description: New sites request was processed successfully, possible errors are returned - content: - application/json: - schema: - $ref: '#/components/schemas/SitePartnerCreateResponseWrapper' - '400': - description: On malformed requests - /api/catena/legal-entities: - get: - tags: - - legal-entity-controller - summary: Returns legal entities by different search parameters - description: 'This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. ' - operationId: getLegalEntities - parameters: - - name: legalName - in: query - description: Filter legal entities by name - required: false - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Page of business partners matching the search criteria, may be empty - content: - application/json: - schema: - $ref: '#/components/schemas/PageDtoLegalEntityMatchVerboseDto' - '400': - description: On malformed search or pagination request - put: - tags: - - legal-entity-controller - summary: Updates an existing legal entity - description: Update existing business partner records of type legal entity referenced via BPNL. The endpoint expects to receive the full updated record, including values that didn't change. - operationId: updateBusinessPartners - requestBody: - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/LegalEntityPartnerUpdateRequest' - required: true - responses: - '200': - description: Update legal entities request was processed successfully, possible errors are returned - content: - application/json: - schema: - $ref: '#/components/schemas/LegalEntityPartnerUpdateResponseWrapper' - '400': - description: On malformed requests - post: - tags: - - legal-entity-controller - summary: Creates a new legal entity - description: Create new business partners of type legal entity. The given additional identifiers of a record need to be unique, otherwise they are ignored. For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. - operationId: createBusinessPartners - requestBody: - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/LegalEntityPartnerCreateRequest' - required: true - responses: - '200': - description: New legal entities request was processed successfully, possible errors are returned - content: - application/json: - schema: - $ref: '#/components/schemas/LegalEntityPartnerCreateResponseWrapper' - '400': - description: On malformed requests - /api/catena/addresses: - get: - tags: - - address-controller - summary: Returns addresses by different search parameters - description: 'This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. ' - operationId: getAddresses_1 - parameters: - - name: name - in: query - description: Filter business partners by name - required: false - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Page of addresses matching the search criteria, may be empty - content: - application/json: - schema: - $ref: '#/components/schemas/PageDtoAddressMatchVerboseDto' - '400': - description: On malformed search or pagination request - put: - tags: - - address-controller - summary: Updates an existing address - description: Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change. - operationId: updateAddresses - requestBody: - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/AddressPartnerUpdateRequest' - required: true - responses: - '200': - description: The successfully updated records, possible errors are returned - content: - application/json: - schema: - $ref: '#/components/schemas/AddressPartnerUpdateResponseWrapper' - '400': - description: On malformed requests - post: - tags: - - address-controller - summary: Creates a new address - description: Create new business partners of type address by specifying the BPN of the parent each address belongs to. A parent can be either a site or legal entity business partner. If the parent cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. - operationId: createAddresses - requestBody: - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/AddressPartnerCreateRequest' - required: true - responses: - '200': - description: New business partner record successfully created, possible errors are returned - content: - application/json: - schema: - $ref: '#/components/schemas/AddressPartnerCreateResponseWrapper' - '400': - description: On malformed requests - /api/catena/sites/search: - post: - tags: - - site-controller - summary: Returns sites by an array of BPNS and/or an array of corresponding BPNL - description: Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities - operationId: searchSites - parameters: - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SiteBpnSearchRequest' - required: true - responses: - '200': - description: Found sites that belong to specified legal entites - content: - application/json: - schema: - $ref: '#/components/schemas/PageDtoSiteWithMainAddressVerboseDto' - '400': - description: On malformed request parameters - /api/catena/sites/main-addresses/search: - post: - tags: - - site-controller - summary: Search for sites' main addresses - description: Search main addresses of site business partners by BPNS - operationId: searchMainAddresses - requestBody: - content: - application/json: - schema: - type: array - items: - type: string - required: true - responses: - '200': - description: The found main addresses - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/MainAddressResponse' - '400': - description: On malformed request parameters - /api/catena/regions: - get: - tags: - - metadata-controller - summary: Get page of regions - description: Lists all currently known regions in a paginated result - operationId: getRegions - parameters: - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Page of existing regions, may be empty - content: - application/json: - schema: - $ref: '#/components/schemas/PageDtoRegionDto' - '400': - description: On malformed request parameters - deprecated: true - post: - tags: - - metadata-controller - summary: Create new Region - description: Create a new region which can be referenced by business partner records. - operationId: createRegion - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegionDto' - required: true - responses: - '200': - description: New region successfully created - content: - application/json: - schema: - $ref: '#/components/schemas/RegionDto' - '400': - description: On malformed request parameters - deprecated: true - /api/catena/legal-forms: - get: - tags: - - metadata-controller - summary: Returns all legal forms - description: Lists all currently known legal forms in a paginated result - operationId: getLegalForms - parameters: - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Page of existing legal forms, may be empty - content: - application/json: - schema: - $ref: '#/components/schemas/PageDtoLegalFormDto' - '400': - description: On malformed request parameters - post: - tags: - - metadata-controller - summary: Creates a new legal form - description: 'Create a new legal form which can be referenced by business partner records. The actual name of the legal form is free to choose and doesn''t need to be unique. The technical key can be freely chosen but needs to be unique for the businessPartnerType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.' - operationId: createLegalForm - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/LegalFormRequest' - required: true - responses: - '200': - description: New legal form successfully created - content: - application/json: - schema: - $ref: '#/components/schemas/LegalFormDto' - '400': - description: On malformed request parameters - '409': - description: Legal form with specified technical key already exists - /api/catena/legal-entities/{bpnl}/confirm-up-to-date: - post: - tags: - - legal-entity-controller - summary: Confirms that the data of a legal entity business partner is still up to date. - description: Confirms that the data of a business partner is still up to date by saving the current timestamp at the time this POST-request is made as this business partner's "currentness". Ignores case of bpnl. - operationId: setLegalEntityCurrentness - parameters: - - name: bpnl - in: path - description: BPNL value - required: true - schema: - type: string - responses: - '200': - description: Business partner's "currentness" successfully updated - '400': - description: On malformed request parameters - '404': - description: No business partner found for specified bpnl - /api/catena/legal-entities/search: - post: - tags: - - legal-entity-controller - summary: Returns legal entities by an array of BPNL - description: Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to ${bpdm.bpn.search-request-limit} entries. - operationId: searchLegalEntitys - requestBody: - content: - application/json: - schema: - type: array - items: - type: string - required: true - responses: - '200': - description: Found legal entites - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/LegalEntityWithLegalAddressVerboseDto' - '400': - description: On malformed request parameters or if number of requested bpns exceeds limit - /api/catena/legal-entities/legal-addresses/search: - post: - tags: - - legal-entity-controller - summary: Search Legal Addresses - description: Search legal addresses of legal entities by BPNL - operationId: searchLegalAddresses - requestBody: - content: - application/json: - schema: - type: array - items: - type: string - required: true - responses: - '200': - description: The found legal addresses - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/LegalAddressVerboseDto' - '400': - description: On malformed request parameters - /api/catena/identifier-types: - get: - tags: - - metadata-controller - summary: Returns all identifier types filtered by business partner type and country. - description: Lists all matching identifier types including validity details in a paginated result - operationId: getIdentifierTypes - parameters: - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - - name: businessPartnerType - in: query - required: true - schema: - type: string - description: Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported. - enum: - - LEGAL_ENTITY - - ADDRESS - - name: country - in: query - required: false - schema: - type: string - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - responses: - '200': - description: Page of existing identifier types, may be empty - content: - application/json: - schema: - $ref: '#/components/schemas/PageDtoIdentifierTypeDto' - '400': - description: On malformed request parameters - post: - tags: - - metadata-controller - summary: Creates a new identifier type - description: 'Create a new identifier type (including validity details) which can be referenced by business partner records. Identifier types such as BPN or VAT determine with which kind of values a business partner can be identified with. The actual name of the identifier type is free to choose and doesn''t need to be unique. The technical key can be freely chosen but needs to be unique for the businessPartnerType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.' - operationId: createIdentifierType - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/IdentifierTypeDto' - required: true - responses: - '200': - description: New identifier type successfully created - content: - application/json: - schema: - $ref: '#/components/schemas/IdentifierTypeDto' - '400': - description: On malformed request parameters - '409': - description: Identifier type with specified technical key already exists - /api/catena/business-partners/changelog/search: - post: - tags: - - changelog-controller - summary: Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types - operationId: getChangelogEntries - parameters: - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ChangelogSearchRequest' - required: true - responses: - '200': - description: The specified changelog entries - content: - application/json: - schema: - $ref: '#/components/schemas/PageDtoChangelogEntryVerboseDto' - '400': - description: On malformed pagination request - '404': - description: No business partner found for specified bpn - /api/catena/bpn/search: - post: - tags: - - bpn-controller - summary: Returns a list of identifier mappings of an identifier to a BPNL/A/S, specified by a business partner type, identifier type and identifier values - description: Find business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to ${bpdm.bpn.search-request-limit} entries. - operationId: findBpnsByIdentifiers - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/IdentifiersSearchRequest' - required: true - responses: - '200': - description: Found bpn to identifier value mappings - content: - application/json: - schema: - uniqueItems: true - type: array - items: - $ref: '#/components/schemas/BpnIdentifierMappingDto' - '400': - description: On malformed request parameters or if number of requested bpns exceeds limit - '404': - description: Specified identifier type not found - /api/catena/addresses/search: - post: - tags: - - address-controller - summary: Returns addresses by an array of BPNA and/or an array of corresponding BPNS and/or an array of corresponding BPNL. - description: Search business partners of type address by their BPNA or their parents' BPNL or BPNS. - operationId: searchAddresses - parameters: - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddressPartnerBpnSearchRequest' - required: true - responses: - '200': - description: Found sites for the specified sites and legal entities - content: - application/json: - schema: - $ref: '#/components/schemas/PageDtoLogisticAddressVerboseDto' - '400': - description: On malformed pagination request - /api/catena/sites/{bpns}: - get: - tags: - - site-controller - summary: Returns a site by its BPNS - description: Get business partners of type site by BPNS ignoring case. - operationId: getSite - parameters: - - name: bpns - in: path - description: BPNS value - required: true - schema: - type: string - responses: - '200': - description: Found site with specified BPNS - content: - application/json: - schema: - $ref: '#/components/schemas/SiteWithMainAddressVerboseDto' - '400': - description: On malformed request parameters - '404': - description: No site found under specified BPNS - /api/catena/mermaid/: - get: - tags: - - pool-documentation-controller - summary: Get mermaid class diagramm for the pool JPA model - operationId: getMermaidPoolPersistence - responses: - '200': - description: Entity model as mermaid diagramm - content: - text/plain: - schema: - type: string - /api/catena/legal-entities/{idValue}: - get: - tags: - - legal-entity-controller - summary: Returns a legal entity by identifier, like BPN, DUNS or EU VAT ID, specified by the identifier type - description: This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type. - operationId: getLegalEntity - parameters: - - name: idValue - in: path - description: Identifier value - required: true - schema: - type: string - - name: idType - in: query - description: Type of identifier to use, defaults to BPN when omitted - required: false - schema: - type: string - default: BPN - responses: - '200': - description: Found business partner with specified identifier - content: - application/json: - schema: - $ref: '#/components/schemas/LegalEntityWithLegalAddressVerboseDto' - '400': - description: On malformed request parameters - '404': - description: No business partner found under specified identifier or specified identifier type not found - /api/catena/legal-entities/{bpnl}/sites: - get: - tags: - - legal-entity-controller - summary: Returns all sites of a legal entity with a specific BPNL - description: Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpnl ignoring case. - operationId: getSites - parameters: - - name: bpnl - in: path - description: BPNL value - required: true - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: The sites for the specified bpnl - content: - application/json: - schema: - $ref: '#/components/schemas/PageDtoSiteVerboseDto' - '400': - description: On malformed pagination request - '404': - description: No business partner found for specified bpnl - /api/catena/legal-entities/{bpnl}/addresses: - get: - tags: - - legal-entity-controller - summary: Returns all addresses of a legal entity with a specific BPNL - description: Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's BPNL ignoring case. - operationId: getAddresses - parameters: - - name: bpnl - in: path - description: BPNL value - required: true - schema: - type: string - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: The addresses for the specified BPNL - content: - application/json: - schema: - $ref: '#/components/schemas/PageDtoLogisticAddressVerboseDto' - '400': - description: On malformed pagination request - '404': - description: No business partner found for specified BPNL - /api/catena/field-quality-rules/: - get: - tags: - - metadata-controller - summary: Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code) - description: List the country specific data rules for entity fields.All fields that are not in this list are considered to be forbidden. - operationId: getFieldQualityRules - parameters: - - name: country - in: query - description: ISO 3166-1 alpha-2 country code - required: true - schema: - type: string - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - responses: - '200': - description: List of the existing rules for the given country - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/FieldQualityRuleDto' - '400': - description: On malformed request parameters - /api/catena/administrative-areas-level1: - get: - tags: - - metadata-controller - summary: Get page of country subdivisions suitable for the administrativeAreaLevel1 address property - description: Lists all currently known country subdivisions according to ISO 3166-2 in a paginated result - operationId: getAdminAreasLevel1 - parameters: - - name: page - in: query - description: Number of page to get results from - required: false - schema: - minimum: 0 - type: string - default: '0' - - name: size - in: query - description: Size of each page - required: false - schema: - maximum: 100 - minimum: 0 - type: string - default: '10' - responses: - '200': - description: Page of existing country subdivisions, may be empty - content: - application/json: - schema: - $ref: '#/components/schemas/PageDtoCountrySubdivisionDto' - '400': - description: On malformed request parameters - /api/catena/addresses/{bpna}: - get: - tags: - - address-controller - summary: Returns an address by its BPNA - description: Get business partners of type address by BPNA ignoring case. - operationId: getAddress - parameters: - - name: bpna - in: path - description: BPNA value - required: true - schema: - type: string - responses: - '200': - description: Found address with specified BPNA - content: - application/json: - schema: - $ref: '#/components/schemas/LogisticAddressVerboseDto' - '400': - description: On malformed request parameters - '404': - description: No address found under specified BPNA -components: - schemas: - AddressIdentifierDto: - required: - - type - - value - type: object - properties: - value: - type: string - description: The value of the identifier like "0847976000005". - type: - type: string - description: The type of the identifier. - description: An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN). - AddressIdentifierVerboseDto: - required: - - type - - value - type: object - properties: - value: - type: string - description: The value of the identifier like "0847976000005". - type: - $ref: '#/components/schemas/TypeKeyNameVerboseDtoString' - description: An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN). - AddressMatchVerboseDto: - required: - - address - - score - type: object - properties: - score: - type: number - description: Relative quality score of the match. The higher the better. - format: float - address: - $ref: '#/components/schemas/LogisticAddressVerboseDto' - description: Match for a business partner record of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - AddressPartnerBpnSearchRequest: - required: - - addresses - - legalEntities - - sites - type: object - properties: - legalEntities: - type: array - description: Filter by Business Partner Numbers of legal entities which are at that address - items: - type: string - description: Filter by Business Partner Numbers of legal entities which are at that address - sites: - type: array - description: Filter by Business Partner Numbers of sites which are at that address - items: - type: string - description: Filter by Business Partner Numbers of sites which are at that address - addresses: - type: array - description: Filter by BPNA of addresses - items: - type: string - description: Filter by BPNA of addresses - description: Request for searching business partners of type address by parent BPNs - AddressPartnerCreateRequest: - required: - - bpnParent - - confidenceCriteria - - identifiers - - physicalPostalAddress - - states - type: object - properties: - name: - type: string - description: The name of the address. This is not according to official registers but according to the name the sharing member chooses. - states: - type: array - description: The list of (temporary) states of the address. - items: - $ref: '#/components/schemas/AddressStateDto' - identifiers: - type: array - description: The list of identifiers of the address. - items: - $ref: '#/components/schemas/AddressIdentifierDto' - physicalPostalAddress: - $ref: '#/components/schemas/PhysicalPostalAddressDto' - alternativePostalAddress: - $ref: '#/components/schemas/AlternativePostalAddressDto' - confidenceCriteria: - $ref: '#/components/schemas/ConfidenceCriteriaDto' - bpnParent: - type: string - description: BPNL of the legal entity or BPNS of the site this address belongs to. - index: - type: string - description: User defined index to conveniently match this entry to the corresponding entry in the response. - requestKey: - type: string - description: Request for creating new business partner record of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - AddressPartnerCreateResponseWrapper: - required: - - entities - - entityCount - - errorCount - - errors - type: object - properties: - entities: - type: array - items: - $ref: '#/components/schemas/AddressPartnerCreateVerboseDto' - errors: - type: array - items: - $ref: '#/components/schemas/ErrorInfoAddressCreateError' - entityCount: - type: integer - format: int32 - errorCount: - type: integer - format: int32 - description: Holds information about successfully and failed entities after the creating/updating of several objects - AddressPartnerCreateVerboseDto: - required: - - bpna - - confidenceCriteria - - createdAt - - identifiers - - isLegalAddress - - isMainAddress - - physicalPostalAddress - - states - - updatedAt - type: object - properties: - bpna: - type: string - description: A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity. - name: - type: string - description: The name of the address. This is not according to official registers but according to the name the sharing member chooses. - states: - type: array - description: The list of (temporary) states of the address. - items: - $ref: '#/components/schemas/AddressStateVerboseDto' - identifiers: - type: array - description: The list of identifiers of the address. - items: - $ref: '#/components/schemas/AddressIdentifierVerboseDto' - physicalPostalAddress: - $ref: '#/components/schemas/PhysicalPostalAddressVerboseDto' - alternativePostalAddress: - $ref: '#/components/schemas/AlternativePostalAddressVerboseDto' - bpnLegalEntity: - type: string - description: The BPNL of the legal entity owning the address. - isLegalAddress: - type: boolean - description: Indicates if the address is the legal address to a legal entity. - bpnSite: - type: string - description: The BPNS of the site the address belongs to. - isMainAddress: - type: boolean - description: Indicates if the address is the main address to a site. This is where typically the main entrance or the reception is located, or where the mail is delivered to. - createdAt: - type: string - description: The date when the data record has been created. - format: date-time - updatedAt: - type: string - description: The date when the data record has been last updated. - format: date-time - confidenceCriteria: - $ref: '#/components/schemas/ConfidenceCriteriaDto' - addressType: - type: string - description: Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to. - enum: - - LegalAndSiteMainAddress - - LegalAddress - - SiteMainAddress - - AdditionalAddress - index: - type: string - description: User defined index to conveniently match this entry to the corresponding entry in the response. - description: Created business partner of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - AddressPartnerUpdateRequest: - required: - - bpna - - confidenceCriteria - - identifiers - - physicalPostalAddress - - requestKey - - states - type: object - properties: - bpna: - type: string - description: A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity. - name: - type: string - description: The name of the address. This is not according to official registers but according to the name the sharing member chooses. - states: - type: array - description: The list of (temporary) states of the address. - items: - $ref: '#/components/schemas/AddressStateDto' - identifiers: - type: array - description: The list of identifiers of the address. - items: - $ref: '#/components/schemas/AddressIdentifierDto' - physicalPostalAddress: - $ref: '#/components/schemas/PhysicalPostalAddressDto' - alternativePostalAddress: - $ref: '#/components/schemas/AlternativePostalAddressDto' - confidenceCriteria: - $ref: '#/components/schemas/ConfidenceCriteriaDto' - requestKey: - type: string - description: Request for updating a business partner record of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - AddressPartnerUpdateResponseWrapper: - required: - - entities - - entityCount - - errorCount - - errors - type: object - properties: - entities: - type: array - items: - $ref: '#/components/schemas/LogisticAddressVerboseDto' - errors: - type: array - items: - $ref: '#/components/schemas/ErrorInfoAddressUpdateError' - entityCount: - type: integer - format: int32 - errorCount: - type: integer - format: int32 - description: Holds information about successfully and failed entities after the creating/updating of several objects - AddressStateDto: - required: - - type - type: object - properties: - validFrom: - type: string - description: The date from which the state is valid. - format: date-time - validTo: - type: string - description: The date until the state is valid. - format: date-time - type: - type: string - description: 'One of the state types: active, inactive.' - enum: - - ACTIVE - - INACTIVE - description: An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address. - AddressStateVerboseDto: - required: - - type - type: object - properties: - validFrom: - type: string - description: The date from which the state is valid. - format: date-time - validTo: - type: string - description: The date until the state is valid. - format: date-time - type: - $ref: '#/components/schemas/TypeKeyNameVerboseDtoBusinessStateType' - description: An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address. - AlternativePostalAddressDto: - required: - - city - - country - - deliveryServiceNumber - - deliveryServiceType - type: object - properties: - geographicCoordinates: - $ref: '#/components/schemas/GeoCoordinateDto' - country: - type: string - description: The 2-digit country code of the physical postal address according to ISO 3166-1. - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - administrativeAreaLevel1: - type: string - description: The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country. - postalCode: - type: string - description: The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code. - city: - type: string - description: 'The name of the city of the physical postal address, synonyms: town, village, municipality.' - deliveryServiceType: - type: string - description: 'One of the alternative postal address types: P.O. box, private bag, boite postale.' - enum: - - PO_BOX - - PRIVATE_BAG - - BOITE_POSTALE - deliveryServiceQualifier: - type: string - description: The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities. - deliveryServiceNumber: - type: string - description: The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number. - description: An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - AlternativePostalAddressVerboseDto: - required: - - city - - country - - deliveryServiceNumber - - deliveryServiceType - type: object - properties: - geographicCoordinates: - $ref: '#/components/schemas/GeoCoordinateDto' - country: - $ref: '#/components/schemas/TypeKeyNameVerboseDtoCountryCode' - administrativeAreaLevel1: - $ref: '#/components/schemas/RegionDto' - postalCode: - type: string - description: The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code. - city: - type: string - description: 'The name of the city of the physical postal address, synonyms: town, village, municipality.' - deliveryServiceType: - type: string - description: 'One of the alternative postal address types: P.O. box, private bag, boite postale.' - enum: - - PO_BOX - - PRIVATE_BAG - - BOITE_POSTALE - deliveryServiceQualifier: - type: string - description: The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities. - deliveryServiceNumber: - type: string - description: The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number. - description: An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - BpnIdentifierMappingDto: - required: - - bpn - - idValue - type: object - properties: - idValue: - type: string - description: Value of the identifier - bpn: - type: string - description: Business Partner Number - description: Mapping of Business Partner Number to identifier value - ChangelogEntryVerboseDto: - required: - - bpn - - businessPartnerType - - changelogType - - timestamp - type: object - properties: - bpn: - type: string - description: The business partner number for which the changelog entry was created. Can be either a BPNL, BPNS or BPNA. - businessPartnerType: - type: string - description: 'One of the types of business partners for which the changelog entry was created: legal entity, site, address.' - enum: - - LEGAL_ENTITY - - SITE - - ADDRESS - - GENERIC - timestamp: - type: string - description: The date and time when the changelog entry was created. - format: date-time - changelogType: - type: string - description: 'One of the actions for which the changelog entry was created: create, update.' - enum: - - CREATE - - UPDATE - description: An entry of the changelog, which is created each time a business partner is modified and contains data about the change. The actual new state of the business partner is not included. - ChangelogSearchRequest: - type: object - properties: - timestampAfter: - type: string - description: Only changelog entries created after this time. Ignored if empty. - format: date-time - example: '2023-03-20T10:23:28.194Z' - bpns: - uniqueItems: true - type: array - description: Only for business partners with the given array of BPNL/S/A. Ignored if empty. - items: - type: string - businessPartnerTypes: - uniqueItems: true - type: array - description: Only for business partners with the given array of business partner types. Ignored if empty. - items: - type: string - enum: - - LEGAL_ENTITY - - SITE - - ADDRESS - - GENERIC - description: Request for searching and filtering the business partner changelog - ConfidenceCriteriaDto: - required: - - checkedByExternalDataSource - - confidenceLevel - - lastConfidenceCheckAt - - nextConfidenceCheckAt - - numberOfBusinessPartners - - sharedByOwner - type: object - properties: - sharedByOwner: - type: boolean - checkedByExternalDataSource: - type: boolean - numberOfBusinessPartners: - type: integer - format: int32 - lastConfidenceCheckAt: - type: string - format: date-time - nextConfidenceCheckAt: - type: string - format: date-time - confidenceLevel: - type: integer - format: int32 - CountrySubdivisionDto: - required: - - code - - countryCode - - name - type: object - properties: - countryCode: - type: string - description: Country code - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - code: - type: string - description: The country subdivision code according to ISO 3166-2 - name: - type: string - description: The name of the country subdivision according to ISO 3166-2 - description: Country subdivision - ErrorInfoAddressCreateError: - title: ErrorInfo - required: - - errorCode - - message - type: object - properties: - errorCode: - type: string - description: AddressCreateError - enum: - - BpnNotValid - - SiteNotFound - - LegalEntityNotFound - - RegionNotFound - - IdentifierNotFound - - AddressDuplicateIdentifier - message: - type: string - description: Error message that explains the error - entityKey: - type: string - description: 'Key of the entity that failed from the request object: index or BPN' - description: Holds information about failures when creating or updating an entity - ErrorInfoAddressUpdateError: - title: ErrorInfo - required: - - errorCode - - message - type: object - properties: - errorCode: - type: string - description: AddressUpdateError - enum: - - AddressNotFound - - RegionNotFound - - IdentifierNotFound - - AddressDuplicateIdentifier - message: - type: string - description: Error message that explains the error - entityKey: - type: string - description: 'Key of the entity that failed from the request object: index or BPN' - description: Holds information about failures when creating or updating an entity - ErrorInfoLegalEntityCreateError: - title: ErrorInfo - required: - - errorCode - - message - type: object - properties: - errorCode: - type: string - description: LegalEntityCreateError - enum: - - LegalEntityDuplicateIdentifier - - LegalFormNotFound - - LegalEntityIdentifierNotFound - - LegalAddressRegionNotFound - - LegalAddressIdentifierNotFound - - LegalAddressDuplicateIdentifier - message: - type: string - description: Error message that explains the error - entityKey: - type: string - description: 'Key of the entity that failed from the request object: index or BPN' - description: Holds information about failures when creating or updating an entity - ErrorInfoLegalEntityUpdateError: - title: ErrorInfo - required: - - errorCode - - message - type: object - properties: - errorCode: - type: string - description: LegalEntityUpdateError - enum: - - LegalEntityNotFound - - LegalEntityDuplicateIdentifier - - LegalFormNotFound - - LegalEntityIdentifierNotFound - - LegalAddressRegionNotFound - - LegalAddressIdentifierNotFound - - LegalAddressDuplicateIdentifier - message: - type: string - description: Error message that explains the error - entityKey: - type: string - description: 'Key of the entity that failed from the request object: index or BPN' - description: Holds information about failures when creating or updating an entity - ErrorInfoSiteCreateError: - title: ErrorInfo - required: - - errorCode - - message - type: object - properties: - errorCode: - type: string - description: SiteCreateError - enum: - - LegalEntityNotFound - - MainAddressIdentifierNotFound - - MainAddressRegionNotFound - - MainAddressDuplicateIdentifier - message: - type: string - description: Error message that explains the error - entityKey: - type: string - description: 'Key of the entity that failed from the request object: index or BPN' - description: Holds information about failures when creating or updating an entity - ErrorInfoSiteUpdateError: - title: ErrorInfo - required: - - errorCode - - message - type: object - properties: - errorCode: - type: string - description: SiteUpdateError - enum: - - SiteNotFound - - MainAddressIdentifierNotFound - - MainAddressRegionNotFound - - MainAddressDuplicateIdentifier - message: - type: string - description: Error message that explains the error - entityKey: - type: string - description: 'Key of the entity that failed from the request object: index or BPN' - description: Holds information about failures when creating or updating an entity - FieldQualityRuleDto: - required: - - country - - fieldPath - - qualityLevel - type: object - properties: - fieldPath: - type: string - description: Path to the field - schemaName: - type: string - description: Schema name of the entity the field belongs to - country: - type: string - description: Country for wich the rule is valid - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - qualityLevel: - type: string - description: Defines the quality of an entity field. - enum: - - MANDATORY - - OPTIONAL - - FORBIDDEN - description: 'Rule for the quality level of an entity field ' - GeoCoordinateDto: - required: - - latitude - - longitude - type: object - properties: - longitude: - type: number - description: Longitude coordinate - format: float - latitude: - type: number - description: Latitude coordinate - format: float - altitude: - type: number - description: Altitude, if applicable - format: float - description: The exact location of the physical postal address in latitude, longitude, and altitude. - IdentifierTypeDetailDto: - required: - - mandatory - type: object - properties: - country: - type: string - description: 2-digit country code for which this identifier is valid; null for universal identifiers. - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - mandatory: - type: boolean - description: True if identifier is mandatory in this country. - description: Information for which countries an identifier type is valid and mandatory. - IdentifierTypeDto: - required: - - businessPartnerType - - details - - name - - technicalKey - type: object - properties: - technicalKey: - type: string - description: The technical identifier (unique in combination with businessPartnerType). - businessPartnerType: - type: string - description: Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported. - enum: - - LEGAL_ENTITY - - ADDRESS - name: - type: string - description: The name of the identifier type. - details: - type: array - description: Validity details. - items: - $ref: '#/components/schemas/IdentifierTypeDetailDto' - description: An identifier type defines the name or category of an identifier, such as the German Handelsregisternummer, VAT number, Global Location Number (GLN), etc. The identifier type is valid for a business partner type. - IdentifiersSearchRequest: - required: - - businessPartnerType - - idType - - idValues - type: object - properties: - businessPartnerType: - type: string - description: Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported. - enum: - - LEGAL_ENTITY - - ADDRESS - idType: - type: string - description: Technical key of the type to which the identifiers belongs to - idValues: - type: array - description: Values of the identifiers - items: - type: string - description: Values of the identifiers - description: Contains identifiers to search legal entities by - LegalAddressVerboseDto: - required: - - bpnLegalEntity - - createdAt - - physicalPostalAddress - - updatedAt - type: object - properties: - physicalPostalAddress: - $ref: '#/components/schemas/PhysicalPostalAddressVerboseDto' - alternativePostalAddress: - $ref: '#/components/schemas/AlternativePostalAddressVerboseDto' - bpnLegalEntity: - type: string - description: BPN of the related legal entity - createdAt: - type: string - description: The timestamp the business partner data was created - format: date-time - updatedAt: - type: string - description: The timestamp the business partner data was last updated - format: date-time - description: Legal address for legal entity - LegalEntityClassificationDto: - required: - - type - type: object - properties: - type: - type: string - description: Type of classification. - enum: - - NACE - - NAF - - NAICS - - SIC - code: - type: string - description: The identifier of the class belonging to the classification. - value: - type: string - description: The name of the class belonging to the classification. - description: A legal entity classification is an assignment of the legal entity to an industry. It does not necessarily have to be the only industry the company is active in (see large companies operating in different industries). Multiple assignments to several industries are possible per classification type. - LegalEntityClassificationVerboseDto: - required: - - type - type: object - properties: - value: - type: string - description: The name of the class belonging to the classification. - code: - type: string - description: The identifier of the class belonging to the classification. - type: - $ref: '#/components/schemas/TypeKeyNameVerboseDtoClassificationType' - description: A legal entity classification is an assignment of the legal entity to an industry. It does not necessarily have to be the only industry the company is active in (see large companies operating in different industries). Multiple assignments to several industries are possible per classification type. - LegalEntityIdentifierDto: - required: - - type - - value - type: object - properties: - value: - type: string - description: The value of the identifier like "DE123465789". - type: - type: string - description: The type of the identifier. - issuingBody: - type: string - description: The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister. - description: A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc. - LegalEntityIdentifierVerboseDto: - required: - - type - - value - type: object - properties: - value: - type: string - description: The value of the identifier like "DE123465789". - type: - $ref: '#/components/schemas/TypeKeyNameVerboseDtoString' - issuingBody: - type: string - description: The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister. - description: A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc. - LegalEntityMatchVerboseDto: - required: - - bpnl - - classifications - - confidenceCriteria - - createdAt - - currentness - - identifiers - - legalAddress - - legalName - - relations - - score - - states - - updatedAt - type: object - properties: - score: - type: number - description: Relative quality score of the match. The higher the better. - format: float - bpnl: - type: string - description: A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number. - legalName: - type: string - description: The name of the legal entity according to official registers. - legalShortName: - type: string - description: The abbreviated name of the legal entity. - legalForm: - $ref: '#/components/schemas/LegalFormDto' - identifiers: - type: array - description: The list of identifiers of the legal entity. - items: - $ref: '#/components/schemas/LegalEntityIdentifierVerboseDto' - states: - type: array - description: The list of (temporary) states of the legal entity. - items: - $ref: '#/components/schemas/LegalEntityStateVerboseDto' - classifications: - type: array - description: The list of classifications of the legal entity, such as a specific industry. - items: - $ref: '#/components/schemas/LegalEntityClassificationVerboseDto' - relations: - type: array - description: Relations to other business partners. - items: - $ref: '#/components/schemas/RelationVerboseDto' - currentness: - type: string - description: The date the business partner data was last indicated to be still current. - format: date-time - confidenceCriteria: - $ref: '#/components/schemas/ConfidenceCriteriaDto' - createdAt: - type: string - description: The date when the data record has been created. - format: date-time - updatedAt: - type: string - description: The date when the data record has been last updated. - format: date-time - legalAddress: - $ref: '#/components/schemas/LogisticAddressVerboseDto' - description: Match with score for a business partner record of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. - LegalEntityPartnerCreateRequest: - required: - - classifications - - confidenceCriteria - - identifiers - - legalAddress - - legalName - - states - type: object - properties: - legalName: - type: string - description: The name of the legal entity according to official registers. - legalShortName: - type: string - description: The abbreviated name of the legal entity. - legalForm: - type: string - description: The legal form of the legal entity. - identifiers: - type: array - description: The list of identifiers of the legal entity. - items: - $ref: '#/components/schemas/LegalEntityIdentifierDto' - states: - type: array - description: The list of (temporary) states of the legal entity. - items: - $ref: '#/components/schemas/LegalEntityStateDto' - classifications: - type: array - description: The list of classifications of the legal entity, such as a specific industry. - items: - $ref: '#/components/schemas/LegalEntityClassificationDto' - confidenceCriteria: - $ref: '#/components/schemas/ConfidenceCriteriaDto' - legalAddress: - $ref: '#/components/schemas/LogisticAddressDto' - index: - type: string - description: User defined index to conveniently match this entry to the corresponding entry in the response. - requestKey: - type: string - description: Request for creating new business partner record of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. - LegalEntityPartnerCreateResponseWrapper: - required: - - entities - - entityCount - - errorCount - - errors - type: object - properties: - entities: - type: array - items: - $ref: '#/components/schemas/LegalEntityPartnerCreateVerboseDto' - errors: - type: array - items: - $ref: '#/components/schemas/ErrorInfoLegalEntityCreateError' - entityCount: - type: integer - format: int32 - errorCount: - type: integer - format: int32 - description: Holds information about successfully and failed entities after the creating/updating of several objects - LegalEntityPartnerCreateVerboseDto: - required: - - bpnl - - classifications - - confidenceCriteria - - createdAt - - currentness - - identifiers - - legalAddress - - legalName - - relations - - states - - updatedAt - type: object - properties: - bpnl: - type: string - description: A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number. - legalName: - type: string - description: The name of the legal entity according to official registers. - legalShortName: - type: string - description: The abbreviated name of the legal entity. - legalForm: - $ref: '#/components/schemas/LegalFormDto' - identifiers: - type: array - description: The list of identifiers of the legal entity. - items: - $ref: '#/components/schemas/LegalEntityIdentifierVerboseDto' - states: - type: array - description: The list of (temporary) states of the legal entity. - items: - $ref: '#/components/schemas/LegalEntityStateVerboseDto' - classifications: - type: array - description: The list of classifications of the legal entity, such as a specific industry. - items: - $ref: '#/components/schemas/LegalEntityClassificationVerboseDto' - relations: - type: array - description: Relations to other business partners. - items: - $ref: '#/components/schemas/RelationVerboseDto' - currentness: - type: string - description: The date the business partner data was last indicated to be still current. - format: date-time - confidenceCriteria: - $ref: '#/components/schemas/ConfidenceCriteriaDto' - createdAt: - type: string - description: The date when the data record has been created. - format: date-time - updatedAt: - type: string - description: The date when the data record has been last updated. - format: date-time - legalAddress: - $ref: '#/components/schemas/LogisticAddressVerboseDto' - index: - type: string - description: User defined index to conveniently match this entry to the corresponding entry in the response. - description: Created/updated business partner of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. - LegalEntityPartnerUpdateRequest: - required: - - bpnl - - classifications - - confidenceCriteria - - identifiers - - legalAddress - - legalName - - requestKey - - states - type: object - properties: - bpnl: - type: string - description: A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number. - legalName: - type: string - description: The name of the legal entity according to official registers. - legalShortName: - type: string - description: The abbreviated name of the legal entity. - legalForm: - type: string - description: The legal form of the legal entity. - identifiers: - type: array - description: The list of identifiers of the legal entity. - items: - $ref: '#/components/schemas/LegalEntityIdentifierDto' - states: - type: array - description: The list of (temporary) states of the legal entity. - items: - $ref: '#/components/schemas/LegalEntityStateDto' - classifications: - type: array - description: The list of classifications of the legal entity, such as a specific industry. - items: - $ref: '#/components/schemas/LegalEntityClassificationDto' - confidenceCriteria: - $ref: '#/components/schemas/ConfidenceCriteriaDto' - legalAddress: - $ref: '#/components/schemas/LogisticAddressDto' - requestKey: - type: string - description: Request for updating a business partner record of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. - LegalEntityPartnerUpdateResponseWrapper: - required: - - entities - - entityCount - - errorCount - - errors - type: object - properties: - entities: - type: array - items: - $ref: '#/components/schemas/LegalEntityPartnerCreateVerboseDto' - errors: - type: array - items: - $ref: '#/components/schemas/ErrorInfoLegalEntityUpdateError' - entityCount: - type: integer - format: int32 - errorCount: - type: integer - format: int32 - description: Holds information about successfully and failed entities after the creating/updating of several objects - LegalEntityStateDto: - required: - - type - type: object - properties: - validFrom: - type: string - description: The date from which the state is valid. - format: date-time - validTo: - type: string - description: The date until the state is valid. - format: date-time - type: - type: string - description: 'One of the state types: active, inactive.' - enum: - - ACTIVE - - INACTIVE - description: A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating. - LegalEntityStateVerboseDto: - required: - - type - type: object - properties: - validFrom: - type: string - description: The date from which the state is valid. - format: date-time - validTo: - type: string - description: The date until the state is valid. - format: date-time - type: - $ref: '#/components/schemas/TypeKeyNameVerboseDtoBusinessStateType' - description: A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating. - LegalEntityWithLegalAddressVerboseDto: - required: - - bpnl - - classifications - - confidenceCriteria - - createdAt - - currentness - - identifiers - - legalAddress - - legalName - - relations - - states - - updatedAt - type: object - properties: - bpnl: - type: string - description: A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number. - legalName: - type: string - description: The name of the legal entity according to official registers. - legalShortName: - type: string - description: The abbreviated name of the legal entity. - legalForm: - $ref: '#/components/schemas/LegalFormDto' - identifiers: - type: array - description: The list of identifiers of the legal entity. - items: - $ref: '#/components/schemas/LegalEntityIdentifierVerboseDto' - states: - type: array - description: The list of (temporary) states of the legal entity. - items: - $ref: '#/components/schemas/LegalEntityStateVerboseDto' - classifications: - type: array - description: The list of classifications of the legal entity, such as a specific industry. - items: - $ref: '#/components/schemas/LegalEntityClassificationVerboseDto' - relations: - type: array - description: Relations to other business partners. - items: - $ref: '#/components/schemas/RelationVerboseDto' - currentness: - type: string - description: The date the business partner data was last indicated to be still current. - format: date-time - confidenceCriteria: - $ref: '#/components/schemas/ConfidenceCriteriaDto' - createdAt: - type: string - description: The date when the data record has been created. - format: date-time - updatedAt: - type: string - description: The date when the data record has been last updated. - format: date-time - legalAddress: - $ref: '#/components/schemas/LogisticAddressVerboseDto' - description: In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. - LegalFormDto: - required: - - name - - technicalKey - type: object - properties: - technicalKey: - type: string - description: The technical identifier of the legal form according to ISO 20275. - name: - type: string - description: The name of legal form according to ISO 20275. - abbreviation: - type: string - description: The abbreviated name of the legal form, such as AG for German Aktiengesellschaft. - description: A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities. - LegalFormRequest: - required: - - name - - technicalKey - type: object - properties: - technicalKey: - type: string - description: Unique key to be used for reference - name: - type: string - description: Full name of the legal form - abbreviation: - type: string - description: Abbreviation of the legal form name - description: New legal form record to be referenced by business partners - LogisticAddressDto: - required: - - confidenceCriteria - - identifiers - - physicalPostalAddress - - states - type: object - properties: - name: - type: string - description: The name of the address. This is not according to official registers but according to the name the sharing member chooses. - states: - type: array - description: The list of (temporary) states of the address. - items: - $ref: '#/components/schemas/AddressStateDto' - identifiers: - type: array - description: The list of identifiers of the address. - items: - $ref: '#/components/schemas/AddressIdentifierDto' - physicalPostalAddress: - $ref: '#/components/schemas/PhysicalPostalAddressDto' - alternativePostalAddress: - $ref: '#/components/schemas/AlternativePostalAddressDto' - confidenceCriteria: - $ref: '#/components/schemas/ConfidenceCriteriaDto' - description: In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - LogisticAddressVerboseDto: - required: - - bpna - - confidenceCriteria - - createdAt - - identifiers - - isLegalAddress - - isMainAddress - - physicalPostalAddress - - states - - updatedAt - type: object - properties: - bpna: - type: string - description: A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity. - name: - type: string - description: The name of the address. This is not according to official registers but according to the name the sharing member chooses. - states: - type: array - description: The list of (temporary) states of the address. - items: - $ref: '#/components/schemas/AddressStateVerboseDto' - identifiers: - type: array - description: The list of identifiers of the address. - items: - $ref: '#/components/schemas/AddressIdentifierVerboseDto' - physicalPostalAddress: - $ref: '#/components/schemas/PhysicalPostalAddressVerboseDto' - alternativePostalAddress: - $ref: '#/components/schemas/AlternativePostalAddressVerboseDto' - bpnLegalEntity: - type: string - description: The BPNL of the legal entity owning the address. - isLegalAddress: - type: boolean - description: Indicates if the address is the legal address to a legal entity. - bpnSite: - type: string - description: The BPNS of the site the address belongs to. - isMainAddress: - type: boolean - description: Indicates if the address is the main address to a site. This is where typically the main entrance or the reception is located, or where the mail is delivered to. - createdAt: - type: string - description: The date when the data record has been created. - format: date-time - updatedAt: - type: string - description: The date when the data record has been last updated. - format: date-time - confidenceCriteria: - $ref: '#/components/schemas/ConfidenceCriteriaDto' - addressType: - type: string - description: Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to. - enum: - - LegalAndSiteMainAddress - - LegalAddress - - SiteMainAddress - - AdditionalAddress - description: In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - MainAddressResponse: - required: - - bpnSite - - createdAt - - physicalPostalAddress - - updatedAt - type: object - properties: - physicalPostalAddress: - $ref: '#/components/schemas/PhysicalPostalAddressVerboseDto' - alternativePostalAddress: - $ref: '#/components/schemas/AlternativePostalAddressVerboseDto' - bpnSite: - type: string - description: BPN of the related site - createdAt: - type: string - description: The timestamp the business partner data was created - format: date-time - updatedAt: - type: string - description: The timestamp the business partner data was last updated - format: date-time - description: Main address for site - PageDtoAddressMatchVerboseDto: - required: - - content - - contentSize - - page - - totalElements - - totalPages - type: object - properties: - totalElements: - type: integer - description: Total number of all results in all pages - format: int64 - totalPages: - type: integer - description: Total number pages - format: int32 - page: - type: integer - description: Current page number - format: int32 - contentSize: - type: integer - description: Number of results in the page - format: int32 - content: - type: array - description: Collection of results in the page - items: - $ref: '#/components/schemas/AddressMatchVerboseDto' - description: Paginated collection of results - PageDtoChangelogEntryVerboseDto: - required: - - content - - contentSize - - page - - totalElements - - totalPages - type: object - properties: - totalElements: - type: integer - description: Total number of all results in all pages - format: int64 - totalPages: - type: integer - description: Total number pages - format: int32 - page: - type: integer - description: Current page number - format: int32 - contentSize: - type: integer - description: Number of results in the page - format: int32 - content: - type: array - description: Collection of results in the page - items: - $ref: '#/components/schemas/ChangelogEntryVerboseDto' - description: Paginated collection of results - PageDtoCountrySubdivisionDto: - required: - - content - - contentSize - - page - - totalElements - - totalPages - type: object - properties: - totalElements: - type: integer - description: Total number of all results in all pages - format: int64 - totalPages: - type: integer - description: Total number pages - format: int32 - page: - type: integer - description: Current page number - format: int32 - contentSize: - type: integer - description: Number of results in the page - format: int32 - content: - type: array - description: Collection of results in the page - items: - $ref: '#/components/schemas/CountrySubdivisionDto' - description: Paginated collection of results - PageDtoIdentifierTypeDto: - required: - - content - - contentSize - - page - - totalElements - - totalPages - type: object - properties: - totalElements: - type: integer - description: Total number of all results in all pages - format: int64 - totalPages: - type: integer - description: Total number pages - format: int32 - page: - type: integer - description: Current page number - format: int32 - contentSize: - type: integer - description: Number of results in the page - format: int32 - content: - type: array - description: Collection of results in the page - items: - $ref: '#/components/schemas/IdentifierTypeDto' - description: Paginated collection of results - PageDtoLegalEntityMatchVerboseDto: - required: - - content - - contentSize - - page - - totalElements - - totalPages - type: object - properties: - totalElements: - type: integer - description: Total number of all results in all pages - format: int64 - totalPages: - type: integer - description: Total number pages - format: int32 - page: - type: integer - description: Current page number - format: int32 - contentSize: - type: integer - description: Number of results in the page - format: int32 - content: - type: array - description: Collection of results in the page - items: - $ref: '#/components/schemas/LegalEntityMatchVerboseDto' - description: Paginated collection of results - PageDtoLegalFormDto: - required: - - content - - contentSize - - page - - totalElements - - totalPages - type: object - properties: - totalElements: - type: integer - description: Total number of all results in all pages - format: int64 - totalPages: - type: integer - description: Total number pages - format: int32 - page: - type: integer - description: Current page number - format: int32 - contentSize: - type: integer - description: Number of results in the page - format: int32 - content: - type: array - description: Collection of results in the page - items: - $ref: '#/components/schemas/LegalFormDto' - description: Paginated collection of results - PageDtoLogisticAddressVerboseDto: - required: - - content - - contentSize - - page - - totalElements - - totalPages - type: object - properties: - totalElements: - type: integer - description: Total number of all results in all pages - format: int64 - totalPages: - type: integer - description: Total number pages - format: int32 - page: - type: integer - description: Current page number - format: int32 - contentSize: - type: integer - description: Number of results in the page - format: int32 - content: - type: array - description: Collection of results in the page - items: - $ref: '#/components/schemas/LogisticAddressVerboseDto' - description: Paginated collection of results - PageDtoRegionDto: - required: - - content - - contentSize - - page - - totalElements - - totalPages - type: object - properties: - totalElements: - type: integer - description: Total number of all results in all pages - format: int64 - totalPages: - type: integer - description: Total number pages - format: int32 - page: - type: integer - description: Current page number - format: int32 - contentSize: - type: integer - description: Number of results in the page - format: int32 - content: - type: array - description: Collection of results in the page - items: - $ref: '#/components/schemas/RegionDto' - description: Paginated collection of results - PageDtoSiteMatchVerboseDto: - required: - - content - - contentSize - - page - - totalElements - - totalPages - type: object - properties: - totalElements: - type: integer - description: Total number of all results in all pages - format: int64 - totalPages: - type: integer - description: Total number pages - format: int32 - page: - type: integer - description: Current page number - format: int32 - contentSize: - type: integer - description: Number of results in the page - format: int32 - content: - type: array - description: Collection of results in the page - items: - $ref: '#/components/schemas/SiteMatchVerboseDto' - description: Paginated collection of results - PageDtoSiteVerboseDto: - required: - - content - - contentSize - - page - - totalElements - - totalPages - type: object - properties: - totalElements: - type: integer - description: Total number of all results in all pages - format: int64 - totalPages: - type: integer - description: Total number pages - format: int32 - page: - type: integer - description: Current page number - format: int32 - contentSize: - type: integer - description: Number of results in the page - format: int32 - content: - type: array - description: Collection of results in the page - items: - $ref: '#/components/schemas/SiteVerboseDto' - description: Paginated collection of results - PageDtoSiteWithMainAddressVerboseDto: - required: - - content - - contentSize - - page - - totalElements - - totalPages - type: object - properties: - totalElements: - type: integer - description: Total number of all results in all pages - format: int64 - totalPages: - type: integer - description: Total number pages - format: int32 - page: - type: integer - description: Current page number - format: int32 - contentSize: - type: integer - description: Number of results in the page - format: int32 - content: - type: array - description: Collection of results in the page - items: - $ref: '#/components/schemas/SiteWithMainAddressVerboseDto' - description: Paginated collection of results - PhysicalPostalAddressDto: - required: - - city - - country - type: object - properties: - geographicCoordinates: - $ref: '#/components/schemas/GeoCoordinateDto' - country: - type: string - description: The 2-digit country code of the physical postal address according to ISO 3166-1. - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - administrativeAreaLevel1: - type: string - description: The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country. - administrativeAreaLevel2: - type: string - description: The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country. - administrativeAreaLevel3: - type: string - description: The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country. - postalCode: - type: string - description: The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code. - city: - type: string - description: 'The name of the city of the physical postal address, synonyms: town, village, municipality.' - district: - type: string - description: The name of the district of the physical postal address which divides the city in several smaller areas. - street: - $ref: '#/components/schemas/StreetDto' - companyPostalCode: - type: string - description: The company postal code of the physical postal address, which is sometimes required for large companies. - industrialZone: - type: string - description: 'The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.' - building: - type: string - description: The alphanumeric identifier of the building addressed by the physical postal address. - floor: - type: string - description: 'The number of a floor in the building addressed by the physical postal address, synonym: level.' - door: - type: string - description: 'The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite.' - description: A physical postal address describes the physical location of an office, warehouse, gate, etc. - PhysicalPostalAddressVerboseDto: - required: - - city - - country - type: object - properties: - geographicCoordinates: - $ref: '#/components/schemas/GeoCoordinateDto' - country: - $ref: '#/components/schemas/TypeKeyNameVerboseDtoCountryCode' - administrativeAreaLevel1: - $ref: '#/components/schemas/RegionDto' - administrativeAreaLevel2: - type: string - description: The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country. - administrativeAreaLevel3: - type: string - description: The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country. - postalCode: - type: string - description: The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code. - city: - type: string - description: 'The name of the city of the physical postal address, synonyms: town, village, municipality.' - district: - type: string - description: The name of the district of the physical postal address which divides the city in several smaller areas. - street: - $ref: '#/components/schemas/StreetDto' - companyPostalCode: - type: string - description: The company postal code of the physical postal address, which is sometimes required for large companies. - industrialZone: - type: string - description: 'The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.' - building: - type: string - description: The alphanumeric identifier of the building addressed by the physical postal address. - floor: - type: string - description: 'The number of a floor in the building addressed by the physical postal address, synonym: level.' - door: - type: string - description: 'The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite.' - description: A physical postal address describes the physical location of an office, warehouse, gate, etc. - RegionDto: - required: - - countryCode - - regionCode - - regionName - type: object - properties: - countryCode: - type: string - description: Country code - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - regionCode: - type: string - description: Abbreviation or shorthand of the area - regionName: - type: string - description: Describes the full name of the region within a country according to ISO 3166-214 - description: Region within a country - RelationVerboseDto: - required: - - endBpnl - - startBpnl - - type - type: object - properties: - type: - $ref: '#/components/schemas/TypeKeyNameVerboseDtoRelationType' - startBpnl: - type: string - description: BPN of partner which is the source of the relation - endBpnl: - type: string - description: BPN of partner which is the target of the relation - validFrom: - type: string - description: Time when the relation started - format: date-time - validTo: - type: string - description: Time when the relation ended - format: date-time - description: Directed relation between two business partners - SiteBpnSearchRequest: - required: - - legalEntities - - sites - type: object - properties: - legalEntities: - type: array - description: Filter sites that should belong to legal entities (specified by BPNL) - items: - type: string - description: Filter sites that should belong to legal entities (specified by BPNL) - sites: - type: array - description: Filter sites by BPNS of sites - items: - type: string - description: Filter sites by BPNS of sites - SiteMatchVerboseDto: - required: - - mainAddress - - site - type: object - properties: - mainAddress: - $ref: '#/components/schemas/LogisticAddressVerboseDto' - site: - $ref: '#/components/schemas/SiteVerboseDto' - description: Match for a business partner record of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. - SitePartnerCreateRequest: - required: - - bpnlParent - - confidenceCriteria - - mainAddress - - name - - states - type: object - properties: - name: - type: string - description: The name of the site. This is not according to official registers but according to the name the owner chooses. - states: - type: array - description: The list of the (temporary) states of the site. - items: - $ref: '#/components/schemas/SiteStateDto' - mainAddress: - $ref: '#/components/schemas/LogisticAddressDto' - confidenceCriteria: - $ref: '#/components/schemas/ConfidenceCriteriaDto' - bpnlParent: - type: string - description: The BPNL of the legal entity owning the site. - index: - type: string - description: User defined index to conveniently match this entry to the corresponding entry in the response. - requestKey: - type: string - description: Request for creating new business partner record of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. - SitePartnerCreateResponseWrapper: - required: - - entities - - entityCount - - errorCount - - errors - type: object - properties: - entities: - type: array - items: - $ref: '#/components/schemas/SitePartnerCreateVerboseDto' - errors: - type: array - items: - $ref: '#/components/schemas/ErrorInfoSiteCreateError' - entityCount: - type: integer - format: int32 - errorCount: - type: integer - format: int32 - description: Holds information about successfully and failed entities after the creating/updating of several objects - SitePartnerCreateVerboseDto: - required: - - bpnLegalEntity - - bpns - - confidenceCriteria - - createdAt - - mainAddress - - name - - states - - updatedAt - type: object - properties: - bpns: - type: string - description: A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located. - name: - type: string - description: The name of the site. This is not according to official registers but according to the name the owner chooses. - states: - type: array - description: The list of the (temporary) states of the site. - items: - $ref: '#/components/schemas/SiteStateVerboseDto' - bpnLegalEntity: - type: string - description: The BPNL of the legal entity owning the site. - createdAt: - type: string - description: The date when the data record has been created. - format: date-time - updatedAt: - type: string - description: The date when the data record has been last updated. - format: date-time - confidenceCriteria: - $ref: '#/components/schemas/ConfidenceCriteriaDto' - mainAddress: - $ref: '#/components/schemas/LogisticAddressVerboseDto' - index: - type: string - description: User defined index to conveniently match this entry to the corresponding entry in the response. - description: Created/updated business partner of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. - SitePartnerUpdateRequest: - required: - - bpns - - confidenceCriteria - - mainAddress - - name - - requestKey - - states - type: object - properties: - bpns: - type: string - description: A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located. - name: - type: string - description: The name of the site. This is not according to official registers but according to the name the owner chooses. - states: - type: array - description: The list of the (temporary) states of the site. - items: - $ref: '#/components/schemas/SiteStateDto' - mainAddress: - $ref: '#/components/schemas/LogisticAddressDto' - confidenceCriteria: - $ref: '#/components/schemas/ConfidenceCriteriaDto' - requestKey: - type: string - description: Request for updating a business partner record of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. - SitePartnerUpdateResponseWrapper: - required: - - entities - - entityCount - - errorCount - - errors - type: object - properties: - entities: - type: array - items: - $ref: '#/components/schemas/SitePartnerCreateVerboseDto' - errors: - type: array - items: - $ref: '#/components/schemas/ErrorInfoSiteUpdateError' - entityCount: - type: integer - format: int32 - errorCount: - type: integer - format: int32 - description: Holds information about successfully and failed entities after the creating/updating of several objects - SiteStateDto: - required: - - type - type: object - properties: - validFrom: - type: string - description: The date from which the state is valid. - format: date-time - validTo: - type: string - description: The date until the state is valid. - format: date-time - type: - type: string - description: 'One of the state types: active, inactive.' - enum: - - ACTIVE - - INACTIVE - description: A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating. - SiteStateVerboseDto: - required: - - type - type: object - properties: - validFrom: - type: string - description: The date from which the state is valid. - format: date-time - validTo: - type: string - description: The date until the state is valid. - format: date-time - type: - $ref: '#/components/schemas/TypeKeyNameVerboseDtoBusinessStateType' - description: A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating. - SiteVerboseDto: - required: - - bpnLegalEntity - - bpns - - confidenceCriteria - - createdAt - - name - - states - - updatedAt - type: object - properties: - bpns: - type: string - description: A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located. - name: - type: string - description: The name of the site. This is not according to official registers but according to the name the owner chooses. - states: - type: array - description: The list of the (temporary) states of the site. - items: - $ref: '#/components/schemas/SiteStateVerboseDto' - bpnLegalEntity: - type: string - description: The BPNL of the legal entity owning the site. - createdAt: - type: string - description: The date when the data record has been created. - format: date-time - updatedAt: - type: string - description: The date when the data record has been last updated. - format: date-time - confidenceCriteria: - $ref: '#/components/schemas/ConfidenceCriteriaDto' - description: In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. - SiteWithMainAddressVerboseDto: - required: - - bpnLegalEntity - - bpns - - confidenceCriteria - - createdAt - - mainAddress - - name - - states - - updatedAt - type: object - properties: - bpns: - type: string - description: A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located. - name: - type: string - description: The name of the site. This is not according to official registers but according to the name the owner chooses. - states: - type: array - description: The list of the (temporary) states of the site. - items: - $ref: '#/components/schemas/SiteStateVerboseDto' - bpnLegalEntity: - type: string - description: The BPNL of the legal entity owning the site. - createdAt: - type: string - description: The date when the data record has been created. - format: date-time - updatedAt: - type: string - description: The date when the data record has been last updated. - format: date-time - confidenceCriteria: - $ref: '#/components/schemas/ConfidenceCriteriaDto' - mainAddress: - $ref: '#/components/schemas/LogisticAddressVerboseDto' - description: In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. - StreetDto: - type: object - properties: - name: - type: string - description: The name of the street. - houseNumber: - type: string - description: The number representing the exact location of a building within the street. - houseNumberSupplement: - type: string - milestone: - type: string - description: The number representing the exact location of an addressed object within a street without house numbers, such as within long roads. - direction: - type: string - description: The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South. - namePrefix: - type: string - description: The street related information, which is usually printed before the official street name on an address label. - additionalNamePrefix: - type: string - description: The additional street related information, which is usually printed before the official street name on an address label. - nameSuffix: - type: string - description: The street related information, which is usually printed after the official street name on an address label. - additionalNameSuffix: - type: string - description: The additional street related information, which is usually printed after the official street name on an address label. - description: 'The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway' - TypeKeyNameVerboseDtoBusinessStateType: - required: - - name - - technicalKey - type: object - properties: - technicalKey: - type: string - description: Unique key of this type for reference - enum: - - ACTIVE - - INACTIVE - name: - type: string - description: Name or denotation of this type - description: Named type uniquely identified by its technical key - TypeKeyNameVerboseDtoClassificationType: - required: - - name - - technicalKey - type: object - properties: - technicalKey: - type: string - description: Unique key of this type for reference - enum: - - NACE - - NAF - - NAICS - - SIC - name: - type: string - description: Name or denotation of this type - description: Named type uniquely identified by its technical key - TypeKeyNameVerboseDtoCountryCode: - required: - - name - - technicalKey - type: object - properties: - technicalKey: - type: string - description: Unique key of this type for reference - enum: - - UNDEFINED - - AC - - AD - - AE - - AF - - AG - - AI - - AL - - AM - - AN - - AO - - AQ - - AR - - AS - - AT - - AU - - AW - - AX - - AZ - - BA - - BB - - BD - - BE - - BF - - BG - - BH - - BI - - BJ - - BL - - BM - - BN - - BO - - BQ - - BR - - BS - - BT - - BU - - BV - - BW - - BY - - BZ - - CA - - CC - - CD - - CF - - CG - - CH - - CI - - CK - - CL - - CM - - CN - - CO - - CP - - CR - - CS - - CU - - CV - - CW - - CX - - CY - - CZ - - DE - - DG - - DJ - - DK - - DM - - DO - - DZ - - EA - - EC - - EE - - EG - - EH - - ER - - ES - - ET - - EU - - EZ - - FI - - FJ - - FK - - FM - - FO - - FR - - FX - - GA - - GB - - GD - - GE - - GF - - GG - - GH - - GI - - GL - - GM - - GN - - GP - - GQ - - GR - - GS - - GT - - GU - - GW - - GY - - HK - - HM - - HN - - HR - - HT - - HU - - IC - - ID - - IE - - IL - - IM - - IN - - IO - - IQ - - IR - - IS - - IT - - JE - - JM - - JO - - JP - - KE - - KG - - KH - - KI - - KM - - KN - - KP - - KR - - KW - - KY - - KZ - - LA - - LB - - LC - - LI - - LK - - LR - - LS - - LT - - LU - - LV - - LY - - MA - - MC - - MD - - ME - - MF - - MG - - MH - - MK - - ML - - MM - - MN - - MO - - MP - - MQ - - MR - - MS - - MT - - MU - - MV - - MW - - MX - - MY - - MZ - - NA - - NC - - NE - - NF - - NG - - NI - - NL - - 'NO' - - NP - - NR - - NT - - NU - - NZ - - OM - - PA - - PE - - PF - - PG - - PH - - PK - - PL - - PM - - PN - - PR - - PS - - PT - - PW - - PY - - QA - - RE - - RO - - RS - - RU - - RW - - SA - - SB - - SC - - SD - - SE - - SF - - SG - - SH - - SI - - SJ - - SK - - SL - - SM - - SN - - SO - - SR - - SS - - ST - - SU - - SV - - SX - - SY - - SZ - - TA - - TC - - TD - - TF - - TG - - TH - - TJ - - TK - - TL - - TM - - TN - - TO - - TP - - TR - - TT - - TV - - TW - - TZ - - UA - - UG - - UK - - UM - - US - - UY - - UZ - - VA - - VC - - VE - - VG - - VI - - VN - - VU - - WF - - WS - - XI - - XU - - XK - - YE - - YT - - YU - - ZA - - ZM - - ZR - - ZW - name: - type: string - description: Name or denotation of this type - description: Named type uniquely identified by its technical key - TypeKeyNameVerboseDtoRelationType: - required: - - name - - technicalKey - type: object - properties: - technicalKey: - type: string - description: Unique key of this type for reference - enum: - - CX_LEGAL_SUCCESSOR_OF - - CX_LEGAL_PREDECESSOR_OF - name: - type: string - description: Name or denotation of this type - description: Named type uniquely identified by its technical key - TypeKeyNameVerboseDtoString: - required: - - name - - technicalKey - type: object - properties: - technicalKey: - type: string - description: Unique key of this type for reference - name: - type: string - description: Name or denotation of this type - description: Named type uniquely identified by its technical key diff --git a/openApi/dt/bpn-discovery-service-openapi.yaml b/openApi/dt/bpn-discovery-service-openapi.yaml deleted file mode 100644 index 8271c206ef5..00000000000 --- a/openApi/dt/bpn-discovery-service-openapi.yaml +++ /dev/null @@ -1,360 +0,0 @@ -############################################################### -# Copyright (c) 2021-2022 Robert Bosch Manufacturing Solutions GmbH -# Copyright (c) 2021-2022 Contributors to the Eclipse Foundation -# -# See the NOTICE file(s) distributed with this work for additional -# information regarding copyright ownership. -# -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 -############################################################### - -openapi: 3.0.3 -info: - title: BPN Discovery Service - description: BPN Discovery Service to find BPN based on a local identifier. - contact: - name: SLDT Team - version: 0.0.1 - -security: - - CatenaXOpenId: - - profile - -paths: - /api/administration/connectors/bpnDiscovery: - post: - tags: - - Discovery - summary: Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry. - operationId: PostBpnDiscovery - requestBody: - description: the request body is expecting a key (type, e.g. OEN, batteryID, etc.) - value (explicit number) pair, where this service will respond with success/error message on persistance of this key-value-pair. The BPN is hand-over by the authentication/authorization (→ token). Only the owner of a BPN can link any number (e.g. OEN, batteryID, etc.) to his BPN. - content: - application/json: - schema: - $ref: '#/components/schemas/IdentifierTypeKeyPair' - examples: - complete: - $ref: '#/components/examples/identifier-type-key-pair' - required: true - responses: - "201": - description: key value for BPN created successfully - content: - application/json: - schema: - $ref: '#/components/schemas/Bpn' - examples: - complete: - $ref: '#/components/examples/bpn-result' - /api/administration/connectors/bpnDiscovery/batch: - post: - tags: - - Discovery - summary: Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as batch. - operationId: PostBatchBpnDiscovery - requestBody: - description: The request body is expecting a list of key (type, e.g. OEN, batteryID, etc.) - value (explicit number) pairs, where this service will respond with success/error message on persistance of this key-value-pairs. The BPN is hand-over by the authentication/authorization (→ token). Only the owner of a BPN can link any number (e.g. OEN, batteryID, etc.) to his BPN. - content: - application/json: - schema: - type: array - maxItems: 10000 - items: - $ref: '#/components/schemas/IdentifierTypeKeyPair' - examples: - complete: - $ref: '#/components/examples/identifier-type-key-pair-batch' - required: true - responses: - "201": - description: key value for BPN in batch created successfully - content: - application/json: - schema: - type: array - maxItems: 10000 - items: - $ref: '#/components/schemas/TypeKeyPairBatchResult' - examples: - complete: - $ref: '#/components/examples/identifier-type-key-pair-batch-result' - /api/administration/connectors/bpnDiscovery/search: - post: - tags: - - Discovery - summary: Find BPN endpoints corresponding to numbers (e.g. OEN, batteryID, etc.) - operationId: GetBpnDiscoveries - requestBody: - description: the request body is expecting a list of key (type, e.g. OEN, batteryID, etc.) - value (explicit number) pairs, where this service will respond with the corresponding BPN. Please add minimum one key-value pair. - content: - application/json: - schema: - $ref: '#/components/schemas/SearchRequest' - examples: - complete: - $ref: '#/components/examples/search-filter' - required: true - responses: - "200": - description: key value for BPN created successfully - content: - application/json: - schema: - $ref: '#/components/schemas/BpnCollection' - examples: - complete: - $ref: '#/components/examples/search-filter-result' - - /api/administration/connectors/bpnDiscovery/{resourceId}: - delete: - tags: - - Discovery - summary: Delete numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry. - operationId: DeleteBpnDiscoveryById - parameters: - - name: resourceId - in: path - description: The IdentifierKeyValue unique id (BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - responses: - "204": - description: BPN Identifier Key-Value deleted successfully -components: - schemas: - IdentifierTypeKeyPair: - title: IdentifierTypeKeyPair - required: - - type - - key - properties: - type: - type: string - minLength: 1 - maxLength: 200 - key: - type: string - minLength: 1 - maxLength: 200 - SearchRequest: - title: SearchRequest - properties: - searchFilter: - title: searchFilter - type: array - maxItems: 10000 - items: - $ref: '#/components/schemas/SearchIdentifierTypeKeyPair' - SearchIdentifierTypeKeyPair: - title: SearchIdentifierTypeKeyPair - properties: - type: - type: string - minLength: 1 - maxLength: 200 - keys: - type: array - maxItems: 10000 - items: - type: string - BpnCollection: - title: BpnCollection - properties: - bpns: - title: bpns - type: array - items: - $ref: '#/components/schemas/Bpn' - Bpn: - title: Bpn - required: - - type - - key - - value - - resourceId - properties: - type: - type: string - key: - type: string - value: - type: string - resourceId: - type: string - TypeKeyPairResult: - type: object - required: - - message - - key - properties: - message: - type: string - description: The detailed message for the creation. - key: - type: string - description: The created key. - TypeKeyPairBatchResult: - type: object - required: - - message - - key - - status - properties: - message: - type: string - description: The detailed message for the creation. - details: - type: object - additionalProperties: - type: object - description: An object with key/value pairs containing additional information exception. - key: - type: string - description: The created key. - status: - type: integer - description: The status code - ErrorResponse: - type: object - required: - - error - properties: - error: - $ref: '#/components/schemas/Error' - Error: - type: object - required: - - details - properties: - message: - type: string - example: size must be between {min} and {max} - description: The detailed error message for the exception which occurred. - minLength: 1 - path: - type: string - description: The requested path. - minLength: 1 - details: - type: object - additionalProperties: - type: object - description: An object with key/value pairs containing additional information about the error - securitySchemes: - CatenaXOpenId: - type: openIdConnect - openIdConnectUrl: ../.well-known/openid-configuration - - examples: - identifier-type-key-pair: - value: - { - "type": "oen", - "key": "oen-123" - } - bpn-result: - value: - { - "type": "oen", - "key": "oen-1243", - "value": "bpn-123", - "resourceId": "1ca6f9b5-8e1d-422a-8541-9bb2cf5fe485" - } - identifier-type-key-pair-batch: - value: - [ - { - "type": "oenId", - "key": "oenId-123" - }, - { - "type": "oen", - "key": "oen-4444" - }, - { - "type": "bpid", - "key": "bpid-123" - } - ] - identifier-type-key-pair-batch-result: - value: - [ - { - "message": "Validation failed.", - "details": { - "type": "type oenId is not allowed." - }, - "key": "oenId-123", - "status": 400 - }, - { - "message": "BpnDiscovery successfully created", - "details": null, - "key": "oen-4444", - "status": 200 - }, - { - "message": "BpnDiscovery successfully created", - "details": null, - "key": "bpid-123", - "status": 200 - } - ] - search-filter: - value: - { - "searchFilter": [ - { - "type": "oen", - "keys": [ "oen-1243","oen-11" ] - }, - { - "type": "bpid", - "keys": [ "bpid-1243","bpid-11" ] - } - ] - } - search-filter-result: - value: - { - "bpns": [ - { - "type": "oen", - "key": "oen-1243", - "value": "bpn-123", - "resourceId": "1ca6f9b5-8e1d-422a-8541-9bb2cf5fe485" - }, - { - "type": "oen", - "key": "oen-11", - "value": "bpn-123", - "resourceId": "972262d7-7e05-4578-936f-de236d7feb94" - }, - { - "type": "bpid", - "key": "bpid-1243", - "value": "bpn-444", - "resourceId": "1b754aeb-c753-4adf-ae6d-52842f5a38b7" - }, - { - "type": "bpid", - "key": "oen-11", - "value": "bpn-444", - "resourceId": "e43f9cf8-f0d4-4c51-b7fe-b68ea4aeea7c" - } - ] - } \ No newline at end of file diff --git a/openApi/dt/discovery-finder-openapi.yaml b/openApi/dt/discovery-finder-openapi.yaml deleted file mode 100644 index c392d4d5d26..00000000000 --- a/openApi/dt/discovery-finder-openapi.yaml +++ /dev/null @@ -1,264 +0,0 @@ -############################################################### -# Copyright (c) 2021 Robert Bosch Manufacturing Solutions GmbH -# Copyright (c) 2021 Contributors to the Eclipse Foundation -# -# See the NOTICE file(s) distributed with this work for additional -# information regarding copyright ownership. -# -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 -############################################################### - -openapi: 3.0.3 -info: - title: Discovery Finder - description: Discovery Finder to find endpoint of the BPN/EDC Discovery. - contact: - name: SLDT Team - version: 0.0.1 - -security: - - CatenaXOpenId: - - profile -servers: - - url: "{protocol}://{host_name}:{port}/api/{version_prefix}" - variables: - protocol: - description: Allows access through http and https (recommended) - default: http - enum: - - http - - https - host_name: - description: Hostname of server hosting the api - default: localhost - port: - description: "80 is default for http, 443 for https" - default: "443" - enum: - - "80" - - "443" - - "4243" - version_prefix: - default: v1.0 - enum: - - v1.0 -paths: - /administration/connectors/discovery: - post: - tags: - - Finder - summary: Define the endpoint to BPN discovery services and the EDC discovery service. - operationId: PostDiscoveryEndpoint - requestBody: - description: Create new endpoint for bpn discovery service / edc discovery service. The type is uniqued. This service is allowed to administrators only - content: - application/json: - schema: - $ref: '#/components/schemas/DiscoveryEndpoint' - examples: - complete: - $ref: '#/components/examples/discovery-endpoint' - required: true - responses: - "201": - description: Discovery Endpoint created successfully - content: - application/json: - schema: - $ref: '#/components/schemas/DiscoveryEndpoint' - examples: - complete: - $ref: '#/components/examples/discovery-endpoint-result' - /administration/connectors/discovery/search: - post: - tags: - - Finder - summary: Find the endpoints to BPN discovery services and the EDC discovery service. - operationId: GetDiscoveryEndpoints - requestBody: - description: The request body is expecting a list of types ( e.g. oen, bpid, etc.) to return available discovery endpoints. - content: - application/json: - schema: - $ref: '#/components/schemas/SearchRequest' - examples: - complete: - $ref: '#/components/examples/discovey-endpoint-search' - required: true - responses: - "200": - description: Returns discovery endpoints based on search filter. - content: - application/json: - schema: - $ref: '#/components/schemas/DiscoveryEndpointCollection' - examples: - complete: - $ref: '#/components/examples/discovery-endpoint-search-result' - /administration/connectors/discovery/{resourceId}: - delete: - tags: - - Finder - summary: Delete the endpoint to BPN discovery services and the EDC discovery service. - operationId: DeleteDiscoveryEndpointByResourceId - parameters: - - name: resourceId - in: path - description: The IdentifierKeyValue unique id (BASE64-URL-encoded) - required: true - style: simple - explode: false - schema: - type: string - responses: - "204": - description: Discovery Endpoint deleted successfully -components: - schemas: - DiscoveryEndpoint: - title: DiscoveryEndpoint - type: object - required: - - type - - description - - endpointAddress - - timeToLive - properties: - type: - type: string - minLength: 1 - maxLength: 200 - description: - type: string - minLength: 1 - maxLength: 500 - endpointAddress: - type: string - minLength: 1 - maxLength: 300 - documentation: - type: string - minLength: 1 - maxLength: 500 - resourceId: - type: string - timeToLive: - type: integer - minimum: 1 - maximum: 31536000 - SearchRequest: - title: SearchRequest - required: - - types - properties: - types: - title: types - type: array - maxItems: 10000 - items: - type: string - DiscoveryEndpointCollection: - title: DiscoveryEndpointCollection - properties: - endpoints: - title: endpoints - type: array - maxItems: 10000 - items: - $ref: '#/components/schemas/DiscoveryEndpoint' - type: object - ErrorResponse: - type: object - required: - - error - properties: - error: - $ref: '#/components/schemas/Error' - Error: - type: object - required: - - details - properties: - message: - type: string - example: size must be between {min} and {max} - description: The detailed error message for the exception which occurred. - minLength: 1 - path: - type: string - description: The requested path. - minLength: 1 - details: - type: object - additionalProperties: - type: object - description: An object with key/value pairs containing additional information about the error - securitySchemes: - CatenaXOpenId: - type: openIdConnect - openIdConnectUrl: ../.well-known/openid-configuration - examples: - discovery-endpoint: - value: - { - "type": "oen", - "description": "Service to discover BPN to a particular OEN", - "endpointAddress": "http://...", - "documentation": "http://.../swagger/index.html", - "timeToLive": 31536000 - } - discovery-endpoint-result: - value: - { - "type": "oen", - "description": "Service to discover BPN to a particular OEN", - "endpointAddress": "http://...", - "documentation": "http://.../swagger/index.html", - "resourceId": "ec6f407b-4296-418c-9e4e-fb739fe72a67", - "timeToLive": 31536000 - } - discovey-endpoint-search: - value: - { - "types": [ "oen", "bpid", "bpn" ] - } - discovery-endpoint-search-result: - value: - { - "endpoints": [ - { - "type": "oen", - "description": "Service to discover BPN to a particular OEN", - "endpointAddress": "http://...", - "documentation": "http://.../swagger/index.html", - "resourceId": "ec6f407b-4296-418c-9e4e-fb739fe72a67", - "timeToLive": 31536000 - }, - { - "type": "bpid", - "description": "Service to discover BPN to a particular Battery Pass ID", - "endpointAddress": "http://...", - "documentation": "http://.../swagger/index.html", - "resourceId": "08702529-3714-4c4f-b022-346b9b4fbbe2", - "timeToLive": 31536000 - }, - { - "type": "bpn", - "description": "Service to discover EDC to a particular BPN", - "endpointAddress": "http://...", - "documentation": "http://.../swagger/index.html", - "resourceId": "316417cd-0fb5-4daf-8dfa-8f68125923f1", - "timeToLive": 31536000 - } - ] - } \ No newline at end of file diff --git a/openApi/irs/irs-api.yaml b/openApi/irs/irs-api.yaml deleted file mode 100644 index 64c898d0aa9..00000000000 --- a/openApi/irs/irs-api.yaml +++ /dev/null @@ -1,2657 +0,0 @@ -openapi: 3.0.1 -info: - description: The API of the Item Relationship Service (IRS) for retrieving item - graphs along the value chain of CATENA-X partners. - title: IRS API - version: "2.1.0" -servers: - - url: http://localhost:8080 -security: - - oAuth2: [] -paths: - /ess/bpn/investigations: - post: - description: Registers an IRS job to start an investigation if a given bpn is - contained in a part chain of a given globalAssetId. - operationId: registerBPNInvestigation - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterBpnInvestigationJob' - required: true - responses: - "201": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/job-handle' - schema: - $ref: '#/components/schemas/JobHandle' - description: Returns id of registered job. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Job registration failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - security: - - oAuth2: [] - summary: Registers an IRS job to start an investigation if a given bpn is contained - in a part chain of a given globalAssetId. - tags: - - Environmental and Social Standards - /ess/bpn/investigations/{id}: - get: - description: Return job with additional supplyChainImpacted information. - operationId: getBPNInvestigation - parameters: - - description: Id of the job. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: id - required: true - schema: - type: string - format: uuid - responses: - "200": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/complete-ess-job-result' - schema: - $ref: '#/components/schemas/Jobs' - description: Return job with item graph for the requested id. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Return job failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - "404": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-404' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Job with the requested jobId not found. - security: - - oAuth2: [] - summary: Return job with additional supplyChainImpacted information. - tags: - - Environmental and Social Standards - /ess/notification/receive: - post: - description: Accepts notifications via EDC. Notifications are filtered by their - type and processed accordingly. - operationId: receiveEdcNotification - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/EdcNotificationResponseNotificationContent' - required: true - responses: - "200": - description: Notification received successfully. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Notification malformed. - summary: Accepts notifications sent via EDC. - tags: - - Environmental and Social Standards - /irs/ess/orders: - post: - description: "Registers an order for an ESS investigation with an array of - {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches." - operationId: registerESSInvestigationOrder - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterBpnInvestigationBatchOrder' - required: true - responses: - "201": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/job-handle' - schema: - $ref: '#/components/schemas/BatchOrderCreated' - description: Returns orderId of registered Batch order. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Batch Order registration failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - security: - - oAuth2: [] - summary: "Registers an order for an ESS investigation with an array of {globalAssetIds}. - Each globalAssetId will be processed in an separate job, grouped in batches." - tags: - - Environmental and Social Standards - /irs/jobs: - get: - description: Returns paginated jobs with state and execution times. - operationId: getJobsByJobStates - parameters: - - description: Requested job states. - explode: false - in: query - name: states - required: false - schema: - type: array - items: - type: string - enum: - - UNSAVED - - INITIAL - - RUNNING - - TRANSFERS_FINISHED - - COMPLETED - - CANCELED - - ERROR - maxItems: 2147483647 - - description: Zero-based page index (0..N) - in: query - name: page - required: false - schema: - type: integer - default: 0 - - description: The size of the page to be returned - in: query - name: size - required: false - schema: - type: integer - default: 20 - - description: "Sorting criteria in the format: property,(asc|desc). Default\ - \ sort order is ascending. Multiple sort criteria are supported." - in: query - name: sort - required: false - schema: - type: array - items: - type: string - responses: - "200": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/complete-job-list-processing-state' - schema: - $ref: '#/components/schemas/PageResult' - description: Paginated list of jobs with state and execution times for requested - job states. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Return jobs for requested job states failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - security: - - oAuth2: [] - summary: Returns paginated jobs with state and execution times. - tags: - - Item Relationship Service - post: - description: "Register an IRS job to retrieve an item graph for given {globalAssetId}." - operationId: registerJobForGlobalAssetId - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterJob' - required: true - responses: - "201": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/job-handle' - schema: - $ref: '#/components/schemas/JobHandle' - description: Returns id of registered job. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Job registration failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - security: - - oAuth2: [] - summary: "Register an IRS job to retrieve an item graph for given {globalAssetId}." - tags: - - Item Relationship Service - /irs/jobs/{id}: - get: - description: Return job with optional item graph result for requested id. - operationId: getJobForJobId - parameters: - - description: Id of the job. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: id - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 - - description: "\\ Return job with current processed item graph. \\ - Return job with item graph if job is in state COMPLETED, otherwise job." - in: query - name: returnUncompletedJob - required: false - schema: - type: boolean - default: true - responses: - "200": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/complete-job-result' - schema: - $ref: '#/components/schemas/Jobs' - description: Return job with item graph for the requested id. - "206": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/partial-job-result' - schema: - $ref: '#/components/schemas/Jobs' - description: Return job with current processed item graph for the requested - id. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Return job failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - "404": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-404' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Job with the requested jobId not found. - security: - - oAuth2: [] - summary: Return job with optional item graph result for requested id. - tags: - - Item Relationship Service - put: - description: Cancel job for requested jobId. - operationId: cancelJobByJobId - parameters: - - description: Id of the job. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: id - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 - responses: - "200": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/canceled-job-response' - schema: - $ref: '#/components/schemas/Job' - description: Job with requested jobId canceled. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Cancel job failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - "404": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-404' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Job for requested jobId not found. - security: - - oAuth2: [] - summary: Cancel job for requested jobId. - tags: - - Item Relationship Service - /irs/aspectmodels: - get: - description: Get all available aspect models from semantic hub or local models. - operationId: getAllAspectModels - responses: - "200": - content: - application/json: - examples: - complete: - $ref: "#/components/examples/aspect-models-list" - schema: - $ref: "#/components/schemas/AspectModels" - description: Returns all available aspect models. - "401": - content: - application/json: - examples: - error: - $ref: "#/components/examples/error-response-401" - schema: - $ref: "#/components/schemas/ErrorResponse" - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: "#/components/examples/error-response-403" - schema: - $ref: "#/components/schemas/ErrorResponse" - description: Authorization refused by server. - security: - - oAuth2: [] - summary: Get all available aspect models from semantic hub or local models. - tags: - - Aspect Models - /irs/orders: - post: - description: "Registers an IRS order with an array of {globalAssetIds}.\ - \ Each globalAssetId will be processed in an IRS Job, grouped in batches." - operationId: registerOrder - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterBatchOrder' - required: true - responses: - "201": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/job-handle' - schema: - $ref: '#/components/schemas/BatchOrderCreated' - description: Returns orderId of registered Batch order. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Batch Order registration failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - security: - - oAuth2: [] - summary: "Registers an IRS order with an array of {globalAssetIds}.\ - \ Each globalAssetId will be processed in an IRS Job, grouped in batches." - tags: - - Item Relationship Service - /irs/orders/{orderId}: - get: - description: Get a batch order for a given orderId. - operationId: getBatchOrder - parameters: - - description: Id of the order. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: orderId - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 - responses: - "200": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/complete-order-result' - schema: - $ref: '#/components/schemas/BatchOrderResponse' - description: Get a batch order for a given orderId. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Return Batch Order failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - "404": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-404' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Batch Order with the requested orderId not found. - security: - - oAuth2: [] - summary: Get a batch order for a given orderId. - tags: - - Item Relationship Service - put: - description: Cancel a batch order for a given orderId. - operationId: cancelBatchOrder - parameters: - - description: Id of the order. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: orderId - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 - responses: - "200": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/complete-order-result' - schema: - $ref: '#/components/schemas/BatchOrderResponse' - description: Cancel a batch order for a given orderId. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Return Batch Order failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - "404": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-404' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Batch Order with the requested orderId not found. - security: - - oAuth2: [] - summary: Cancel a batch order for a given orderId. - tags: - - Item Relationship Service - /irs/orders/{orderId}/batches/{batchId}: - get: - description: Get a batch with a given batchId for a given orderId. - operationId: getBatch - parameters: - - description: Id of the order. - example: 6c311d29-5753-46d4-b32c-19b918ea93b0 - in: path - name: orderId - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 - - description: Id of the batch. - example: 4bce40b8-64c7-41bf-9ca3-e9432c7fef98 - in: path - name: batchId - required: true - schema: - type: string - format: uuid - maxLength: 36 - minLength: 36 - responses: - "200": - content: - application/json: - examples: - complete: - $ref: '#/components/examples/complete-batch-result' - schema: - $ref: '#/components/schemas/BatchResponse' - description: Get a batch with a given batchId for a given orderId. - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Return batch failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - "404": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-404' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Batch with the requested orderId and batchId not found. - security: - - oAuth2: [] - summary: Get a batch with a given batchId for a given orderId. - tags: - - Item Relationship Service - /irs/policies: - get: - description: Lists the registered policies that should be accepted in EDC negotiation. - operationId: getAllowedPolicies - responses: - "200": - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/Policy' - description: Returns the policies. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - security: - - oAuth2: [] - summary: Lists the registered policies that should be accepted in EDC negotiation. - tags: - - Item Relationship Service - post: - description: Register a policy that should be accepted in EDC negotiation. - operationId: registerAllowedPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreatePolicyRequest' - required: true - responses: - "201": - description: Created - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Policy registration failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - security: - - oAuth2: [] - summary: Register a policy that should be accepted in EDC negotiation. - tags: - - Item Relationship Service - /irs/policies/{policyId}: - delete: - description: Removes a policy that should no longer be accepted in EDC negotiation. - operationId: deleteAllowedPolicy - parameters: - - in: path - name: policyId - required: true - schema: - type: string - responses: - "200": - description: OK - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Policy deletion failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - security: - - oAuth2: [] - summary: Removes a policy that should no longer be accepted in EDC negotiation. - tags: - - Item Relationship Service - put: - description: Updates an existing policy with new validUntil value. - operationId: updateAllowedPolicy - parameters: - - in: path - name: policyId - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdatePolicyRequest' - required: true - responses: - "200": - description: OK - "400": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-400' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Policy update failed. - "401": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-401' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: No valid authentication credentials. - "403": - content: - application/json: - examples: - error: - $ref: '#/components/examples/error-response-403' - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Authorization refused by server. - security: - - oAuth2: [] - summary: Updates an existing policy with new validUntil value. - tags: - - Item Relationship Service -components: - examples: - canceled-job-response: - value: - completedOn: 2022-02-03T14:48:54.709Z - globalAssetId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - id: 6c311d29-5753-46d4-b32c-19b918ea93b0 - lastModifiedOn: 2022-02-03T14:48:54.709Z - startedOn: 2022-02-03T14:48:54.709Z - state: CANCELED - canceled-job-result: - value: - bpns: [] - job: - completedOn: 2022-02-03T14:48:54.709Z - createdOn: 2022-02-03T14:48:54.709Z - exception: - errorDetail: Timeout while requesting Digital Registry - exception: IrsTimeoutException - exceptionDate: 2022-02-03T14:48:54.709Z - globalAssetId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - id: e5347c88-a921-11ec-b909-0242ac120002 - lastModifiedOn: 2022-02-03T14:48:54.709Z - owner: "" - parameter: - aspects: - - SerialPart - - AddressAspect - bomLifecycle: asBuilt - collectAspects: false - depth: 1 - direction: downward - lookupBPNs: false - startedOn: 2022-02-03T14:48:54.709Z - state: CANCELED - summary: - asyncFetchedItems: - completed: 0 - failed: 0 - running: 0 - relationships: [] - submodels: [] - tombstones: [] - complete-batch-result: - value: - batchId: f253718e-a270-4367-901b-9d50d9bd8462 - batchNumber: 1 - batchProcessingState: COMPLETED - batchTotal: 1 - completedOn: 2022-02-03T14:48:54.709Z - jobs: - - completedOn: 2022-02-03T14:48:54.709Z - id: 6c311d29-5753-46d4-b32c-19b918ea93b0 - startedOn: 2022-02-03T14:48:54.709Z - state: COMPLETED - jobsInBatchChecksum: 1 - orderId: f253718e-a270-4367-901b-9d50d9bd8462 - startedOn: 2022-02-03T14:48:54.709Z - totalJobs: 1 - complete-ess-job-result: - value: - bpns: - - manufacturerId: BPNL00000003AAXX - manufacturerName: AB CD - job: - completedOn: 2022-02-03T14:48:54.709Z - createdOn: 2022-02-03T14:48:54.709Z - exception: - errorDetail: Timeout while requesting Digital Registry - exception: IrsTimeoutException - exceptionDate: 2022-02-03T14:48:54.709Z - globalAssetId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - id: e5347c88-a921-11ec-b909-0242ac120002 - lastModifiedOn: 2022-02-03T14:48:54.709Z - owner: "" - parameter: - aspects: - - SerialPart - - AddressAspect - bomLifecycle: asBuilt - collectAspects: false - depth: 1 - direction: downward - lookupBPNs: false - startedOn: 2022-02-03T14:48:54.709Z - state: COMPLETED - summary: - asyncFetchedItems: - completed: 3 - failed: 0 - running: 0 - bpnLookups: - completed: 3 - failed: 0 - relationships: - - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - linkedItem: - assembledOn: 2022-02-03T14:48:54.709Z - childCatenaXId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 - hasAlternatives: false - lastModifiedOn: 2022-02-03T14:48:54.709Z - lifecycleContext: asBuilt - quantity: - measurementUnit: - datatypeURI: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece - lexicalValue: piece - quantityNumber: 1.0 - shells: - - description: - - language: en - text: The shell for a vehicle - globalAssetId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 - id: urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8 - idShort: future concept x - specificAssetIds: - - name: engineserialid - value: "12309481209312" - submodelDescriptors: - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - endpointProtocol: HTTPS - endpointProtocolVersion: - - "1.0" - href: https://catena-x.net/vehicle/basedetails/ - subprotocol: DSP - subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net - subprotocolBodyEncoding: plain - id: urn:uuid:5d25a897-6571-4800-b98c-a3352fbf996d - idShort: SingleLevelBomAsPlanned - semanticId: - keys: - - type: ExternalReference - value: urn:bamm:io.catenax.single_level_bom_as_planned:2.0.0#SingleLevelBomAsPlanned - type: ModelReference - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - endpointProtocol: HTTPS - endpointProtocolVersion: - - "1.0" - href: https://catena-x.net/vehicle/partdetails/ - subprotocol: DSP - subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net - subprotocolBodyEncoding: plain - id: urn:uuid:dae4d249-6d66-4818-b576-bf52f3b9ae90 - idShort: vehicle part details - semanticId: - keys: - - type: Submodel - value: urn:bamm:com.catenax.vehicle:0.1.1#PartDetails - type: ModelReference - submodels: - - aspectType: supply_chain_impacted - identification: urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff - payload: - supplyChainImpacted: "YES" - tombstones: - - catenaXId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - endpointURL: https://catena-x.net/vehicle/partdetails/ - processingError: - errorDetail: Details to reason of failure - lastAttempt: 2022-02-03T14:48:54.709Z - processStep: SchemaValidation - retryCounter: 0 - complete-job-list-processing-state: - value: - content: - - completedOn: 2022-02-03T14:48:54.709Z - id: 6c311d29-5753-46d4-b32c-19b918ea93b0 - startedOn: 2022-02-03T14:48:54.709Z - state: COMPLETED - pageCount: 1 - pageNumber: 0 - pageSize: 10 - totalElements: 1 - complete-job-result: - value: - bpns: - - manufacturerId: BPNL00000003AYRE - manufacturerName: OEM A - job: - completedOn: 2022-02-03T14:48:54.709Z - createdOn: 2022-02-03T14:48:54.709Z - exception: - errorDetail: Timeout while requesting Digital Registry - exception: IrsTimeoutException - exceptionDate: 2022-02-03T14:48:54.709Z - globalAssetId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - id: e5347c88-a921-11ec-b909-0242ac120002 - lastModifiedOn: 2022-02-03T14:48:54.709Z - owner: "" - parameter: - aspects: - - SerialPart - - AddressAspect - bomLifecycle: asBuilt - collectAspects: false - depth: 1 - direction: downward - lookupBPNs: false - startedOn: 2022-02-03T14:48:54.709Z - state: COMPLETED - summary: - asyncFetchedItems: - completed: 0 - failed: 0 - running: 0 - relationships: - - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - linkedItem: - assembledOn: 2022-02-03T14:48:54.709Z - childCatenaXId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 - hasAlternatives: false - lastModifiedOn: 2022-02-03T14:48:54.709Z - lifecycleContext: asBuilt - quantity: - measurementUnit: - datatypeURI: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece - lexicalValue: piece - quantityNumber: 1.0 - shells: - - description: - - language: en - text: The shell for a vehicle - globalAssetId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 - id: urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8 - idShort: future concept x - specificAssetIds: - - name: engineserialid - value: "12309481209312" - submodelDescriptors: - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - endpointProtocol: HTTPS - endpointProtocolVersion: - - "1.0" - href: https://catena-x.net/vehicle/basedetails/ - subprotocol: DSP - subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net - subprotocolBodyEncoding: plain - idShort: SingleLevelBomAsPlanned - id: urn:uuid:5d25a897-6571-4800-b98c-a3352fbf996d - semanticId: - type: ModelReference - keys: - - type: ExternalReference - value: urn:bamm:io.catenax.single_level_bom_as_planned:2.0.0#SingleLevelBomAsPlanned - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - href: https://catena-x.net/vehicle/partdetails/ - endpointProtocol: HTTPS - endpointProtocolVersion: - - "1.0" - subprotocol: DSP - subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net - subprotocolBodyEncoding: plain - id: urn:uuid:dae4d249-6d66-4818-b576-bf52f3b9ae90 - idShort: vehicle part details - semanticId: - keys: - - type: Submodel - value: urn:bamm:com.catenax.vehicle:0.1.1#PartDetails - type: ModelReference - submodels: - - aspectType: urn:bamm:io.catenax.single_level_bom_as_built:1.0.0 - identification: urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff - payload: - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - childItems: - - createdOn: 2022-02-03T14:48:54.709Z - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - lastModifiedOn: 2022-02-03T14:48:54.709Z - lifecycleContext: AsBuilt - quantity: - measurementUnit: - datatypeURI: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece - lexicalValue: piece - quantityNumber: 1 - tombstones: - - catenaXId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - endpointURL: https://catena-x.net/vehicle/partdetails/ - processingError: - errorDetail: Details to reason of failure - lastAttempt: 2022-02-03T14:48:54.709Z - processStep: SchemaValidation - retryCounter: 0 - complete-order-result: - value: - batchChecksum: 1 - batches: - - batchId: f253718e-a270-4367-901b-9d50d9bd8462 - batchNumber: 1 - batchProcessingState: PARTIAL - batchUrl: https://../irs/orders/f253718e-a270-4367-901b-9d50d9bd8462/batches/f253718e-a270-4367-901b-9d50d9bd8462 - jobsInBatchChecksum: 1 - orderId: f253718e-a270-4367-901b-9d50d9bd8462 - state: COMPLETED - error-response-400: - value: - error: Bad request - messages: - - BadRequestException - statusCode: 400 BAD_REQUEST - error-response-401: - value: - error: Unauthorized - messages: - - UnauthorizedException - statusCode: 401 UNAUTHORIZED - error-response-403: - value: - error: Forbidden - messages: - - ForbiddenException - statusCode: 403 FORBIDDEN - error-response-404: - value: - error: Not found - messages: - - NotFoundException - statusCode: 404 NOT_FOUND - failed-job-result: - value: - bpns: [] - job: - createdOn: 2022-02-03T14:48:54.709Z - exception: - errorDetail: Timeout while requesting Digital Registry - exception: IrsTimeoutException - exceptionDate: 2022-02-03T14:48:54.709Z - globalAssetId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - id: e5347c88-a921-11ec-b909-0242ac120002 - lastModifiedOn: 2022-02-03T14:48:54.709Z - owner: "" - parameter: - aspects: - - SerialPart - - AddressAspect - bomLifecycle: asBuilt - collectAspects: false - depth: 1 - direction: downward - lookupBPNs: false - startedOn: 2022-02-03T14:48:54.709Z - state: ERROR - summary: - asyncFetchedItems: - completed: 0 - failed: 0 - running: 0 - relationships: [] - submodels: [] - tombstones: [] - job-handle: - value: - id: 6c311d29-5753-46d4-b32c-19b918ea93b0 - job-result-without-uncompleted-result-tree: - value: - bpns: - - manufacturerId: BPNL00000003AYRE - manufacturerName: OEM A - job: - completedOn: 2022-02-03T14:48:54.709Z - createdOn: 2022-02-03T14:48:54.709Z - exception: - errorDetail: Timeout while requesting Digital Registry - exception: IrsTimeoutException - exceptionDate: 2022-02-03T14:48:54.709Z - globalAssetId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - id: e5347c88-a921-11ec-b909-0242ac120002 - lastModifiedOn: 2022-02-03T14:48:54.709Z - owner: "" - parameter: - aspects: - - SerialPart - - AddressAspect - bomLifecycle: asBuilt - collectAspects: false - depth: 1 - direction: downward - lookupBPNs: false - startedOn: 2022-02-03T14:48:54.709Z - state: COMPLETED - summary: - asyncFetchedItems: - completed: 0 - failed: 0 - running: 0 - relationships: - - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - linkedItem: - assembledOn: 2022-02-03T14:48:54.709Z - childCatenaXId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 - hasAlternatives: false - lastModifiedOn: 2022-02-03T14:48:54.709Z - lifecycleContext: asBuilt - quantity: - measurementUnit: - datatypeURI: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece - lexicalValue: piece - quantityNumber: 1.0 - shells: - - description: - - language: en - text: The shell for a vehicle - globalAssetId: urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9 - id: urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8 - idShort: future concept x - specificAssetIds: - - name: engineserialid - value: "12309481209312" - submodelDescriptors: - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - endpointProtocol: HTTPS - endpointProtocolVersion: ["1.0"] - href: https://catena-x.net/vehicle/basedetails/ - subprotocol: DSP - subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net - subprotocolBodyEncoding: plain - id: urn:uuid:5d25a897-6571-4800-b98c-a3352fbf996d - idShort: SingleLevelBomAsPlanned - semanticId: - type: ModelReference - keys: - - type: ExternalReference - value: urn:bamm:io.catenax.single_level_bom_as_planned:2.0.0#SingleLevelBomAsPlanned - - description: - - language: en - text: Provides base vehicle information - endpoints: - - interface: HTTP - protocolInformation: - href: https://catena-x.net/vehicle/partdetails/ - endpointProtocol: HTTPS - endpointProtocolVersion: ["1.0"] - subprotocol: DSP - subprotocolBody: id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net - subprotocolBodyEncoding: plain - id: urn:uuid:dae4d249-6d66-4818-b576-bf52f3b9ae90 - idShort: vehicle part details - semanticId: - type: ModelReference - keys: - - type: Submodel - value: urn:bamm:com.catenax.vehicle:0.1.1#PartDetails - submodels: - - aspectType: urn:bamm:io.catenax.single_level_bom_as_built:1.0.0 - identification: urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff - payload: - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - childItems: - - createdOn: 2022-02-03T14:48:54.709Z - catenaXId: urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447 - lastModifiedOn: 2022-02-03T14:48:54.709Z - lifecycleContext: AsBuilt - quantity: - measurementUnit: - datatypeURI: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece - lexicalValue: piece - quantityNumber: 1 - tombstones: - - catenaXId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - endpointURL: https://catena-x.net/vehicle/partdetails/ - processingError: - errorDetail: Details to reason of failure - lastAttempt: 2022-02-03T14:48:54.709Z - processStep: SchemaValidation - retryCounter: 0 - partial-job-result: - value: - bpns: [] - job: - completedOn: 2022-02-03T14:48:54.709Z - createdOn: 2022-02-03T14:48:54.709Z - exception: - errorDetail: Timeout while requesting Digital Registry - exception: IrsTimeoutException - exceptionDate: 2022-02-03T14:48:54.709Z - globalAssetId: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - id: e5347c88-a921-11ec-b909-0242ac120002 - lastModifiedOn: 2022-02-03T14:48:54.709Z - owner: "" - parameter: - aspects: - - SerialPart - - AddressAspect - bomLifecycle: asBuilt - collectAspects: false - depth: 1 - direction: downward - lookupBPNs: false - startedOn: 2022-02-03T14:48:54.709Z - state: RUNNING - summary: - asyncFetchedItems: - completed: 0 - failed: 0 - running: 0 - relationships: [] - submodels: [] - tombstones: [] - aspect-models-list: - value: - lastUpdated: 2023-02-13T08:18:11.990659500Z - models: - - urn: urn:bamm:io.catenax.single_level_bom_as_built:1.0.0#SingleLevelBomAsBuilt - name: SingleLevelBomAsBuilt - status: RELEASED - type: BAMM - version: 1.0.0 - - urn: urn:bamm:io.catenax.serial_part:1.0.0#SerialPart - name: SerialPart - status: RELEASED - type: BAMM - version: 1.0.0 - schemas: - AdministrativeInformation: - type: object - additionalProperties: false - properties: - revision: - type: string - version: - type: string - AssetAdministrationShellDescriptor: - type: object - additionalProperties: false - description: AAS shells. - properties: - administration: - $ref: '#/components/schemas/AdministrativeInformation' - description: - type: array - items: - $ref: '#/components/schemas/LangString' - maxItems: 2147483647 - globalAssetId: - type: string - description: Id of global asset. - example: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - id: - type: string - example: 882fc530-b69b-4707-95f6-5dbc5e9baaa8 - idShort: - type: string - example: future concept x - specificAssetIds: - type: array - items: - $ref: '#/components/schemas/IdentifierKeyValuePair' - maxItems: 2147483647 - submodelDescriptors: - type: array - items: - $ref: '#/components/schemas/SubmodelDescriptor' - maxItems: 2147483647 - AsyncFetchedItems: - type: object - additionalProperties: false - description: Statistics of job execution. - properties: - completed: - type: integer - format: int32 - description: Number of completed item transfers. - maximum: 2147483647 - minimum: 0 - failed: - type: integer - format: int32 - description: Number of failed item transfers. - maximum: 2147483647 - minimum: 0 - running: - type: integer - format: int32 - description: Number of running item transfers. - maximum: 2147483647 - minimum: 0 - BatchOrderCreated: - type: object - additionalProperties: false - description: Id of the created Batch order. - properties: - id: - type: string - format: uuid - description: Id of the Batch Order. - BatchOrderResponse: - type: object - additionalProperties: false - description: BatchOrderAck Payload Response. - properties: - batchChecksum: - type: integer - format: int32 - description: Expected number of batches in order. - batches: - type: array - description: Array of batches. - items: - $ref: '#/components/schemas/BatchResponse' - maxItems: 2147483647 - orderId: - type: string - format: uuid - description: Id of the order. - maxLength: 36 - minLength: 36 - pattern: "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i" - state: - type: string - description: The state of the order. - enum: - - INITIALIZED - - COMPLETED - - PROCESSING - - PARTIAL - - ERROR - BatchResponse: - type: object - additionalProperties: false - description: Batch model. - properties: - batchId: - type: string - format: uuid - description: Id of the batch. - maxLength: 36 - minLength: 36 - pattern: "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i" - batchNumber: - type: integer - format: int32 - description: Sequential number begins with first (1.) batch. - batchProcessingState: - type: string - description: The state of the batch. - enum: - - INITIALIZED - - COMPLETED - - PROCESSING - - PARTIAL - - ERROR - batchTotal: - type: integer - format: int32 - description: The total number of batches. - completedOn: - type: string - format: date-time - jobs: - type: array - description: Array of jobs. - items: - $ref: '#/components/schemas/JobStatusResult' - maxItems: 2147483647 - jobsInBatchChecksum: - type: integer - format: int32 - description: Expected number of jobs in batch. - orderId: - type: string - format: uuid - description: Id of the order. - maxLength: 36 - minLength: 36 - pattern: "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i" - startedOn: - type: string - format: date-time - totalJobs: - type: integer - format: int32 - description: Total amount of jobs inside the order. - Bpn: - type: object - additionalProperties: false - description: Business partner id with name - properties: - manufacturerId: - type: string - example: BPNL00000003AYRE - manufacturerName: - type: string - example: OEM A - Constraint: - type: object - additionalProperties: false - properties: - leftOperand: - type: string - example: string - operator: - type: string - example: eq - enum: - - eq - - neq - - lt - - gt - - in - - lteq - - gteq - - isA - - hasPart - - isPartOf - - isOneOf - - isAllOf - - isNoneOf - rightOperand: - type: array - items: - type: string - example: [string] - Constraints: - type: object - additionalProperties: false - properties: - and: - type: array - items: - $ref: '#/components/schemas/Constraint' - or: - type: array - items: - $ref: '#/components/schemas/Constraint' - CreatePolicyRequest: - type: object - additionalProperties: false - description: Request to add a policy - properties: - permissions: - type: array - description: List of permissions that will be added to the Policy on creation. - items: - $ref: '#/components/schemas/Permission' - policyId: - type: string - description: The ID of the policy to add - validUntil: - type: string - format: date-time - description: Timestamp after which the policy will no longer be accepted in negotiations - required: - - permissions - - policyId - - validUntil - EdcNotificationResponseNotificationContent: - type: object - additionalProperties: false - properties: - content: - $ref: '#/components/schemas/ResponseNotificationContent' - header: - $ref: '#/components/schemas/EdcNotificationHeader' - required: - - content - - header - EdcNotificationHeader: - type: object - additionalProperties: false - description: EDC notification header information - properties: - notificationId: - type: string - notificationType: - type: string - originalNotificationId: - type: string - recipientBpn: - type: string - replyAssetId: - type: string - replyAssetSubPath: - type: string - senderBpn: - type: string - senderEdc: - type: string - required: - - notificationId - - notificationType - - recipientBpn - - senderBpn - Endpoint: - type: object - additionalProperties: false - properties: - interface: - type: string - example: HTTP - protocolInformation: - $ref: '#/components/schemas/ProtocolInformation' - ErrorResponse: - type: object - additionalProperties: false - description: Error response. - properties: - error: - type: string - description: Error. - messages: - type: array - description: List of error messages. - items: - type: string - maxItems: 2147483647 - statusCode: - type: string - description: Error code. - enum: - - 100 CONTINUE - - 101 SWITCHING_PROTOCOLS - - 102 PROCESSING - - 103 EARLY_HINTS - - 103 CHECKPOINT - - 200 OK - - 201 CREATED - - 202 ACCEPTED - - 203 NON_AUTHORITATIVE_INFORMATION - - 204 NO_CONTENT - - 205 RESET_CONTENT - - 206 PARTIAL_CONTENT - - 207 MULTI_STATUS - - 208 ALREADY_REPORTED - - 226 IM_USED - - 300 MULTIPLE_CHOICES - - 301 MOVED_PERMANENTLY - - 302 FOUND - - 302 MOVED_TEMPORARILY - - 303 SEE_OTHER - - 304 NOT_MODIFIED - - 305 USE_PROXY - - 307 TEMPORARY_REDIRECT - - 308 PERMANENT_REDIRECT - - 400 BAD_REQUEST - - 401 UNAUTHORIZED - - 402 PAYMENT_REQUIRED - - 403 FORBIDDEN - - 404 NOT_FOUND - - 405 METHOD_NOT_ALLOWED - - 406 NOT_ACCEPTABLE - - 407 PROXY_AUTHENTICATION_REQUIRED - - 408 REQUEST_TIMEOUT - - 409 CONFLICT - - 410 GONE - - 411 LENGTH_REQUIRED - - 412 PRECONDITION_FAILED - - 413 PAYLOAD_TOO_LARGE - - 413 REQUEST_ENTITY_TOO_LARGE - - 414 URI_TOO_LONG - - 414 REQUEST_URI_TOO_LONG - - 415 UNSUPPORTED_MEDIA_TYPE - - 416 REQUESTED_RANGE_NOT_SATISFIABLE - - 417 EXPECTATION_FAILED - - 418 I_AM_A_TEAPOT - - 419 INSUFFICIENT_SPACE_ON_RESOURCE - - 420 METHOD_FAILURE - - 421 DESTINATION_LOCKED - - 422 UNPROCESSABLE_ENTITY - - 423 LOCKED - - 424 FAILED_DEPENDENCY - - 425 TOO_EARLY - - 426 UPGRADE_REQUIRED - - 428 PRECONDITION_REQUIRED - - 429 TOO_MANY_REQUESTS - - 431 REQUEST_HEADER_FIELDS_TOO_LARGE - - 451 UNAVAILABLE_FOR_LEGAL_REASONS - - 500 INTERNAL_SERVER_ERROR - - 501 NOT_IMPLEMENTED - - 502 BAD_GATEWAY - - 503 SERVICE_UNAVAILABLE - - 504 GATEWAY_TIMEOUT - - 505 HTTP_VERSION_NOT_SUPPORTED - - 506 VARIANT_ALSO_NEGOTIATES - - 507 INSUFFICIENT_STORAGE - - 508 LOOP_DETECTED - - 509 BANDWIDTH_LIMIT_EXCEEDED - - 510 NOT_EXTENDED - - 511 NETWORK_AUTHENTICATION_REQUIRED - IdentifierKeyValuePair: - type: object - additionalProperties: false - properties: - name: - type: string - example: engineserialid - semanticId: - $ref: '#/components/schemas/Reference' - subjectId: - $ref: '#/components/schemas/Reference' - value: - type: string - example: "12309481209312" - Job: - type: object - additionalProperties: false - description: Executable unit with meta information and item graph result. - properties: - completedOn: - type: string - format: date-time - example: 2022-02-03T14:48:54.709Z - createdOn: - type: string - format: date-time - example: 2022-02-03T14:48:54.709Z - exception: - $ref: '#/components/schemas/JobErrorDetails' - globalAssetId: - type: string - description: Part global unique id in the format urn:uuid:uuid4. - example: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - maxLength: 45 - minLength: 45 - pattern: "^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - id: - type: string - format: uuid - example: e5347c88-a921-11ec-b909-0242ac120002 - description: Id of the job. - maxLength: 36 - minLength: 36 - pattern: "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i" - lastModifiedOn: - type: string - format: date-time - example: 2022-02-03T14:48:54.709Z - owner: - type: string - description: The IRS api consumer. - parameter: - $ref: '#/components/schemas/JobParameter' - startedOn: - type: string - format: date-time - example: 2022-02-03T14:48:54.709Z - state: - type: string - example: COMPLETED - enum: - - UNSAVED - - INITIAL - - RUNNING - - TRANSFERS_FINISHED - - COMPLETED - - CANCELED - - ERROR - summary: - $ref: '#/components/schemas/Summary' - required: - - globalAssetId - - id - - state - JobErrorDetails: - type: object - additionalProperties: false - description: Job error details. - properties: - errorDetail: - type: string - example: Timeout while requesting Digital Registry - description: Detailed exception information. - maxLength: 4000 - exception: - type: string - description: Exception name. - example: IrsTimeoutException - maxLength: 100 - exceptionDate: - type: string - format: date-time - description: Datetime error occurs. - example: 2022-02-03T14:48:54.709Z - JobHandle: - type: object - additionalProperties: false - description: The unique jobId handle of the just processed job. - properties: - id: - type: string - format: uuid - description: Id of the job. - maxLength: 36 - minLength: 36 - pattern: "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i" - JobParameter: - type: object - additionalProperties: false - description: Job parameter of job processing. - properties: - aspects: - type: string - example: SerialPart - bomLifecycle: - type: string - example: asBuilt - description: The lifecycle context in which the child part was assembled - into the parent part. - enum: - - asBuilt - - asPlanned - - asSpecified - bpn: - type: string - example: BPNL00000003AYRE - callbackUrl: - type: string - example: https://hostname.com/callback?id={id}&state={state} - collectAspects: - type: boolean - example: false - depth: - type: integer - format: int32 - example: 1 - maximum: 2147483647 - minimum: 0 - direction: - type: string - example: upward - description: Item graph traversal direction. - enum: - - upward - - downward - lookupBPNs: - type: boolean - example: false - JobStatusResult: - type: object - additionalProperties: false - properties: - completedOn: - type: string - format: date-time - id: - type: string - format: uuid - startedOn: - type: string - format: date-time - state: - type: string - enum: - - UNSAVED - - INITIAL - - RUNNING - - TRANSFERS_FINISHED - - COMPLETED - - CANCELED - - ERROR - Jobs: - type: object - additionalProperties: false - description: Container for a job with item graph. - properties: - bpns: - type: array - description: Collection of bpn mappings - items: - $ref: '#/components/schemas/Bpn' - maxItems: 2147483647 - uniqueItems: true - job: - $ref: '#/components/schemas/Job' - relationships: - type: array - description: Relationships between parent and child items. - items: - $ref: '#/components/schemas/Relationship' - maxItems: 2147483647 - shells: - type: array - description: AAS shells. - items: - $ref: '#/components/schemas/AssetAdministrationShellDescriptor' - maxItems: 2147483647 - submodels: - type: array - description: Collection of requested Submodels - items: - $ref: '#/components/schemas/Submodel' - maxItems: 2147483647 - tombstones: - type: array - description: Collection of not resolvable endpoints as tombstones. Including - cause of error and endpoint URL. - items: - $ref: '#/components/schemas/Tombstone' - maxItems: 2147483647 - LangString: - type: object - additionalProperties: false - properties: - language: - type: string - example: en - text: - type: string - example: The shell for a vehicle - LinkedItem: - type: object - additionalProperties: false - description: Set of child parts the parent object is assembled by (one structural - level down). - properties: - assembledOn: - type: string - format: date-time - description: Datetime of assembly. - example: 2022-02-03T14:48:54.709Z - childCatenaXId: - type: string - description: CatenaX child global asset id in the format urn:uuid:uuid4. - example: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - maxLength: 45 - minLength: 45 - pattern: "^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - hasAlternatives: - type: boolean - description: Expresses whether the part is built-in or whether it is one - of several options. - lastModifiedOn: - type: string - format: date-time - description: Last datetime item was modified. - example: 2022-02-03T14:48:54.709Z - lifecycleContext: - type: string - description: The lifecycle context in which the child part was assembled - into the parent part. - enum: - - asBuilt - - asPlanned - - asSpecified - example: asBuilt - quantity: - $ref: '#/components/schemas/Quantity' - MeasurementUnit: - type: object - additionalProperties: false - properties: - datatypeURI: - type: string - example: urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece - lexicalValue: - type: string - example: piece - PageResult: - type: object - additionalProperties: false - properties: - content: - type: array - items: - $ref: '#/components/schemas/JobStatusResult' - pageCount: - type: integer - format: int32 - pageNumber: - type: integer - format: int32 - pageSize: - type: integer - format: int32 - totalElements: - type: integer - format: int32 - PartChainIdentificationKey: - type: object - additionalProperties: false - description: Key object contains required attributes for identify part chain - entry node. - properties: - bpn: - type: string - description: BPN of partner providing the initial asset - example: BPNL0123456789XX - maxLength: 16 - minLength: 16 - #pattern: "^(BPN)(L|S|A)(\\d{10})([a-zA-Z0-9]{2})$" - globalAssetId: - type: string - description: Id of global asset. - example: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - maxLength: 45 - minLength: 45 - pattern: "^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - required: - - bpn - - globalAssetId - Permission: - type: object - additionalProperties: false - properties: - action: - type: string - example: USE - enum: - - ACCESS - - USE - constraints: - type: array - items: - $ref: '#/components/schemas/Constraints' - Policy: - type: object - additionalProperties: false - properties: - createdOn: - type: string - format: date-time - permissions: - type: array - items: - $ref: '#/components/schemas/Permission' - policyId: - type: string - example: f253718e-a270-4367-901b-9d50d9bd8462 - validUntil: - type: string - format: date-time - ProcessingError: - type: object - additionalProperties: false - properties: - errorDetail: - type: string - lastAttempt: - type: string - format: date-time - processStep: - type: string - enum: - - SubmodelRequest - - DigitalTwinRequest - - SchemaValidation - - SchemaRequest - - BpdmRequest - - BpdmValidation - - UsagePolicyValidation - - EssValidation - retryCounter: - type: integer - format: int32 - maximum: 2147483647 - minimum: 0 - ProtocolInformation: - type: object - additionalProperties: false - properties: - href: - example: https://edc.data.plane/{path}/submodel - type: string - endpointProtocol: - example: HTTPS - type: string - endpointProtocolVersion: - type: array - example: ["1.0"] - items: - type: string - subprotocol: - type: string - subprotocolBody: - type: string - subprotocolBodyEncoding: - type: string - Quantity: - type: object - additionalProperties: false - description: Quantity component. - properties: - measurementUnit: - $ref: '#/components/schemas/MeasurementUnit' - quantityNumber: - type: number - example: 1.0 - format: double - maximum: 2147483647 - minimum: 0 - Reference: - type: object - additionalProperties: false - properties: - type: - type: string - keys: - type: array - items: - $ref: '#/components/schemas/SemanticId' - maxItems: 2147483647 - RegisterBatchOrder: - type: object - additionalProperties: false - description: Request body for registering a new Batch Order. - properties: - aspects: - type: array - items: - type: string - maxItems: 2147483647 - batchSize: - type: integer - format: int32 - default: 20 - description: Size of the batch. - maximum: 100 - minimum: 10 - batchStrategy: - type: string - description: The strategy how the batch is processed internally in IRS. - enum: - - PRESERVE_BATCH_JOB_ORDER - - PRESERVE_JOB_ORDER - - PRESERVE_BATCH_ORDER - bomLifecycle: - type: string - description: The lifecycle context in which the child part was assembled - into the parent part. - enum: - - asBuilt - - asPlanned - - asSpecified - callbackUrl: - type: string - description: "Callback url to notify requestor when job processing is finished.\ - \ There are four uri variable placeholders that can be used: orderId,\ - \ batchId, orderState and batchState." - example: "https://hostname.com/callback?orderId={orderId}&batchId={batchId}&orderState={orderState}&batchState={batchState}" - collectAspects: - type: boolean - description: Flag to specify whether aspects should be requested and collected. - Default is false. - depth: - type: integer - format: int32 - description: Max depth of the item graph returned. If no depth is set item - graph with max depth is returned. - maximum: 100 - minimum: 1 - direction: - type: string - default: downward - description: Item graph traversal direction. - enum: - - upward - - downward - jobTimeout: - type: integer - format: int32 - default: 3600 - description: Timeout in seconds for each job processing inside the complete - order. - maximum: 7200 - minimum: 60 - keys: - type: array - items: - $ref: '#/components/schemas/PartChainIdentificationKey' - maxItems: 2147483647 - lookupBPNs: - type: boolean - description: Flag to specify whether BPNs should be collected and resolved - via the configured BPDM URL. Default is false. - timeout: - type: integer - format: int32 - default: 43200 - description: Timeout in seconds for the complete batch order processing. - maximum: 86400 - minimum: 60 - required: - - keys - RegisterBpnInvestigationBatchOrder: - type: object - additionalProperties: false - description: Request body for registering a new Batch Order for ESS Investigation - Job. - properties: - batchSize: - type: integer - format: int32 - default: 20 - description: Size of the batch. - maximum: 100 - minimum: 10 - batchStrategy: - type: string - description: The strategy how the batch is processed internally in IRS. - enum: - - PRESERVE_BATCH_JOB_ORDER - - PRESERVE_JOB_ORDER - - PRESERVE_BATCH_ORDER - bomLifecycle: - type: string - description: The lifecycle context in which the child part was assembled - into the parent part. - enum: - - asBuilt - - asPlanned - - asSpecified - callbackUrl: - type: string - description: "Callback url to notify requestor when job processing is finished.\ - \ There are four uri variable placeholders that can be used: orderId,\ - \ batchId, orderState and batchState." - example: "https://hostname.com/callback?orderId={orderId}&batchId={batchId}&orderState={orderState}&batchState={batchState}" - incidentBPNSs: - type: array - items: - type: string - pattern: "(BPN)[LSA][\\w\\d]{10}[\\w\\d]{2}" - maxItems: 2147483647 - jobTimeout: - type: integer - format: int32 - default: 3600 - description: Timeout in seconds for each job processing inside the complete - order. - maximum: 7200 - minimum: 60 - keys: - type: array - items: - $ref: '#/components/schemas/PartChainIdentificationKey' - maxItems: 2147483647 - timeout: - type: integer - format: int32 - default: 43200 - description: Timeout in seconds for the complete batch order processing. - maximum: 86400 - minimum: 60 - required: - - incidentBPNSs - - keys - RegisterBpnInvestigationJob: - type: object - additionalProperties: false - description: The requested job definition. - properties: - bomLifecycle: - example: asPlanned - type: string - description: The lifecycle context in which the child part was assembled - into the parent part. - enum: - - asBuilt - - asPlanned - - asSpecified - callbackUrl: - type: string - description: "Callback url to notify requestor when job processing is finished.\ - \ There are two uri variable placeholders that can be used: jobId and\ - \ jobState." - example: "https://hostname.com/callback?jobId={jobId}&jobState={jobState}" - key: - $ref: '#/components/schemas/PartChainIdentificationKey' - incidentBPNSs: - type: array - items: - type: string - pattern: "(BPN)[LSA][\\w\\d]{10}[\\w\\d]{2}" - maxItems: 2147483647 - required: - - incidentBPNSs - - key - RegisterJob: - type: object - additionalProperties: false - description: The requested job definition. - properties: - aspects: - type: array - description: List of aspect names that will be collected if \ - flag is set to true. - items: - type: string - maxItems: 2147483647 - bomLifecycle: - type: string - description: The lifecycle context in which the child part was assembled - into the parent part. - enum: - - asBuilt - - asPlanned - - asSpecified - callbackUrl: - type: string - description: "Callback url to notify requestor when job processing is finished.\ - \ There are two uri variable placeholders that can be used: id and state." - example: "https://hostname.com/callback?id={id}&state={state}" - collectAspects: - type: boolean - description: Flag to specify whether aspects should be requested and collected. - Default is false. - depth: - type: integer - format: int32 - description: Max depth of the item graph returned. If no depth is set item - graph with max depth is returned. - maximum: 100 - minimum: 1 - direction: - type: string - default: downward - description: Item graph traversal direction. - enum: - - upward - - downward - key: - $ref: '#/components/schemas/PartChainIdentificationKey' - lookupBPNs: - type: boolean - description: Flag to specify whether BPNs should be collected and resolved - via the configured BPDM URL. Default is false. - required: - - key - Relationship: - type: object - additionalProperties: false - description: Relationships between parent and child items. - properties: - aspectType: - type: string - example: SingleLevelBomAsBuilt - bpn: - type: string - example: BPNL00000003AYRE - catenaXId: - type: string - description: CATENA-X global asset id in the format urn:uuid:uuid4. - example: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - maxLength: 45 - minLength: 45 - pattern: "^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - linkedItem: - $ref: '#/components/schemas/LinkedItem' - ResponseNotificationContent: - type: object - additionalProperties: false - properties: - hops: - type: integer - format: int32 - bpn: - type: string - result: - type: string - SemanticId: - type: object - additionalProperties: false - properties: - type: - type: string - example: urn:bamm:com.catenax.vehicle:0.1.1 - value: - type: string - example: Submodel - Submodel: - type: object - additionalProperties: false - description: "Submodel with identification of SubmodelDescriptor, aspect type\ - \ and payload as String" - properties: - aspectType: - type: string - identification: - type: string - payload: - type: object - additionalProperties: - type: object - SubmodelDescriptor: - type: object - additionalProperties: false - properties: - administration: - $ref: '#/components/schemas/AdministrativeInformation' - description: - type: array - items: - $ref: '#/components/schemas/LangString' - maxItems: 2147483647 - endpoints: - type: array - items: - $ref: '#/components/schemas/Endpoint' - maxItems: 2147483647 - id: - type: string - idShort: - type: string - semanticId: - $ref: '#/components/schemas/Reference' - Summary: - type: object - additionalProperties: false - description: Summary of the job with statistics of the job processing. - properties: - asyncFetchedItems: - $ref: '#/components/schemas/AsyncFetchedItems' - bpnLookups: - $ref: '#/components/schemas/AsyncFetchedItems' - Tombstone: - type: object - additionalProperties: false - description: Tombstone with information about request failure - properties: - catenaXId: - type: string - description: CATENA-X global asset id in the format urn:uuid:uuid4. - example: urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0 - maxLength: 45 - minLength: 45 - pattern: "^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - endpointURL: - type: string - processingError: - $ref: '#/components/schemas/ProcessingError' - AspectModel: - type: object - additionalProperties: false - properties: - name: - type: string - status: - type: string - type: - type: string - urn: - type: string - version: - type: string - AspectModels: - type: object - additionalProperties: false - properties: - lastUpdated: - type: string - models: - type: array - items: - $ref: '#/components/schemas/AspectModel' - UpdatePolicyRequest: - type: object - additionalProperties: false - description: Request to add a policy - properties: - validUntil: - type: string - format: date-time - description: Timestamp after which the policy will no longer be accepted - in negotiations - required: - - validUntil - securitySchemes: - oAuth2: - flows: - clientCredentials: - scopes: - {} - tokenUrl: https://localhost - type: oauth2 \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index 052745d3f04..54a61585af8 100644 --- a/sidebars.js +++ b/sidebars.js @@ -46,26 +46,6 @@ const sidebars = { ], }, { - type: 'category', - label: 'KIT Guidelines', - - collapsed: true, - items: [ - "kit-process/graduation-process", - "kit-process/versioning", - "kit-process/artefacts", - { - type: 'category', - label: 'Documentation', - collapsed: true, - items: [ - "kit-process/processes/update-documentation", - "kit-process/processes/create_KIT_page", - ] - }, - "kit-process/processes/kit-faq" - ], - }, { type: 'category', label: 'Website Admin Guidelines', link: { @@ -79,6 +59,7 @@ const sidebars = { "website-guidelines/update-and-integrate-react-components", "website-guidelines/update-news-page", "website-guidelines/automate-kit-doc-update", + "website-guidelines/kit-structure", ], }, 'github-checks', diff --git a/sidebarsDocumentation.js b/sidebarsDocumentation.js new file mode 100644 index 00000000000..41e6f71c976 --- /dev/null +++ b/sidebarsDocumentation.js @@ -0,0 +1,53 @@ +/** + * Copyright (c) 2022,2023 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + */ + +/** + * Creating a sidebar enables you to: + - create an ordered group of docs + - render a sidebar for each doc of that group + - provide next/previous navigation + + The sidebars can be generated from the filesystem, or explicitly defined here. + + Create as many sidebars as you want. + */ + +// @ts-nocheck + +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ + +const sidebars = { + documentation: [ + { + type: 'category', + label: 'documentation', + link: { + type: 'doc', + id: 'kit-artifacts' + }, + items: [ + 'kit-artifacts', + 'kit-getting-started', + 'kit-maturity-levels' + ] + }, + ], +}; + +module.exports = sidebars; diff --git a/src/pages/CHANGELOG.md b/src/pages/CHANGELOG.md index 1472fd23278..89b63b3961e 100644 --- a/src/pages/CHANGELOG.md +++ b/src/pages/CHANGELOG.md @@ -397,8 +397,8 @@ For installation details, please see the referenced Repositories / Releases. ### Known knowns - Relevant components and interfaces developed considering [Gaia-X](https://gaia-x.eu/) Trust Framework - 22.10 -Connection to an external Clearing House service for the entire Catena-X ecosystem required. -The [Gaia-X](https://gaia-x.eu/) compliance service should generally be capable to recognize all companies that are able to register with the Catena-X Portal. + Connection to an external Clearing House service for the entire Catena-X ecosystem required. + The [Gaia-X](https://gaia-x.eu/) compliance service should generally be capable to recognize all companies that are able to register with the Catena-X Portal. - FOSS components developed and pre-tested to TRL6 with artificial test data only - No crosscheck of functionality in verification environment (Pre-PROD) - No execution of Load-, Performance- or Penetration Tests @@ -477,7 +477,7 @@ For installation details, please see the referenced Repositories / Releases. - Developed considering [Gaia-X](https://gaia-x.eu/) Trust Framework - 22.04 - FOSS components developed and pre-tested to TRL6 with artificial test data only -- Restricted crosscheck of functionality in verification environment: +- Restricted crosscheck of functionality in verification environment: Smoke-tests did not verify - Approval of company registration - Mutiple user onboarding @@ -506,7 +506,7 @@ For installation details, please see the referenced Repositories / Releases. - No execution of Load-, Performance- or Penetration Tests - No assignment of Export Control Classification Numbers (ECCN) to FOSS components - GeoBlocking recommended for Operations (GBaaS) -- Portal (Registration) as well as Managed Identity Wallet scope required for full functionality; yet both are unreleased +- Portal (Registration) as well as Managed Identity Wallet scope required for full functionality; yet both are unreleased at this point in time and can be expected with Release 2.1.0 - Released Helm Chart missing for EDC v0.1.2; can be expected with Release 2.1.0 diff --git a/static/img/Industry_Kit.png b/static/img/Industry_Kit.png new file mode 100644 index 00000000000..90009a0480f Binary files /dev/null and b/static/img/Industry_Kit.png differ diff --git a/static/img/kit-icons/certificate-kit-icon.svg b/static/img/kit-icons/certificate-kit-icon.svg index 8f486c3f7cb..d119fec042c 100644 --- a/static/img/kit-icons/certificate-kit-icon.svg +++ b/static/img/kit-icons/certificate-kit-icon.svg @@ -1,52 +1,52 @@ - - - - - - + + + + + + - - - - - - - - - - + + + + + + + + + + - + - + - + - + - + - - + + - + diff --git a/static/meetings/draft-feature-freeze-r2412.ics b/static/meetings/draft-feature-freeze-r2412.ics new file mode 100644 index 00000000000..ef0016674d7 --- /dev/null +++ b/static/meetings/draft-feature-freeze-r2412.ics @@ -0,0 +1,71 @@ +BEGIN:VCALENDAR +METHOD:PUBLISH +PRODID:Microsoft Exchange Server 2010 +VERSION:2.0 +BEGIN:VTIMEZONE +TZID:tzone://Microsoft/Utc +BEGIN:STANDARD +DTSTART:16010101T000000 +TZOFFSETFROM:+0000 +TZOFFSETTO:+0000 +END:STANDARD +BEGIN:DAYLIGHT +DTSTART:16010101T000000 +TZOFFSETFROM:+0000 +TZOFFSETTO:+0000 +END:DAYLIGHT +END:VTIMEZONE +BEGIN:VEVENT +ORGANIZER;CN=Stephan Bauer:mailto:stephan.bauer@catena-x.net +DESCRIPTION:Please have a look at https://eclipse-tractusx.github.io/blog f + or detailed information about the Release Planning for 24.12\n\n__________ + ______________________________________________________________________\nMi + crosoft Teams Benötigen Sie Hilfe?\nJetzt an der Besprechung teilnehmen\nBesprec + hungs-ID: 339 266 968 799\nKennung: oGwMWP\n______________________________ + __\nFür Organisatoren: Besprechungsoptionen | Ein + wahl-PIN zurücksetzen\n___________________________________________________________________ + _____________\n +UID:040000008200E00074C5B7101A82E008000000002F6D5A2FD08FDA01000000000000000 + 01000000009C8655129D2E84B811AD33D4B685D9A +SUMMARY:Draft Feature Freeze - Release 24.12 +DTSTART:20240712T070500Z +DTEND:20240712T100000Z +CLASS:PUBLIC +PRIORITY:5 +DTSTAMP:20240416T073210Z +TRANSP:OPAQUE +STATUS:CONFIRMED +LOCATION:Microsoft Teams Meeting +X-MICROSOFT-CDO-BUSYSTATUS:BUSY +X-MICROSOFT-CDO-INTENDEDSTATUS:BUSY +X-MICROSOFT-CDO-ALLDAYEVENT:FALSE +X-MICROSOFT-CDO-IMPORTANCE:1 +X-MICROSOFT-CDO-INSTTYPE:0 +X-MICROSOFT-SKYPETEAMSMEETINGURL:https://teams.microsoft.com/l/meetup-join/ + 19%3ameeting_YmRhMWViMmUtOTAzYS00YjNmLTgwMDMtMDJhOGZiOGUwOWQ0%40thread.v2/ + 0?context=%7b%22Tid%22%3a%221ad22c6d-2f08-4f05-a0ba-e17f6ce88380%22%2c%22O + id%22%3a%22a8b7a5ee-66ff-4695-afa2-08f893d8aaf6%22%7d +X-MICROSOFT-SKYPETEAMSPROPERTIES:{"cid":"19:meeting_YmRhMWViMmUtOTAzYS00YjN + mLTgwMDMtMDJhOGZiOGUwOWQ0@thread.v2"\,"rid":0\,"mid":0\,"uid":null\,"priva + te":true\,"type":0} +X-MICROSOFT-ONLINEMEETINGEXTERNALLINK: +X-MICROSOFT-ONLINEMEETINGINFORMATION:{"OnlineMeetingChannelId":null\,"Onlin + eMeetingProvider":3} +X-MICROSOFT-DONOTFORWARDMEETING:FALSE +X-MICROSOFT-DISALLOW-COUNTER:FALSE +X-MICROSOFT-LOCATIONDISPLAYNAME:Microsoft Teams Meeting +BEGIN:VALARM +DESCRIPTION:REMINDER +TRIGGER;RELATED=START:-PT15M +ACTION:DISPLAY +END:VALARM +END:VEVENT +END:VCALENDAR diff --git a/static/meetings/open-planning-r2412.ics b/static/meetings/open-planning-r2412.ics new file mode 100644 index 00000000000..1ae28cb8670 --- /dev/null +++ b/static/meetings/open-planning-r2412.ics @@ -0,0 +1,72 @@ +BEGIN:VCALENDAR +METHOD:PUBLISH +PRODID:Microsoft Exchange Server 2010 +VERSION:2.0 +BEGIN:VTIMEZONE +TZID:tzone://Microsoft/Utc +BEGIN:STANDARD +DTSTART:16010101T000000 +TZOFFSETFROM:+0000 +TZOFFSETTO:+0000 +END:STANDARD +BEGIN:DAYLIGHT +DTSTART:16010101T000000 +TZOFFSETFROM:+0000 +TZOFFSETTO:+0000 +END:DAYLIGHT +END:VTIMEZONE +BEGIN:VEVENT +ORGANIZER;CN=Stephan Bauer:mailto:stephan.bauer@catena-x.net +DESCRIPTION:Please have a look at https://eclipse-tractusx.github.io/blog f + or detailed information about the Release Planning for 24.12\n\n__________ + ______________________________________________________________________\nMi + crosoft Teams Benötigen Sie Hilfe?\nJetzt an der Besprechung teilnehmen\nBesprec + hungs-ID: 344 731 276 68\nKennung: abwjeM\n_______________________________ + _\nFür Organisatoren: Besprechungsoptionen | Einw + ahl-PIN zurücksetzen\n____________________________________________________________________ + ____________\n +RRULE:FREQ=WEEKLY;UNTIL=20240803T220000Z;INTERVAL=1;BYDAY=WE,TH;WKST=MO +UID:040000008200E00074C5B7101A82E00800000000E9AAEA0ECF8FDA01000000000000000 + 010000000FAD04F6D310F94499D61486CCD2FBA1D +SUMMARY:Open Planning Days - Release 24.12 +DTSTART:20240731T060500Z +DTEND:20240731T100000Z +CLASS:PUBLIC +PRIORITY:5 +DTSTAMP:20240416T101617Z +TRANSP:OPAQUE +STATUS:CONFIRMED +LOCATION:Microsoft Teams Meeting +X-MICROSOFT-CDO-BUSYSTATUS:BUSY +X-MICROSOFT-CDO-INTENDEDSTATUS:BUSY +X-MICROSOFT-CDO-ALLDAYEVENT:FALSE +X-MICROSOFT-CDO-IMPORTANCE:1 +X-MICROSOFT-CDO-INSTTYPE:1 +X-MICROSOFT-SKYPETEAMSMEETINGURL:https://teams.microsoft.com/l/meetup-join/ + 19%3ameeting_ZWY0ODI3ZmYtNjFiOS00OTI1LTlmNWMtZGUzNTFhNzg2OWI3%40thread.v2/ + 0?context=%7b%22Tid%22%3a%221ad22c6d-2f08-4f05-a0ba-e17f6ce88380%22%2c%22O + id%22%3a%22a8b7a5ee-66ff-4695-afa2-08f893d8aaf6%22%7d +X-MICROSOFT-SKYPETEAMSPROPERTIES:{"cid":"19:meeting_ZWY0ODI3ZmYtNjFiOS00OTI + 1LTlmNWMtZGUzNTFhNzg2OWI3@thread.v2"\,"rid":0\,"mid":0\,"uid":null\,"priva + te":true\,"type":0} +X-MICROSOFT-ONLINEMEETINGEXTERNALLINK: +X-MICROSOFT-ONLINEMEETINGINFORMATION:{"OnlineMeetingChannelId":null\,"Onlin + eMeetingProvider":3} +X-MICROSOFT-DONOTFORWARDMEETING:FALSE +X-MICROSOFT-DISALLOW-COUNTER:FALSE +X-MICROSOFT-LOCATIONDISPLAYNAME:Microsoft Teams Meeting +BEGIN:VALARM +DESCRIPTION:REMINDER +TRIGGER;RELATED=START:-PT15M +ACTION:DISPLAY +END:VALARM +END:VEVENT +END:VCALENDAR diff --git a/static/meetings/refinement-day-1-r2412.ics b/static/meetings/refinement-day-1-r2412.ics new file mode 100644 index 00000000000..054b8e6b3af --- /dev/null +++ b/static/meetings/refinement-day-1-r2412.ics @@ -0,0 +1,71 @@ +BEGIN:VCALENDAR +METHOD:PUBLISH +PRODID:Microsoft Exchange Server 2010 +VERSION:2.0 +BEGIN:VTIMEZONE +TZID:tzone://Microsoft/Utc +BEGIN:STANDARD +DTSTART:16010101T000000 +TZOFFSETFROM:+0000 +TZOFFSETTO:+0000 +END:STANDARD +BEGIN:DAYLIGHT +DTSTART:16010101T000000 +TZOFFSETFROM:+0000 +TZOFFSETTO:+0000 +END:DAYLIGHT +END:VTIMEZONE +BEGIN:VEVENT +ORGANIZER;CN=Stephan Bauer:mailto:stephan.bauer@catena-x.net +DESCRIPTION:Please have a look at https://eclipse-tractusx.github.io/blog f + or detailed information about the Release Planning for 24.12\n\n\n________ + ________________________________________________________________________\n + Microsoft Teams Benötigen Sie Hilfe?\nJetzt an der Besprechung teilnehmen\nBespr + echungs-ID: 329 979 340 528\nKennung: ytFAeo\n____________________________ + ____\nFür Organisatoren: Besprechungsoptionen | E + inwahl-PIN zurücksetzen\n_________________________________________________________________ + _______________\n +UID:040000008200E00074C5B7101A82E008000000009BE2FFB5CF8FDA01000000000000000 + 010000000E4546C4CCB105D4694A4BFD0F2DA1383 +SUMMARY:Refinement Day 1 - Release 24.12 +DTSTART:20240701T070500Z +DTEND:20240701T100000Z +CLASS:PUBLIC +PRIORITY:5 +DTSTAMP:20240416T073434Z +TRANSP:OPAQUE +STATUS:CONFIRMED +LOCATION:Microsoft Teams Meeting +X-MICROSOFT-CDO-BUSYSTATUS:BUSY +X-MICROSOFT-CDO-INTENDEDSTATUS:BUSY +X-MICROSOFT-CDO-ALLDAYEVENT:FALSE +X-MICROSOFT-CDO-IMPORTANCE:1 +X-MICROSOFT-CDO-INSTTYPE:0 +X-MICROSOFT-SKYPETEAMSMEETINGURL:https://teams.microsoft.com/l/meetup-join/ + 19%3ameeting_OWE3ZjJmZTItN2ZlYi00YjFkLWIwMGQtNDBmMTBiOTdiZTE2%40thread.v2/ + 0?context=%7b%22Tid%22%3a%221ad22c6d-2f08-4f05-a0ba-e17f6ce88380%22%2c%22O + id%22%3a%22a8b7a5ee-66ff-4695-afa2-08f893d8aaf6%22%7d +X-MICROSOFT-SKYPETEAMSPROPERTIES:{"cid":"19:meeting_OWE3ZjJmZTItN2ZlYi00YjF + kLWIwMGQtNDBmMTBiOTdiZTE2@thread.v2"\,"rid":0\,"mid":0\,"uid":null\,"priva + te":true\,"type":0} +X-MICROSOFT-ONLINEMEETINGEXTERNALLINK: +X-MICROSOFT-ONLINEMEETINGINFORMATION:{"OnlineMeetingChannelId":null\,"Onlin + eMeetingProvider":3} +X-MICROSOFT-DONOTFORWARDMEETING:FALSE +X-MICROSOFT-DISALLOW-COUNTER:FALSE +X-MICROSOFT-LOCATIONDISPLAYNAME:Microsoft Teams Meeting +BEGIN:VALARM +DESCRIPTION:REMINDER +TRIGGER;RELATED=START:-PT15M +ACTION:DISPLAY +END:VALARM +END:VEVENT +END:VCALENDAR diff --git a/static/meetings/refinement-day-2-r2412.ics b/static/meetings/refinement-day-2-r2412.ics new file mode 100644 index 00000000000..de84d500b7d --- /dev/null +++ b/static/meetings/refinement-day-2-r2412.ics @@ -0,0 +1,71 @@ +BEGIN:VCALENDAR +METHOD:PUBLISH +PRODID:Microsoft Exchange Server 2010 +VERSION:2.0 +BEGIN:VTIMEZONE +TZID:tzone://Microsoft/Utc +BEGIN:STANDARD +DTSTART:16010101T000000 +TZOFFSETFROM:+0000 +TZOFFSETTO:+0000 +END:STANDARD +BEGIN:DAYLIGHT +DTSTART:16010101T000000 +TZOFFSETFROM:+0000 +TZOFFSETTO:+0000 +END:DAYLIGHT +END:VTIMEZONE +BEGIN:VEVENT +ORGANIZER;CN=Stephan Bauer:mailto:stephan.bauer@catena-x.net +DESCRIPTION:Please have a look at https://eclipse-tractusx.github.io/blog f + or detailed information about the Release Planning for 24.12\n\n\n________ + ________________________________________________________________________\n + Microsoft Teams Benötigen Sie Hilfe?\nJetzt an der Besprechung teilnehmen\nBespr + echungs-ID: 370 799 059 313\nKennung: UqYpeW\n____________________________ + ____\nFür Organisatoren: Besprechungsoptionen | E + inwahl-PIN zurücksetzen\n_________________________________________________________________ + _______________\n +UID:040000008200E00074C5B7101A82E00800000000994F3CFBCF8FDA01000000000000000 + 0100000001866A3188EE8ED4EB0B0FAA5D2791049 +SUMMARY:Refinement Day 2 - Release 24.12 +DTSTART:20240722T070500Z +DTEND:20240722T100000Z +CLASS:PUBLIC +PRIORITY:5 +DTSTAMP:20240416T073242Z +TRANSP:OPAQUE +STATUS:CONFIRMED +LOCATION:Microsoft Teams Meeting +X-MICROSOFT-CDO-BUSYSTATUS:BUSY +X-MICROSOFT-CDO-INTENDEDSTATUS:BUSY +X-MICROSOFT-CDO-ALLDAYEVENT:FALSE +X-MICROSOFT-CDO-IMPORTANCE:1 +X-MICROSOFT-CDO-INSTTYPE:0 +X-MICROSOFT-SKYPETEAMSMEETINGURL:https://teams.microsoft.com/l/meetup-join/ + 19%3ameeting_ZDFjMWQzNmYtZGZkOS00MDFmLWI5ZjYtNDRhNDRjZjIxNDQ4%40thread.v2/ + 0?context=%7b%22Tid%22%3a%221ad22c6d-2f08-4f05-a0ba-e17f6ce88380%22%2c%22O + id%22%3a%22a8b7a5ee-66ff-4695-afa2-08f893d8aaf6%22%7d +X-MICROSOFT-SKYPETEAMSPROPERTIES:{"cid":"19:meeting_ZDFjMWQzNmYtZGZkOS00MDF + mLWI5ZjYtNDRhNDRjZjIxNDQ4@thread.v2"\,"rid":0\,"mid":0\,"uid":null\,"priva + te":true\,"type":0} +X-MICROSOFT-ONLINEMEETINGEXTERNALLINK: +X-MICROSOFT-ONLINEMEETINGINFORMATION:{"OnlineMeetingChannelId":null\,"Onlin + eMeetingProvider":3} +X-MICROSOFT-DONOTFORWARDMEETING:FALSE +X-MICROSOFT-DISALLOW-COUNTER:FALSE +X-MICROSOFT-LOCATIONDISPLAYNAME:Microsoft Teams Meeting +BEGIN:VALARM +DESCRIPTION:REMINDER +TRIGGER;RELATED=START:-PT15M +ACTION:DISPLAY +END:VALARM +END:VEVENT +END:VCALENDAR diff --git a/static/meetings/refinement-phase-r2412.ics b/static/meetings/refinement-phase-r2412.ics new file mode 100644 index 00000000000..f0978e01c38 --- /dev/null +++ b/static/meetings/refinement-phase-r2412.ics @@ -0,0 +1,71 @@ +BEGIN:VCALENDAR +METHOD:PUBLISH +PRODID:Microsoft Exchange Server 2010 +VERSION:2.0 +BEGIN:VTIMEZONE +TZID:tzone://Microsoft/Utc +BEGIN:STANDARD +DTSTART:16010101T000000 +TZOFFSETFROM:+0000 +TZOFFSETTO:+0000 +END:STANDARD +BEGIN:DAYLIGHT +DTSTART:16010101T000000 +TZOFFSETFROM:+0000 +TZOFFSETTO:+0000 +END:DAYLIGHT +END:VTIMEZONE +BEGIN:VEVENT +ORGANIZER;CN=Stephan Bauer:mailto:stephan.bauer@catena-x.net +DESCRIPTION:Please have a look at https://eclipse-tractusx.github.io/blog f + or detailed information about the Release Planning for 24.12\n\n__________ + ______________________________________________________________________\nMi + crosoft Teams Benötigen Sie Hilfe?\nJetzt an der Besprechung teilnehmen\nBesprec + hungs-ID: 336 486 915 461\nKennung: bpiHcy\n______________________________ + __\nFür Organisatoren: Besprechungsoptionen | Ein + wahl-PIN zurücksetzen\n___________________________________________________________________ + _____________\n +UID:040000008200E00074C5B7101A82E00800000000CDCE013FCE8FDA01000000000000000 + 010000000F897806F026016449F59ADEC647D3FB5 +SUMMARY:Refinement Phase - Release 24.12 +DTSTART;VALUE=DATE:20240624 +DTEND;VALUE=DATE:20240729 +CLASS:PUBLIC +PRIORITY:5 +DTSTAMP:20240416T072529Z +TRANSP:TRANSPARENT +STATUS:CONFIRMED +LOCATION:Microsoft Teams Meeting +X-MICROSOFT-CDO-BUSYSTATUS:FREE +X-MICROSOFT-CDO-INTENDEDSTATUS:BUSY +X-MICROSOFT-CDO-ALLDAYEVENT:TRUE +X-MICROSOFT-CDO-IMPORTANCE:1 +X-MICROSOFT-CDO-INSTTYPE:0 +X-MICROSOFT-SKYPETEAMSMEETINGURL:https://teams.microsoft.com/l/meetup-join/ + 19%3ameeting_ZTQ5ZWMzNDUtMWQ0My00MDFhLWIxZmYtZjRlNTU2NzFmYmFk%40thread.v2/ + 0?context=%7b%22Tid%22%3a%221ad22c6d-2f08-4f05-a0ba-e17f6ce88380%22%2c%22O + id%22%3a%22a8b7a5ee-66ff-4695-afa2-08f893d8aaf6%22%7d +X-MICROSOFT-SKYPETEAMSPROPERTIES:{"cid":"19:meeting_ZTQ5ZWMzNDUtMWQ0My00MDF + hLWIxZmYtZjRlNTU2NzFmYmFk@thread.v2"\,"rid":0\,"mid":0\,"uid":null\,"priva + te":true\,"type":0} +X-MICROSOFT-ONLINEMEETINGEXTERNALLINK: +X-MICROSOFT-ONLINEMEETINGINFORMATION:{"OnlineMeetingChannelId":null\,"Onlin + eMeetingProvider":3} +X-MICROSOFT-DONOTFORWARDMEETING:FALSE +X-MICROSOFT-DISALLOW-COUNTER:FALSE +X-MICROSOFT-LOCATIONDISPLAYNAME:Microsoft Teams Meeting +BEGIN:VALARM +DESCRIPTION:REMINDER +TRIGGER;RELATED=START:-PT18H +ACTION:DISPLAY +END:VALARM +END:VEVENT +END:VCALENDAR diff --git a/utils/carouselKitdeepdive.js b/utils/carouselKitdeepdive.js index 575476f5865..d10e44d91b8 100644 --- a/utils/carouselKitdeepdive.js +++ b/utils/carouselKitdeepdive.js @@ -15,7 +15,7 @@ export const carouselKitdeepdive = [ id: 3, title: "KIT Creation", description: "How to create a KIT?", - navigate: "/docs/kit-process/graduation-process" + navigate: "/documentation/kit-getting-started" } ] \ No newline at end of file diff --git a/utils/kitsGallery.js b/utils/kitsGallery.js index a698ab82d7b..9080961a603 100644 --- a/utils/kitsGallery.js +++ b/utils/kitsGallery.js @@ -16,6 +16,7 @@ import BehaviourTwinHI_Kit from "@site/static/img/BehaviourTwinHI_Kit.png"; import Agents_Kit from "@site/static/img/Agents_Kit.png"; import Maas_Kit from "@site/static/img/MaaSKIT.png"; import Certificate_Kit from "@site/static/img/Certificate_Kit.png" +import Industry_Kit from "@site/static/img/Industry_Kit.png" // import MoreToCome from "@site/static/img/gallery-more_coming-minified.png"; @@ -155,5 +156,12 @@ export const kitsGallery = [ domain: 'Sustainability', img: ESS_Kit, pageRoute: "/docs-kits/kits/ESS-Kit/ESS%20Kit%20Adoption%20View" + }, + { + id: 19, + name: "Industry Core Kit", + domain: 'Network & Core Services', + img: Industry_Kit, + pageRoute: "/docs-kits/kits/Industry%20Core%20Kit/Business%20View%20Industry%20Core%20Kit" } ] diff --git a/utils/products.js b/utils/products.js index f0a05b59eae..29d044dbb94 100644 --- a/utils/products.js +++ b/utils/products.js @@ -109,8 +109,7 @@ export const products = [ productName: "Trace-X", productDescription: "The project provides a business application for tracking parts along the supply chain. A high level of transparency across the supplier network enables faster intervention based on a recorded event in the supply chain.", githubRepo: [ - "https://github.com/eclipse-tractusx/traceability-foss-backend", - "https://github.com/eclipse-tractusx/traceability-foss-frontend" + "https://github.com/eclipse-tractusx/traceability-foss", ], committers: [ "https://github.com/ds-mkanal"