From 1cc3bf3c2038928d4802597def34c6581f1940a6 Mon Sep 17 00:00:00 2001 From: Martin Maul Date: Mon, 24 Jun 2024 13:02:48 +0200 Subject: [PATCH 01/14] chore(contract): 1037 reference to assets for contract id --- .../contracts/contracts.component.ts | 17 +++++++++++++++-- .../app/modules/page/parts/model/parts.model.ts | 4 ++++ .../modules/shared/assembler/parts.assembler.ts | 2 ++ .../parts-as-built-configuration.model.ts | 1 + .../parts-as-planned-configuration.model.ts | 1 + frontend/src/assets/locales/de/common.json | 7 +++++-- frontend/src/assets/locales/en/common.json | 7 +++++-- 7 files changed, 33 insertions(+), 6 deletions(-) diff --git a/frontend/src/app/modules/page/admin/presentation/contracts/contracts.component.ts b/frontend/src/app/modules/page/admin/presentation/contracts/contracts.component.ts index 8726d3840c..923d740666 100644 --- a/frontend/src/app/modules/page/admin/presentation/contracts/contracts.component.ts +++ b/frontend/src/app/modules/page/admin/presentation/contracts/contracts.component.ts @@ -1,4 +1,4 @@ -import { Component } from '@angular/core'; +import { Component, EventEmitter } from '@angular/core'; import { Router } from '@angular/router'; import { Pagination } from '@core/model/pagination.model'; import { AdminFacade } from '@page/admin/core/admin.facade'; @@ -22,6 +22,7 @@ export class ContractsComponent { selectedContracts: Contract[]; contractFilter: any; pagination: TableEventConfig; + viewAssetsClicked: EventEmitter = new EventEmitter; constructor(public readonly adminFacade: AdminFacade, private readonly contractsFacade: ContractsFacade, private readonly router: Router) {} @@ -33,13 +34,25 @@ export class ContractsComponent { } else { this.contractsFacade.setContracts(0,10,[null,null]); } + + this.viewAssetsClicked.subscribe((data) => { + this.router.navigate([ 'parts' ], { queryParams: { contractId: data?.['contractId'] } }); + }); }) this.pagination = { page: 0, pageSize: 10, sorting: [ '', null ] }; this.tableConfig = { displayedColumns: [ 'select', 'contractId', 'counterpartyAddress', 'creationDate', 'endDate', 'state', 'menu' ], header: CreateHeaderFromColumns([ 'contractId', 'counterpartyAddress', 'creationDate', 'endDate', 'state', 'menu' ], 'pageAdmin.contracts'), - menuActionsConfig: [], + menuActionsConfig: [ + { + label: 'actions.viewParts', + icon: 'build', + action: (data: Record) => { + this.viewAssetsClicked.emit(data); + }, + }, + ], sortableColumns: { select: false, contractId: true, diff --git a/frontend/src/app/modules/page/parts/model/parts.model.ts b/frontend/src/app/modules/page/parts/model/parts.model.ts index 4296355d39..2e942e1a1f 100644 --- a/frontend/src/app/modules/page/parts/model/parts.model.ts +++ b/frontend/src/app/modules/page/parts/model/parts.model.ts @@ -42,6 +42,7 @@ export interface Part { owner: Owner; semanticDataModel: SemanticDataModel; classification: string; + contractAgreementId?: string; mainAspectType: MainAspectType; @@ -100,6 +101,7 @@ export interface PartResponse { receivedQualityInvestigationIdsInStatusActive: string[] importNote?: string, importState?: ImportState, + contractAgreementId?: string, tombstone?: string, } @@ -153,6 +155,7 @@ export interface AssetAsBuiltFilter { partId?: string, manufacturerPartId?: string, customerPartId?: string, + contractAgreementId?: string, classification?: string, nameAtCustomer?: string, semanticModelId?: string, @@ -170,6 +173,7 @@ export interface AssetAsPlannedFilter { businessPartner?: string, manufacturerPartId?: string, classification?: string, + contractAgreementId?: string, semanticDataModel?: string[], semanticModelId?: string, validityPeriodFrom?: string, diff --git a/frontend/src/app/modules/shared/assembler/parts.assembler.ts b/frontend/src/app/modules/shared/assembler/parts.assembler.ts index db8cbeebb3..1d6ebf7c04 100644 --- a/frontend/src/app/modules/shared/assembler/parts.assembler.ts +++ b/frontend/src/app/modules/shared/assembler/parts.assembler.ts @@ -89,6 +89,7 @@ export class PartsAssembler { semanticDataModel: partResponse.semanticDataModel, classification: partResponse.classification, semanticModel: createdSemanticModel, + contractAgreementId: partResponse.contractAgreementId, mainAspectType: mainAspectType, @@ -291,6 +292,7 @@ export class PartsAssembler { [ 'semanticDataModel', 'semanticDataModel' ], [ 'classification', 'classification' ], [ 'customerPartId', 'customerPartId' ], + [ 'contractAgreementId', 'contractAgreementId' ], [ 'nameAtCustomer', 'nameAtCustomer' ], [ 'manufacturingDate', 'manufacturingDate' ], [ 'manufacturingCountry', 'manufacturingCountry' ], diff --git a/frontend/src/app/modules/shared/components/parts-table/parts-as-built-configuration.model.ts b/frontend/src/app/modules/shared/components/parts-table/parts-as-built-configuration.model.ts index d997f3245e..e8448f6b4b 100644 --- a/frontend/src/app/modules/shared/components/parts-table/parts-as-built-configuration.model.ts +++ b/frontend/src/app/modules/shared/components/parts-table/parts-as-built-configuration.model.ts @@ -42,6 +42,7 @@ export class PartsAsBuiltConfigurationModel extends TableFilterConfiguration { sentActiveInvestigations: true, importState: true, importNote: true, + contractAgreementId: true, menu: false, }; diff --git a/frontend/src/app/modules/shared/components/parts-table/parts-as-planned-configuration.model.ts b/frontend/src/app/modules/shared/components/parts-table/parts-as-planned-configuration.model.ts index 011068b42f..3c7bc22542 100644 --- a/frontend/src/app/modules/shared/components/parts-table/parts-as-planned-configuration.model.ts +++ b/frontend/src/app/modules/shared/components/parts-table/parts-as-planned-configuration.model.ts @@ -41,6 +41,7 @@ export class PartsAsPlannedConfigurationModel extends TableFilterConfiguration { functionValidUntil: true, importState: true, importNote: true, + contractAgreementId: true, menu: false, }; diff --git a/frontend/src/assets/locales/de/common.json b/frontend/src/assets/locales/de/common.json index 3392a0067e..37ea435d04 100644 --- a/frontend/src/assets/locales/de/common.json +++ b/frontend/src/assets/locales/de/common.json @@ -69,7 +69,9 @@ "maximizeTable": "Volle Breite", "userSettings" : "Tabellen Einstellung", "uploadFile" : "Richtlinien JSON-Datei hochladen", - "downloadFile" : "Vorlage als Datei herunterladen" + "downloadFile" : "Vorlage als Datei herunterladen", + "viewParts" : "Produkte ansehen", + "viewPartsTooltip" : "Produkte mit diesem Vertrag ansehen" }, "publisher": { "selectedAssets": "Ausgewählte Produkte", @@ -175,7 +177,8 @@ "policyName" : "Richtlinienname", "bpn" : "BPN Selektion", "constraints" : "Bedingungen", - "accessType" : "Zugriffsart" + "accessType" : "Zugriffsart", + "contractAgreementId" : "Vertragsvereinbarungs-ID" } }, "dataLoading": { diff --git a/frontend/src/assets/locales/en/common.json b/frontend/src/assets/locales/en/common.json index 3538e19c9f..3ec25d26ad 100644 --- a/frontend/src/assets/locales/en/common.json +++ b/frontend/src/assets/locales/en/common.json @@ -67,7 +67,9 @@ "maximizeTable": "Full width", "userSettings" : "Table settings", "uploadFile" : "Upload policy JSON file", - "downloadFile" : "Download template as file" + "downloadFile" : "Download template as file", + "viewParts" : "View parts", + "viewPartsTooltip" : "View parts using this contract" }, "publisher": { "selectedAssets": "Assets selected", @@ -171,7 +173,8 @@ "policyName" : "Policy name", "bpn" : "BPN selection", "constraints" : "Constraints", - "accessType" : "Access type" + "accessType" : "Access type", + "contractAgreementId" : "Contract agreement ID" } }, "dataLoading": { From c50b220bfd9d6d135ac69907257b7817c3c4658c Mon Sep 17 00:00:00 2001 From: pweick Date: Mon, 24 Jun 2024 14:12:56 +0200 Subject: [PATCH 02/14] fix(OpenAPI): OpenAPI spec no longer written on every integration test - the test writing unwanted, large diffs to the spec file during every integration test has been disabled and now runs only when explicitly enabled - this is achieved by means of a flag present in the application.yaml used with profile "integration-spring-boot" - a workflow has been added which allows for controlled execution of the unwanted test in order to update the spec file --- .github/workflows/openapi-doc-check.yml | 54 +++++++++++++++++++ .../application-integration-spring-boot.yml | 3 ++ .../openapi/OpenApiDocumentationIT.java | 7 +-- 3 files changed, 61 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/openapi-doc-check.yml diff --git a/.github/workflows/openapi-doc-check.yml b/.github/workflows/openapi-doc-check.yml new file mode 100644 index 0000000000..5edf2274c9 --- /dev/null +++ b/.github/workflows/openapi-doc-check.yml @@ -0,0 +1,54 @@ +# Copyright (c) 2024 Contributors to the Eclipse Foundation +# +# See the NOTICE file(s) distributed with this work for additional +# information regarding copyright ownership. +# +# This program and the accompanying materials are made available under the +# terms of the Apache License, Version 2.0 which is available at +# https://www.apache.org/licenses/LICENSE-2.0. +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +# +# SPDX-License-Identifier: Apache-2.0 + +name: "[BE] Check if OpenApi doc is up to date" + +on: + schedule: + - cron: '0 0 * * *' # run daily at midnight + workflow_dispatch: + +jobs: + check: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up JDK + uses: actions/setup-java@v4 + with: + java-version: 17 + distribution: 'temurin' + cache: 'maven' + + - name: Update OpenApi document + run: mvn test -Dsurefire.failIfNoSpecifiedTests=false -Dtest=OpenApiDocumentationIT -Dopenapi-doc.generate=true -am + + - name: Configure Git + run: | + git config user.name "$GITHUB_ACTOR" + git config user.email "$GITHUB_ACTOR@users.noreply.github.com" + + - name: Create pull request + uses: peter-evans/create-pull-request@v6 + with: + token: ${{ secrets.GITHUB_TOKEN }} + branch: action/openapi-doc-update + title: "chore(OpenApi): updated OpenApi document for release" + labels: automated diff --git a/tx-backend/src/main/resources/application-integration-spring-boot.yml b/tx-backend/src/main/resources/application-integration-spring-boot.yml index 01de3c8a48..9a7ead9777 100644 --- a/tx-backend/src/main/resources/application-integration-spring-boot.yml +++ b/tx-backend/src/main/resources/application-integration-spring-boot.yml @@ -116,3 +116,6 @@ irs-edc-client: secret: "integration-tests" bpdm: oAuthClientId: OKTA + +openapi-doc: + generate: false diff --git a/tx-backend/src/test/java/org/eclipse/tractusx/traceability/integration/openapi/OpenApiDocumentationIT.java b/tx-backend/src/test/java/org/eclipse/tractusx/traceability/integration/openapi/OpenApiDocumentationIT.java index 33b444f2ff..34fc78d09a 100644 --- a/tx-backend/src/test/java/org/eclipse/tractusx/traceability/integration/openapi/OpenApiDocumentationIT.java +++ b/tx-backend/src/test/java/org/eclipse/tractusx/traceability/integration/openapi/OpenApiDocumentationIT.java @@ -21,6 +21,7 @@ import org.eclipse.tractusx.traceability.integration.IntegrationTestSpecification; import org.junit.jupiter.api.Test; +import org.springframework.test.context.junit.jupiter.EnabledIf; import java.io.File; import java.io.IOException; @@ -30,13 +31,14 @@ import static io.restassured.RestAssured.given; import static org.apache.commons.io.FileUtils.writeStringToFile; +@EnabledIf(expression = "${openapi-doc.generate}", loadContext = true) class OpenApiDocumentationIT extends IntegrationTestSpecification { private static final List API_DOCUMENTATION_LOCATIONS = List.of("./openapi/traceability-foss-backend.json", "../docs/api/traceability-foss-backend.json"); @Test - void shouldGenerateOpenapiDocumentation() { + void shouldGenerateOpenApiDoc() { // when var response = given() .when() @@ -48,11 +50,10 @@ void shouldGenerateOpenapiDocumentation() { API_DOCUMENTATION_LOCATIONS.forEach(location -> { try { - writeStringToFile(new File(location), response.body().print(), StandardCharsets.UTF_8); + writeStringToFile(new File(location), response.body().asPrettyString(), StandardCharsets.UTF_8); } catch (IOException e) { throw new RuntimeException(e); } }); - ; } } From d7804ab2935b34f0a9dbbd6d47f00e740ee0fa93 Mon Sep 17 00:00:00 2001 From: ds-pweick <162321742+ds-pweick@users.noreply.github.com> Date: Mon, 24 Jun 2024 12:16:26 +0000 Subject: [PATCH 03/14] [create-pull-request] automated change --- docs/api/traceability-foss-backend.json | 16004 ++++++++-------- .../openapi/traceability-foss-backend.json | 16004 ++++++++-------- 2 files changed, 16010 insertions(+), 15998 deletions(-) diff --git a/docs/api/traceability-foss-backend.json b/docs/api/traceability-foss-backend.json index 1a6732b486..371e20c363 100644 --- a/docs/api/traceability-foss-backend.json +++ b/docs/api/traceability-foss-backend.json @@ -1,8117 +1,8123 @@ { - "openapi" : "3.0.1", - "info" : { - "title" : "Tractus-X Traceability Foss", - "description" : "Trace-FOSS is a system 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. This saves costs by seamlessly tracking parts and creates trust through clearly defined and secure data access by the companies and persons involved in the process.", - "license" : { - "name" : "License: Apache 2.0" - }, - "version" : "1.0.0" - }, - "servers" : [ - { - "url" : "http://localhost:9998/api", - "description" : "Generated server url" - } - ], - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ], - "paths" : { - "/policies" : { - "get" : { - "tags" : [ - "Policies" - ], - "summary" : "Get all policies ", - "description" : "The endpoint returns all policies .", - "operationId" : "policy", - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the policies", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/IrsPolicyResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } + "openapi": "3.0.1", + "info": { + "title": "Tractus-X Traceability Foss", + "description": "Trace-FOSS is a system 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. This saves costs by seamlessly tracking parts and creates trust through clearly defined and secure data access by the companies and persons involved in the process.", + "license": { + "name": "License: Apache 2.0" }, - "security" : [ - { - "oAuth2" : [ - "profile email" + "version": "1.0.0" + }, + "servers": [ + { + "url": "http://localhost:9998/api", + "description": "Generated server url" + } + ], + "security": [ + { + "oAuth2": [ + "profile email" ] - } - ] - }, - "put" : { - "tags" : [ - "Policies" - ], - "summary" : "Updates policies ", - "description" : "The endpoint updates policies.", - "operationId" : "updatePolicy", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/UpdatePolicyRequest" - } + } + ], + "paths": { + "/policies": { + "get": { + "tags": [ + "Policies" + ], + "summary": "Get all policies ", + "description": "The endpoint returns all policies .", + "operationId": "policy", + "responses": { + "200": { + "description": "Returns the policies", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IrsPolicyResponse" + } + } + } + }, + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] + }, + "put": { + "tags": [ + "Policies" + ], + "summary": "Updates policies ", + "description": "The endpoint updates policies.", + "operationId": "updatePolicy", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdatePolicyRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Update successful", + "content": { + "application/json": { + + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] + }, + "post": { + "tags": [ + "Policies" + ], + "summary": "Create a policy ", + "description": "The endpoint creates a policy.", + "operationId": "createPolicy", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RegisterPolicyRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the policies", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePolicyResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "200" : { - "description" : "Update successful", - "content" : { - "application/json" : {} - } - }, - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/notifications/{notificationId}/edit": { + "put": { + "tags": [ + "Notifications" + ], + "summary": "Update notification by id", + "description": "The endpoint updates notification by their id.", + "operationId": "updateNotification", + "parameters": [ + { + "name": "notificationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EditNotificationRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No content." + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - }, - "post" : { - "tags" : [ - "Policies" - ], - "summary" : "Create a policy ", - "description" : "The endpoint creates a policy.", - "operationId" : "createPolicy", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/RegisterPolicyRequest" - } + "/bpn-config": { + "get": { + "tags": [ + "BpnEdcMapping" + ], + "summary": "Get BPN EDC URL mappings", + "description": "The endpoint returns a result of BPN EDC URL mappings.", + "operationId": "getBpnEdcs", + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/BpnEdcMappingResponse" + } + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] + }, + "put": { + "tags": [ + "BpnEdcMapping" + ], + "summary": "Updates BPN EDC URL mappings", + "description": "The endpoint updates BPN EDC URL mappings", + "operationId": "updateBpnEdcMappings", + "requestBody": { + "content": { + "application/json": { + "schema": { + "maxItems": 1000, + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/BpnMappingRequest" + } + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found for BpnEdcMapping", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/BpnEdcMappingResponse" + } + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] + }, + "post": { + "tags": [ + "BpnEdcMapping" + ], + "summary": "Creates BPN EDC URL mappings", + "description": "The endpoint creates BPN EDC URL mappings", + "operationId": "createBpnEdcUrlMappings", + "requestBody": { + "content": { + "application/json": { + "schema": { + "maxItems": 1000, + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/BpnMappingRequest" + } + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found for BpnEdcMapping", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/BpnEdcMappingResponse" + } + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the policies", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CreatePolicyResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/submodel/data/{submodelId}": { + "get": { + "tags": [ + "Submodel" + ], + "summary": "Gets Submodel by its id", + "description": "The endpoint returns Submodel for given id. Used for data providing functionality", + "operationId": "getSubmodelById", + "parameters": [ + { + "name": "submodelId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns submodel payload", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] + }, + "post": { + "tags": [ + "Submodel" + ], + "summary": "Save Submodel", + "description": "This endpoint allows you to save a Submodel identified by its ID.", + "operationId": "saveSubmodel", + "parameters": [ + { + "name": "submodelId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Ok." + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No Content." + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}/edit" : { - "put" : { - "tags" : [ - "Notifications" - ], - "summary" : "Update notification by id", - "description" : "The endpoint updates notification by their id.", - "operationId" : "updateNotification", - "parameters" : [ - { - "name" : "notificationId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int64" - } - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/EditNotificationRequest" - } + "/notifications": { + "post": { + "tags": [ + "Notifications" + ], + "summary": "Start notification by part ids", + "description": "The endpoint starts notification based on part ids provided.", + "operationId": "notifyAssets", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartNotificationRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Created.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationIdResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "204" : { - "description" : "No content." - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/notifications/{notificationId}/update": { + "post": { + "tags": [ + "Notifications" + ], + "summary": "Update notification by id", + "description": "The endpoint updates notification by their id.", + "operationId": "updateNotification_1", + "parameters": [ + { + "name": "notificationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateNotificationStatusTransitionRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No content." + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/bpn-config" : { - "get" : { - "tags" : [ - "BpnEdcMapping" - ], - "summary" : "Get BPN EDC URL mappings", - "description" : "The endpoint returns a result of BPN EDC URL mappings.", - "operationId" : "getBpnEdcs", - "responses" : { - "200" : { - "description" : "Returns the paged result found", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BpnEdcMappingResponse" - } - } - } - } - }, - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/notifications/{notificationId}/close": { + "post": { + "tags": [ + "Notifications" + ], + "summary": "Close notification by id", + "description": "The endpoint closes Notification by id.", + "operationId": "closeNotification", + "parameters": [ + { + "name": "notificationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CloseNotificationRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Ok." + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No content." + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - }, - "put" : { - "tags" : [ - "BpnEdcMapping" - ], - "summary" : "Updates BPN EDC URL mappings", - "description" : "The endpoint updates BPN EDC URL mappings", - "operationId" : "updateBpnEdcMappings", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 1000, - "minItems" : 0, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BpnMappingRequest" - } - } + "/notifications/{notificationId}/cancel": { + "post": { + "tags": [ + "Notifications" + ], + "summary": "Cancels notification by id", + "description": "The endpoint cancels notification by id.", + "operationId": "cancelNotification", + "parameters": [ + { + "name": "notificationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Ok." + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No content." + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the paged result found for BpnEdcMapping", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BpnEdcMappingResponse" - } - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/notifications/{notificationId}/approve": { + "post": { + "tags": [ + "Notifications" + ], + "summary": "Approves notification by id", + "description": "The endpoint approves notification by id.", + "operationId": "approveNotification", + "parameters": [ + { + "name": "notificationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Ok." + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No content." + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - }, - "post" : { - "tags" : [ - "BpnEdcMapping" - ], - "summary" : "Creates BPN EDC URL mappings", - "description" : "The endpoint creates BPN EDC URL mappings", - "operationId" : "createBpnEdcUrlMappings", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 1000, - "minItems" : 0, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BpnMappingRequest" - } - } + "/notifications/filter": { + "post": { + "tags": [ + "Notifications" + ], + "summary": "Filter notifications defined by the request body", + "description": "The endpoint returns notifications as paged result.", + "operationId": "filterNotifications", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PageableFilterRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found for Notifications", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Notifications", + "items": { + "type": "object", + "properties": { + "id": { + "maximum": 255, + "minimum": 0, + "maxLength": 255, + "type": "integer", + "format": "int64", + "example": 66 + }, + "title": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Title" + }, + "status": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "CREATED", + "enum": [ + "CREATED", + "SENT", + "RECEIVED", + "ACKNOWLEDGED", + "ACCEPTED", + "DECLINED", + "CANCELED", + "CLOSED" + ] + }, + "description": { + "maxLength": 1000, + "minLength": 0, + "type": "string", + "example": "DescriptionText" + }, + "createdBy": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003AYRE" + }, + "createdByName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "createdDate": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "example": "2023-02-21T21:27:10.734950Z" + }, + "updatedDate": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "example": "2023-02-21T21:27:10.734950Z" + }, + "assetIds": { + "maxItems": 1000, + "minItems": 0, + "type": "array", + "example": [ + "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd", + "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd", + "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd" + ], + "items": { + "type": "string", + "example": "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd\"]" + } + }, + "channel": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "SENDER", + "enum": [ + "SENDER", + "RECEIVER" + ] + }, + "sendTo": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003AYRE" + }, + "sendToName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "severity": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "MINOR", + "enum": [ + "MINOR", + "MAJOR", + "CRITICAL", + "LIFE-THREATENING" + ] + }, + "type": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "example": "ALERT", + "enum": [ + "ALERT", + "INVESTIGATION" + ] + }, + "targetDate": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "example": "2099-02-21T21:27:10.734950Z" + }, + "messages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NotificationMessageResponse" + } + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the paged result found for BpnEdcMapping", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BpnEdcMappingResponse" - } - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/edc/notification/contract": { + "post": { + "tags": [ + "Notifications" + ], + "summary": "Triggers EDC notification contract", + "description": "The endpoint Triggers EDC notification contract based on notification type and method", + "operationId": "createNotificationContract", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateNotificationContractRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Created.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateNotificationContractResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/submodel/data/{submodelId}" : { - "get" : { - "tags" : [ - "Submodel" - ], - "summary" : "Gets Submodel by its id", - "description" : "The endpoint returns Submodel for given id. Used for data providing functionality", - "operationId" : "getSubmodelById", - "parameters" : [ - { - "name" : "submodelId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "200" : { - "description" : "Returns submodel payload", - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - } - }, - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/contracts": { + "post": { + "tags": [ + "Contracts" + ], + "summary": "All contract agreements for all assets", + "description": "This endpoint returns all contract agreements for all assets in Trace-X", + "operationId": "contracts", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PageableFilterRequest" + } + } + }, + "required": true + }, + "responses": { + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "type": "string", + "example": { + "message": "Too many requests." + } + } + } + } + }, + "415": { + "description": "Unsupported media type.", + "content": { + "application/json": { + "schema": { + "type": "string", + "example": { + "message": "Unsupported media type." + } + } + } + } + }, + "200": { + "description": "Ok.", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "description": "PageResults", + "items": { + "$ref": "#/components/schemas/PageResultContractResponse" + } + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "type": "string", + "example": { + "message": "Bad request." + } + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "type": "string", + "example": { + "message": "Internal server error." + } + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "type": "string", + "example": { + "message": "Not found." + } + } + } + } + }, + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "type": "string", + "example": { + "message": "Authorization failed." + } + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "type": "string", + "example": { + "message": "Forbidden." + } + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - }, - "post" : { - "tags" : [ - "Submodel" - ], - "summary" : "Save Submodel", - "description" : "This endpoint allows you to save a Submodel identified by its ID.", - "operationId" : "saveSubmodel", - "parameters" : [ - { - "name" : "submodelId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } + "/assets/publish": { + "post": { + "tags": [ + "AssetsImport", + "AssetsPublish" + ], + "summary": "asset publish", + "description": "This endpoint publishes assets to the Catena-X network.", + "operationId": "publishAssets", + "parameters": [ + { + "name": "triggerSynchronizeAssets", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": true + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RegisterAssetRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "OK.", + "content": { + "application/json": { + + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Ok." - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "204" : { - "description" : "No Content." - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/assets/import": { + "post": { + "tags": [ + "AssetsImport" + ], + "summary": "asset upload", + "description": "This endpoint stores assets in the application. Those can be later published in the Catena-X network.", + "operationId": "importJson", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "required": [ + "file" + ], + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportResponse" + } + } + } + }, + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications" : { - "post" : { - "tags" : [ - "Notifications" - ], - "summary" : "Start notification by part ids", - "description" : "The endpoint starts notification based on part ids provided.", - "operationId" : "notifyAssets", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/StartNotificationRequest" - } + "/assets/as-planned/sync": { + "post": { + "tags": [ + "AssetsAsPlanned" + ], + "summary": "Synchronizes assets from IRS", + "description": "The endpoint synchronizes the assets from irs.", + "operationId": "sync", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SyncAssetsRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Created." + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "201" : { - "description" : "Created.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/NotificationIdResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/assets/as-planned/detail-information": { + "post": { + "tags": [ + "AssetsAsPlanned" + ], + "summary": "Searches for assets by ids.", + "description": "The endpoint searchs for assets by id and returns a list of them.", + "operationId": "getDetailInformation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetDetailInformationRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found for Asset", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}/update" : { - "post" : { - "tags" : [ - "Notifications" - ], - "summary" : "Update notification by id", - "description" : "The endpoint updates notification by their id.", - "operationId" : "updateNotification_1", - "parameters" : [ - { - "name" : "notificationId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int64" - } - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/UpdateNotificationStatusTransitionRequest" - } + "/assets/as-built/sync": { + "post": { + "tags": [ + "AssetsAsBuilt" + ], + "summary": "Synchronizes assets from IRS", + "description": "The endpoint synchronizes the assets from irs.", + "operationId": "sync_1", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SyncAssetsRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Created." + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/assets/as-built/detail-information": { + "post": { + "tags": [ + "AssetsAsBuilt" + ], + "summary": "Searches for assets by ids.", + "description": "The endpoint searchs for assets by id and returns a list of them.", + "operationId": "getDetailInformation_1", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetDetailInformationRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found for Asset", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "204" : { - "description" : "No content." - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}/close" : { - "post" : { - "tags" : [ - "Notifications" - ], - "summary" : "Close notification by id", - "description" : "The endpoint closes Notification by id.", - "operationId" : "closeNotification", - "parameters" : [ - { - "name" : "notificationId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int64" - } - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CloseNotificationRequest" - } - } - }, - "required" : true - }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Ok." - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "204" : { - "description" : "No content." - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}/cancel" : { - "post" : { - "tags" : [ - "Notifications" - ], - "summary" : "Cancels notification by id", - "description" : "The endpoint cancels notification by id.", - "operationId" : "cancelNotification", - "parameters" : [ - { - "name" : "notificationId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int64" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Ok." - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "204" : { - "description" : "No content." - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}/approve" : { - "post" : { - "tags" : [ - "Notifications" - ], - "summary" : "Approves notification by id", - "description" : "The endpoint approves notification by id.", - "operationId" : "approveNotification", - "parameters" : [ - { - "name" : "notificationId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int64" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Ok." - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "204" : { - "description" : "No content." - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications/filter" : { - "post" : { - "tags" : [ - "Notifications" - ], - "summary" : "Filter notifications defined by the request body", - "description" : "The endpoint returns notifications as paged result.", - "operationId" : "filterNotifications", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PageableFilterRequest" - } - } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the paged result found for Notifications", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Notifications", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maximum" : 255, - "minimum" : 0, - "maxLength" : 255, - "type" : "integer", - "format" : "int64", - "example" : 66 - }, - "title" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Title" - }, - "status" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "CREATED", - "enum" : [ - "CREATED", - "SENT", - "RECEIVED", - "ACKNOWLEDGED", - "ACCEPTED", - "DECLINED", - "CANCELED", - "CLOSED" - ] - }, - "description" : { - "maxLength" : 1000, - "minLength" : 0, - "type" : "string", - "example" : "DescriptionText" - }, - "createdBy" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003AYRE" - }, - "createdByName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "createdDate" : { - "maxLength" : 50, - "minLength" : 0, - "type" : "string", - "example" : "2023-02-21T21:27:10.734950Z" - }, - "updatedDate" : { - "maxLength" : 50, - "minLength" : 0, - "type" : "string", - "example" : "2023-02-21T21:27:10.734950Z" - }, - "assetIds" : { - "maxItems" : 1000, - "minItems" : 0, - "type" : "array", - "example" : [ - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd", - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd", - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd" - ], - "items" : { - "type" : "string", - "example" : "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd\"]" - } - }, - "channel" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "SENDER", - "enum" : [ - "SENDER", - "RECEIVER" - ] - }, - "sendTo" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003AYRE" - }, - "sendToName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "severity" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "MINOR", - "enum" : [ - "MINOR", - "MAJOR", - "CRITICAL", - "LIFE-THREATENING" + "/assets/as-planned/{assetId}": { + "get": { + "tags": [ + "AssetsAsPlanned" + ], + "summary": "Get asset by id", + "description": "The endpoint returns an asset filtered by id .", + "operationId": "assetById", + "parameters": [ + { + "name": "assetId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the assets found", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" ] - }, - "type" : { - "maxLength" : 50, - "minLength" : 0, - "type" : "string", - "example" : "ALERT", - "enum" : [ - "ALERT", - "INVESTIGATION" + } + ] + }, + "patch": { + "tags": [ + "AssetsAsPlanned" + ], + "summary": "Updates asset", + "description": "The endpoint updates asset by provided quality type.", + "operationId": "updateAsset", + "parameters": [ + { + "name": "assetId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateAssetRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the updated asset", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" ] - }, - "targetDate" : { - "maxLength" : 50, - "minLength" : 0, - "type" : "string", - "example" : "2099-02-21T21:27:10.734950Z" - }, - "messages" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NotificationMessageResponse" - } - } - } - } - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/edc/notification/contract" : { - "post" : { - "tags" : [ - "Notifications" - ], - "summary" : "Triggers EDC notification contract", - "description" : "The endpoint Triggers EDC notification contract based on notification type and method", - "operationId" : "createNotificationContract", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CreateNotificationContractRequest" - } + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "201" : { - "description" : "Created.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CreateNotificationContractResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/assets/as-built/{assetId}": { + "get": { + "tags": [ + "AssetsAsBuilt" + ], + "summary": "Get asset by id", + "description": "The endpoint returns an asset filtered by id .", + "operationId": "assetById_1", + "parameters": [ + { + "name": "assetId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the assets found", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] + }, + "patch": { + "tags": [ + "AssetsAsBuilt" + ], + "summary": "Updates asset", + "description": "The endpoint updates asset by provided quality type.", + "operationId": "updateAsset_1", + "parameters": [ + { + "name": "assetId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateAssetRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the updated asset", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/contracts" : { - "post" : { - "tags" : [ - "Contracts" - ], - "summary" : "All contract agreements for all assets", - "description" : "This endpoint returns all contract agreements for all assets in Trace-X", - "operationId" : "contracts", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PageableFilterRequest" - } + "/registry/reload": { + "get": { + "tags": [ + "Registry" + ], + "summary": "Triggers reload of shell descriptors", + "description": "The endpoint Triggers reload of shell descriptors.", + "operationId": "reload", + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "202": { + "description": "Created registry reload job." + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "type" : "string", - "example" : { - "message" : "Authorization failed." - } - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "type" : "string", - "example" : { - "message" : "Too many requests." - } - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "type" : "string", - "example" : { - "message" : "Internal server error." - } - } - } - } - }, - "200" : { - "description" : "Ok.", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "description" : "PageResults", - "items" : { - "$ref" : "#/components/schemas/PageResultContractResponse" - } - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "type" : "string", - "example" : { - "message" : "Forbidden." - } - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "type" : "string", - "example" : { - "message" : "Bad request." - } - } - } - } - }, - "415" : { - "description" : "Unsupported media type.", - "content" : { - "application/json" : { - "schema" : { - "type" : "string", - "example" : { - "message" : "Unsupported media type." - } - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "type" : "string", - "example" : { - "message" : "Not found." - } - } - } + "/policies/{policyId}": { + "get": { + "tags": [ + "Policies" + ], + "summary": "Gets policy by id", + "description": "The endpoint returns policy by id.", + "operationId": "getPolicyById", + "parameters": [ + { + "name": "policyId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "OK.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] + }, + "delete": { + "tags": [ + "Policies" + ], + "summary": "Deletes a policy ", + "description": "The endpoint deletes policies.", + "operationId": "deletePolicy", + "parameters": [ + { + "name": "policyId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Deletion successful", + "content": { + "application/json": { + + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/publish" : { - "post" : { - "tags" : [ - "AssetsImport", - "AssetsPublish" - ], - "summary" : "asset publish", - "description" : "This endpoint publishes assets to the Catena-X network.", - "operationId" : "publishAssets", - "parameters" : [ - { - "name" : "triggerSynchronizeAssets", - "in" : "query", - "required" : false, - "schema" : { - "type" : "boolean", - "default" : true - } - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/RegisterAssetRequest" - } + "/notifications/{notificationId}": { + "get": { + "tags": [ + "Notifications" + ], + "summary": "Gets notification by id", + "description": "The endpoint returns notification by id.", + "operationId": "getNotification", + "parameters": [ + { + "name": "notificationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "OK.", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Notifications", + "items": { + "$ref": "#/components/schemas/NotificationResponse" + } + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "200" : { - "description" : "OK.", - "content" : { - "application/json" : {} - } - }, - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "204" : { - "description" : "No Content." - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/import" : { - "post" : { - "tags" : [ - "AssetsImport" - ], - "summary" : "asset upload", - "description" : "This endpoint stores assets in the application. Those can be later published in the Catena-X network.", - "operationId" : "importJson", - "requestBody" : { - "content" : { - "multipart/form-data" : { - "schema" : { - "required" : [ - "file" + "/notifications/distinctFilterValues": { + "get": { + "tags": [ + "Notifications" ], - "type" : "object", - "properties" : { - "file" : { - "type" : "string", - "format" : "binary" - } - } - } - } - } - }, - "responses" : { - "200" : { - "description" : "OK.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ImportResponse" - } - } - } - }, - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "204" : { - "description" : "No Content." - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned/sync" : { - "post" : { - "tags" : [ - "AssetsAsPlanned" - ], - "summary" : "Synchronizes assets from IRS", - "description" : "The endpoint synchronizes the assets from irs.", - "operationId" : "sync", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/SyncAssetsRequest" - } - } - }, - "required" : true - }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "201" : { - "description" : "Created." - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned/detail-information" : { - "post" : { - "tags" : [ - "AssetsAsPlanned" - ], - "summary" : "Searches for assets by ids.", - "description" : "The endpoint searchs for assets by id and returns a list of them.", - "operationId" : "getDetailInformation", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/GetDetailInformationRequest" - } - } - }, - "required" : true - }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the paged result found for Asset", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/sync" : { - "post" : { - "tags" : [ - "AssetsAsBuilt" - ], - "summary" : "Synchronizes assets from IRS", - "description" : "The endpoint synchronizes the assets from irs.", - "operationId" : "sync_1", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/SyncAssetsRequest" - } - } - }, - "required" : true - }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "201" : { - "description" : "Created." - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/detail-information" : { - "post" : { - "tags" : [ - "AssetsAsBuilt" - ], - "summary" : "Searches for assets by ids.", - "description" : "The endpoint searchs for assets by id and returns a list of them.", - "operationId" : "getDetailInformation_1", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/GetDetailInformationRequest" - } - } - }, - "required" : true - }, - "responses" : { - "200" : { - "description" : "Returns the paged result found for Asset", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } - } - } - } - }, - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned/{assetId}" : { - "get" : { - "tags" : [ - "AssetsAsPlanned" - ], - "summary" : "Get asset by id", - "description" : "The endpoint returns an asset filtered by id .", - "operationId" : "assetById", - "parameters" : [ - { - "name" : "assetId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the assets found", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - }, - "patch" : { - "tags" : [ - "AssetsAsPlanned" - ], - "summary" : "Updates asset", - "description" : "The endpoint updates asset by provided quality type.", - "operationId" : "updateAsset", - "parameters" : [ - { - "name" : "assetId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/UpdateAssetRequest" - } - } - }, - "required" : true - }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the updated asset", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/{assetId}" : { - "get" : { - "tags" : [ - "AssetsAsBuilt" - ], - "summary" : "Get asset by id", - "description" : "The endpoint returns an asset filtered by id .", - "operationId" : "assetById_1", - "parameters" : [ - { - "name" : "assetId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the assets found", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - }, - "patch" : { - "tags" : [ - "AssetsAsBuilt" - ], - "summary" : "Updates asset", - "description" : "The endpoint updates asset by provided quality type.", - "operationId" : "updateAsset_1", - "parameters" : [ - { - "name" : "assetId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/UpdateAssetRequest" - } - } - }, - "required" : true - }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the updated asset", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/registry/reload" : { - "get" : { - "tags" : [ - "Registry" - ], - "summary" : "Triggers reload of shell descriptors", - "description" : "The endpoint Triggers reload of shell descriptors.", - "operationId" : "reload", - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "202" : { - "description" : "Created registry reload job." - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/policies/{policyId}" : { - "get" : { - "tags" : [ - "Policies" - ], - "summary" : "Gets policy by id", - "description" : "The endpoint returns policy by id.", - "operationId" : "getPolicyById", - "parameters" : [ - { - "name" : "policyId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the policies", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PolicyResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - }, - "delete" : { - "tags" : [ - "Policies" - ], - "summary" : "Deletes a policy ", - "description" : "The endpoint deletes policies.", - "operationId" : "deletePolicy", - "parameters" : [ - { - "name" : "policyId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Deletion successful", - "content" : { - "application/json" : {} - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}" : { - "get" : { - "tags" : [ - "Notifications" - ], - "summary" : "Gets notification by id", - "description" : "The endpoint returns notification by id.", - "operationId" : "getNotification", - "parameters" : [ - { - "name" : "notificationId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int64" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "OK.", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Notifications", - "items" : { - "$ref" : "#/components/schemas/NotificationResponse" - } - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications/distinctFilterValues" : { - "get" : { - "tags" : [ - "Notifications" - ], - "summary" : "getDistinctFilterValues", - "description" : "The endpoint returns a distinct filter values for given fieldName of notification.", - "operationId" : "distinctFilterValues", - "parameters" : [ - { - "name" : "fieldName", - "in" : "query", - "required" : true, - "schema" : { - "type" : "string" - } - }, - { - "name" : "size", - "in" : "query", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int32" - } - }, - { - "name" : "startWith", - "in" : "query", - "required" : true, - "schema" : { - "type" : "string" - } - }, - { - "name" : "channel", - "in" : "query", - "required" : true, - "schema" : { - "type" : "string", - "enum" : [ - "SENDER", - "RECEIVER" - ] - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns a distinct filter values for given fieldName.", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "type" : "string" - } - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/dashboard" : { - "get" : { - "tags" : [ - "Dashboard" - ], - "summary" : "Returns dashboard related data", - "description" : "The endpoint can return limited data based on the user role", - "operationId" : "dashboard", - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns dashboard data", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/DashboardResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/import/report/{importJobId}" : { - "get" : { - "tags" : [ - "ImportReport", - "AssetsImport" - ], - "summary" : "report of the imported assets", - "description" : "This endpoint returns information about the imported assets to Trace-X.", - "operationId" : "importReport", - "parameters" : [ - { - "name" : "importJobId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "204" : { - "description" : "No Content." - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "OK.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ImportReportResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned" : { - "get" : { - "tags" : [ - "AssetsAsPlanned" - ], - "summary" : "Get assets by pagination", - "description" : "The endpoint returns a paged result of assets.", - "operationId" : "AssetsAsPlanned", - "parameters" : [ - { - "name" : "pageable", - "in" : "query", - "required" : true, - "schema" : { - "$ref" : "#/components/schemas/OwnPageable" - } - }, - { - "name" : "filter", - "in" : "query", - "required" : true, - "schema" : { - "$ref" : "#/components/schemas/SearchCriteriaRequestParam" - } - } - ], - "responses" : { - "200" : { - "description" : "Returns the paged result found for Asset", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } - } - } - } - }, - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned/distinctFilterValues" : { - "get" : { - "tags" : [ - "Assets", - "AssetsAsPlanned" - ], - "summary" : "getDistinctFilterValues", - "description" : "The endpoint returns a distinct filter values for given fieldName.", - "operationId" : "distinctFilterValues_1", - "parameters" : [ - { - "name" : "fieldName", - "in" : "query", - "required" : true, - "schema" : { - "type" : "string" - } - }, - { - "name" : "size", - "in" : "query", - "required" : false, - "schema" : { - "type" : "integer", - "format" : "int32" - } - }, - { - "name" : "startWith", - "in" : "query", - "required" : false, - "schema" : { - "type" : "string" - } - }, - { - "name" : "owner", - "in" : "query", - "required" : false, - "schema" : { - "type" : "string", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - } - }, - { - "name" : "inAssetIds", - "in" : "query", - "required" : false, - "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns a distinct filter values for given fieldName.", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "type" : "string" - } - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "summary": "getDistinctFilterValues", + "description": "The endpoint returns a distinct filter values for given fieldName of notification.", + "operationId": "distinctFilterValues", + "parameters": [ + { + "name": "fieldName", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "size", + "in": "query", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "startWith", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "channel", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "SENDER", + "RECEIVER" + ] + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns a distinct filter values for given fieldName.", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned/*/children/{childId}" : { - "get" : { - "tags" : [ - "AssetsAsPlanned" - ], - "summary" : "Get asset by child id", - "description" : "The endpoint returns an asset filtered by child id.", - "operationId" : "assetByChildIdAndAssetId", - "parameters" : [ - { - "name" : "childId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/dashboard": { + "get": { + "tags": [ + "Dashboard" + ], + "summary": "Returns dashboard related data", + "description": "The endpoint can return limited data based on the user role", + "operationId": "dashboard", + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns dashboard data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DashboardResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + }, + "/assets/import/report/{importJobId}": { + "get": { + "tags": [ + "ImportReport", + "AssetsImport" + ], + "summary": "report of the imported assets", + "description": "This endpoint returns information about the imported assets to Trace-X.", + "operationId": "importReport", + "parameters": [ + { + "name": "importJobId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "OK.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportReportResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + }, + "/assets/as-planned": { + "get": { + "tags": [ + "AssetsAsPlanned" + ], + "summary": "Get assets by pagination", + "description": "The endpoint returns a paged result of assets.", + "operationId": "AssetsAsPlanned", + "parameters": [ + { + "name": "pageable", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/OwnPageable" + } + }, + { + "name": "filter", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/SearchCriteriaRequestParam" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found for Asset", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "200" : { - "description" : "Returns the asset by childId", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" + }, + "/assets/as-planned/distinctFilterValues": { + "get": { + "tags": [ + "Assets", + "AssetsAsPlanned" + ], + "summary": "getDistinctFilterValues", + "description": "The endpoint returns a distinct filter values for given fieldName.", + "operationId": "distinctFilterValues_1", + "parameters": [ + { + "name": "fieldName", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "size", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "startWith", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "owner", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + } + }, + { + "name": "inAssetIds", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns a distinct filter values for given fieldName.", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" + } + ] + } + }, + "/assets/as-planned/*/children/{childId}": { + "get": { + "tags": [ + "AssetsAsPlanned" + ], + "summary": "Get asset by child id", + "description": "The endpoint returns an asset filtered by child id.", + "operationId": "assetByChildIdAndAssetId", + "parameters": [ + { + "name": "childId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the asset by childId", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" + } + ] + } + }, + "/assets/as-built": { + "get": { + "tags": [ + "AssetsAsBuilt" + ], + "summary": "Get assets by pagination", + "description": "The endpoint returns a paged result of assets.", + "operationId": "assets", + "parameters": [ + { + "name": "pageable", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/OwnPageable" + } + }, + { + "name": "searchCriteriaRequestParam", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/SearchCriteriaRequestParam" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found for Asset", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" + } + ] + } + }, + "/assets/as-built/distinctFilterValues": { + "get": { + "tags": [ + "AssetsAsBuilt", + "Assets" + ], + "summary": "getDistinctFilterValues", + "description": "The endpoint returns a distinct filter values for given fieldName.", + "operationId": "distinctFilterValues_2", + "parameters": [ + { + "name": "fieldName", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "size", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "startWith", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "owner", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + } + }, + { + "name": "inAssetIds", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns a distinct filter values for given fieldName.", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } - } + } + ] } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + }, + "/assets/as-built/countries": { + "get": { + "tags": [ + "AssetsAsBuilt" + ], + "summary": "Get map of assets", + "description": "The endpoint returns a map for assets consumed by the map.", + "operationId": "assetsCountryMap", + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the assets found", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + }, + "/assets/as-built/*/children/{childId}": { + "get": { + "tags": [ + "AssetsAsBuilt" + ], + "summary": "Get asset by child id", + "description": "The endpoint returns an asset filtered by child id.", + "operationId": "assetByChildId", + "parameters": [ + { + "name": "childId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the asset by childId", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built" : { - "get" : { - "tags" : [ - "AssetsAsBuilt" - ], - "summary" : "Get assets by pagination", - "description" : "The endpoint returns a paged result of assets.", - "operationId" : "assets", - "parameters" : [ - { - "name" : "pageable", - "in" : "query", - "required" : true, - "schema" : { - "$ref" : "#/components/schemas/OwnPageable" + "/submodel/data": { + "delete": { + "tags": [ + "Submodel" + ], + "summary": "Delete All Submodels", + "description": "Deletes all submodels from the system.", + "operationId": "deleteSubmodels", + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Ok." + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No Content." + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - { - "name" : "searchCriteriaRequestParam", - "in" : "query", - "required" : true, - "schema" : { - "$ref" : "#/components/schemas/SearchCriteriaRequestParam" + }, + "/bpn-config/{bpn}": { + "delete": { + "tags": [ + "BpnEdcMapping" + ], + "summary": "Deletes BPN EDC URL mappings", + "description": "The endpoint deletes BPN EDC URL mappings", + "operationId": "deleteBpnEdcUrlMappings", + "parameters": [ + { + "name": "bpn", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "Deleted." + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Okay" + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + } + }, + "components": { + "schemas": { + "UpdatePolicyRequest": { + "type": "object", + "properties": { + "businessPartnerNumbers": { + "type": "array", + "items": { + "type": "string" + } + }, + "policyIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "validUntil": { + "type": "string", + "format": "date-time" + } } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "ErrorResponse": { + "type": "object", + "properties": { + "message": { + "maxLength": 1000, + "minLength": 0, + "pattern": "^.*$", + "type": "string", + "example": "Access Denied" + } } - } - } - }, - "200" : { - "description" : "Returns the paged result found for Asset", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } + }, + "EditNotificationRequest": { + "required": [ + "affectedPartIds", + "description", + "receiverBpn", + "severity" + ], + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "minLength": 1, + "type": "string", + "example": "title" + }, + "receiverBpn": { + "type": "string", + "example": "BPNL00000003CNKC" + }, + "severity": { + "type": "string", + "enum": [ + "MINOR", + "MAJOR", + "CRITICAL", + "LIFE-THREATENING" + ] + }, + "targetDate": { + "type": "string", + "format": "date-time", + "example": "2099-03-11T22:44:06.333826952Z" + }, + "description": { + "maxLength": 1000, + "minLength": 15, + "type": "string", + "example": "The description" + }, + "affectedPartIds": { + "maxLength": 50, + "minLength": 1, + "maxItems": 50, + "minItems": 1, + "type": "array", + "example": [ + "urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978" + ], + "items": { + "maxLength": 50, + "minLength": 1, + "type": "string", + "example": "[\"urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978\"]" + } + } } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "BpnMappingRequest": { + "required": [ + "bpn", + "url" + ], + "type": "object", + "properties": { + "bpn": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "url": { + "maxLength": 255, + "minLength": 0, + "type": "string" + } } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "BpnEdcMappingResponse": { + "type": "object", + "properties": { + "bpn": { + "type": "string", + "example": "BPNL00000003CSGV" + }, + "url": { + "type": "string", + "example": "https://trace-x-test-edc.dev.demo.catena-x.net/a1" + } } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "Constraint": { + "type": "object", + "properties": { + "leftOperand": { + "type": "string", + "example": "string" + }, + "operator": { + "$ref": "#/components/schemas/Operator" + }, + "odrl:rightOperand": { + "type": "string", + "example": "string" + } } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "Constraints": { + "type": "object", + "properties": { + "and": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Constraint" + } + }, + "or": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Constraint" + } + } } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "Context": { + "type": "object", + "properties": { + "odrl": { + "type": "string" + } } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/distinctFilterValues" : { - "get" : { - "tags" : [ - "AssetsAsBuilt", - "Assets" - ], - "summary" : "getDistinctFilterValues", - "description" : "The endpoint returns a distinct filter values for given fieldName.", - "operationId" : "distinctFilterValues_2", - "parameters" : [ - { - "name" : "fieldName", - "in" : "query", - "required" : true, - "schema" : { - "type" : "string" - } - }, - { - "name" : "size", - "in" : "query", - "required" : false, - "schema" : { - "type" : "integer", - "format" : "int32" - } - }, - { - "name" : "startWith", - "in" : "query", - "required" : false, - "schema" : { - "type" : "string" - } - }, - { - "name" : "owner", - "in" : "query", - "required" : false, - "schema" : { - "type" : "string", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - } - }, - { - "name" : "inAssetIds", - "in" : "query", - "required" : false, - "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "Operator": { + "type": "object", + "properties": { + "@id": { + "type": "string", + "example": "odrl:eq", + "enum": [ + "eq", + "neq", + "lt", + "gt", + "in", + "lteq", + "gteq", + "isA", + "hasPart", + "isPartOf", + "isOneOf", + "isAllOf", + "isNoneOf" + ] + } + } + }, + "Payload": { + "type": "object", + "properties": { + "@context": { + "$ref": "#/components/schemas/Context" + }, + "@id": { + "type": "string" + }, + "policy": { + "$ref": "#/components/schemas/Policy" + } } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "Permission": { + "type": "object", + "properties": { + "action": { + "type": "string", + "example": "use", + "enum": [ + "access", + "use" + ] + }, + "constraint": { + "$ref": "#/components/schemas/Constraints" + } } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "Policy": { + "type": "object", + "properties": { + "policyId": { + "type": "string", + "example": "f253718e-a270-4367-901b-9d50d9bd8462" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "validUntil": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Permission" + } + } } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "RegisterPolicyRequest": { + "type": "object", + "properties": { + "validUntil": { + "type": "string", + "format": "date-time" + }, + "businessPartnerNumber": { + "type": "string" + }, + "payload": { + "$ref": "#/components/schemas/Payload" + } } - } - } - }, - "200" : { - "description" : "Returns a distinct filter values for given fieldName.", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "type" : "string" - } + }, + "CreatePolicyResponse": { + "type": "object", + "properties": { + "policyId": { + "type": "string" + } } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "StartNotificationRequest": { + "required": [ + "receiverBpn", + "severity", + "type" + ], + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "minLength": 1, + "type": "string", + "example": "title" + }, + "affectedPartIds": { + "maxLength": 100, + "minLength": 1, + "maxItems": 50, + "minItems": 1, + "type": "array", + "example": [ + "urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978" + ], + "items": { + "maxLength": 100, + "minLength": 1, + "type": "string", + "example": "[\"urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978\"]" + } + }, + "description": { + "maxLength": 1000, + "minLength": 15, + "type": "string", + "example": "The description" + }, + "targetDate": { + "type": "string", + "format": "date-time", + "example": "2099-03-11T22:44:06.333826952Z" + }, + "severity": { + "type": "string", + "enum": [ + "MINOR", + "MAJOR", + "CRITICAL", + "LIFE-THREATENING" + ] + }, + "receiverBpn": { + "type": "string", + "example": "BPNL00000003CNKC" + }, + "type": { + "type": "string", + "example": "ALERT", + "enum": [ + "ALERT", + "INVESTIGATION" + ] + } } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "NotificationIdResponse": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + } } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "UpdateNotificationStatusTransitionRequest": { + "required": [ + "status" + ], + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The UpdateInvestigationStatus", + "enum": [ + "ACKNOWLEDGED", + "ACCEPTED", + "DECLINED" + ] + }, + "reason": { + "type": "string", + "example": "The reason." + } } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/countries" : { - "get" : { - "tags" : [ - "AssetsAsBuilt" - ], - "summary" : "Get map of assets", - "description" : "The endpoint returns a map for assets consumed by the map.", - "operationId" : "assetsCountryMap", - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "CloseNotificationRequest": { + "type": "object", + "properties": { + "reason": { + "maxLength": 1000, + "minLength": 15, + "type": "string", + "example": "The reason." + } } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "OwnPageable": { + "type": "object", + "properties": { + "page": { + "type": "integer", + "format": "int32" + }, + "size": { + "type": "integer", + "format": "int32" + }, + "sort": { + "maxItems": 2147483647, + "type": "array", + "description": "Content of Assets PageResults", + "example": "manufacturerPartId,desc", + "items": { + "type": "string" + } + } } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "PageableFilterRequest": { + "type": "object", + "properties": { + "pageAble": { + "$ref": "#/components/schemas/OwnPageable" + }, + "searchCriteria": { + "$ref": "#/components/schemas/SearchCriteriaRequestParam" + } } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "SearchCriteriaRequestParam": { + "type": "object", + "properties": { + "filter": { + "maxItems": 2147483647, + "type": "array", + "description": "Filter Criteria", + "example": "owner,EQUAL,OWN", + "items": { + "type": "string" + } + } } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "NotificationMessageResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "sentBy": { + "type": "string" + }, + "sentByName": { + "type": "string" + }, + "sendTo": { + "type": "string" + }, + "sendToName": { + "type": "string" + }, + "contractAgreementId": { + "type": "string" + }, + "notificationReferenceId": { + "type": "string" + }, + "edcNotificationId": { + "type": "string" + }, + "messageDate": { + "maxLength": 50, + "type": "string", + "example": "2023-02-21T21:27:10.734950Z" + }, + "messageId": { + "type": "string" + }, + "status": { + "type": "string", + "enum": [ + "CREATED", + "SENT", + "RECEIVED", + "ACKNOWLEDGED", + "ACCEPTED", + "DECLINED", + "CANCELED", + "CLOSED" + ] + }, + "errorMessage": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "EDC not reachable" + }, + "message": { + "type": "string" + } } - } - } - }, - "200" : { - "description" : "Returns the assets found", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "type" : "string" - } + }, + "NotificationResponse": { + "type": "object", + "properties": { + "id": { + "maximum": 255, + "minimum": 0, + "maxLength": 255, + "type": "integer", + "format": "int64", + "example": 66 + }, + "title": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Title" + }, + "status": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "CREATED", + "enum": [ + "CREATED", + "SENT", + "RECEIVED", + "ACKNOWLEDGED", + "ACCEPTED", + "DECLINED", + "CANCELED", + "CLOSED" + ] + }, + "description": { + "maxLength": 1000, + "minLength": 0, + "type": "string", + "example": "DescriptionText" + }, + "createdBy": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003AYRE" + }, + "createdByName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "createdDate": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "example": "2023-02-21T21:27:10.734950Z" + }, + "updatedDate": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "example": "2023-02-21T21:27:10.734950Z" + }, + "assetIds": { + "maxItems": 1000, + "minItems": 0, + "type": "array", + "example": [ + "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd", + "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd", + "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd" + ], + "items": { + "type": "string", + "example": "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd\"]" + } + }, + "channel": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "SENDER", + "enum": [ + "SENDER", + "RECEIVER" + ] + }, + "sendTo": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003AYRE" + }, + "sendToName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "severity": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "MINOR", + "enum": [ + "MINOR", + "MAJOR", + "CRITICAL", + "LIFE-THREATENING" + ] + }, + "type": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "example": "ALERT", + "enum": [ + "ALERT", + "INVESTIGATION" + ] + }, + "targetDate": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "example": "2099-02-21T21:27:10.734950Z" + }, + "messages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NotificationMessageResponse" + } + } } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "CreateNotificationContractRequest": { + "required": [ + "notificationMethod", + "notificationType" + ], + "type": "object", + "properties": { + "notificationType": { + "type": "string", + "enum": [ + "QUALITY_INVESTIGATION", + "QUALITY_ALERT" + ] + }, + "notificationMethod": { + "type": "string", + "enum": [ + "RECEIVE", + "UPDATE", + "RESOLVE" + ] + } } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "CreateNotificationContractResponse": { + "type": "object", + "properties": { + "notificationAssetId": { + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "accessPolicyId": { + "type": "string", + "example": "123" + }, + "contractDefinitionId": { + "type": "string", + "example": "456" + } } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/*/children/{childId}" : { - "get" : { - "tags" : [ - "AssetsAsBuilt" - ], - "summary" : "Get asset by child id", - "description" : "The endpoint returns an asset filtered by child id.", - "operationId" : "assetByChildId", - "parameters" : [ - { - "name" : "childId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "ContractResponse": { + "type": "object", + "properties": { + "contractId": { + "maxLength": 255, + "type": "string", + "example": "66" + }, + "counterpartyAddress": { + "maxLength": 255, + "type": "string", + "example": "https://trace-x-edc-e2e-a.dev.demo.catena-x.net/api/v1/dsp" + }, + "creationDate": { + "maxLength": 255, + "type": "string", + "format": "date-time", + "example": "2023-02-21T21:27:10.73495Z" + }, + "endDate": { + "maxLength": 255, + "type": "string", + "format": "date-time", + "example": "2023-02-21T21:27:10.73495Z" + }, + "state": { + "maxLength": 255, + "type": "string", + "example": "FINALIZED" + }, + "policy": { + "maxLength": 255, + "type": "string", + "example": "{\\\"@id\\\":\\\"eb0c8486-914a-4d36-84c0-b4971cbc52e4\\\",\\\"@type\\\":\\\"odrl:Set\\\",\\\"odrl:permission\\\":{\\\"odrl:target\\\":\\\"registry-asset\\\",\\\"odrl:action\\\":{\\\"odrl:type\\\":\\\"USE\\\"},\\\"odrl:constraint\\\":{\\\"odrl:or\\\":{\\\"odrl:leftOperand\\\":\\\"PURPOSE\\\",\\\"odrl:operator\\\":{\\\"@id\\\":\\\"odrl:eq\\\"},\\\"odrl:rightOperand\\\":\\\"ID 3.0 Trace\\\"}}},\\\"odrl:prohibition\\\":[],\\\"odrl:obligation\\\":[],\\\"odrl:target\\\":\\\"registry-asset\\\"}" + } } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "PageResultContractResponse": { + "type": "object", + "properties": { + "content": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "description": "Content of PageResults", + "items": { + "$ref": "#/components/schemas/ContractResponse" + } + }, + "page": { + "type": "integer", + "format": "int32", + "example": 1 + }, + "pageCount": { + "type": "integer", + "format": "int32", + "example": 15 + }, + "pageSize": { + "type": "integer", + "format": "int32", + "example": 10 + }, + "totalItems": { + "type": "integer", + "format": "int64", + "example": 2 + } } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "RegisterAssetRequest": { + "required": [ + "assetIds", + "policyId" + ], + "type": "object", + "properties": { + "policyId": { + "type": "string", + "example": "a644a7cb-3de5-493b-9259-f01db315a46e" + }, + "assetIds": { + "type": "array", + "items": { + "type": "string" + } + } } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "ImportResponse": { + "type": "object", + "properties": { + "jobId": { + "type": "string" + }, + "importStateMessage": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportStateMessage" + } + }, + "validationResult": { + "$ref": "#/components/schemas/ValidationResponse" + } } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "ImportStateMessage": { + "type": "object", + "properties": { + "catenaXId": { + "type": "string" + }, + "persistedOrUpdated": { + "type": "boolean" + } } - } - } - }, - "200" : { - "description" : "Returns the asset by childId", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } + }, + "ValidationResponse": { + "type": "object", + "properties": { + "validationErrors": { + "type": "array", + "items": { + "type": "string" + } + } } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "SyncAssetsRequest": { + "type": "object", + "properties": { + "globalAssetIds": { + "maxItems": 100, + "minItems": 1, + "type": "array", + "example": [ + "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + ], + "items": { + "type": "string", + "example": "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\"]" + } + } } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "GetDetailInformationRequest": { + "type": "object", + "properties": { + "assetIds": { + "maxLength": 50, + "minLength": 1, + "maxItems": 50, + "minItems": 1, + "type": "array", + "example": [ + "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + ], + "items": { + "maxLength": 50, + "minLength": 1, + "type": "string", + "example": "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\"]" + } + } } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/submodel/data" : { - "delete" : { - "tags" : [ - "Submodel" - ], - "summary" : "Delete All Submodels", - "description" : "Deletes all submodels from the system.", - "operationId" : "deleteSubmodels", - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "DescriptionsResponse": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:a4a26b9c-9460-4cc5-8645-85916b86adb0" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + } } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "DetailAspectDataAsBuiltResponse": { + "type": "object", + "properties": { + "partId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "95657762-59" + }, + "customerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "01697F7-65" + }, + "nameAtCustomer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Door front-left" + }, + "manufacturingCountry": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "DEU" + }, + "manufacturingDate": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "2022-02-04T13:48:54Z" + } } - } - } - }, - "200" : { - "description" : "Ok." - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "DetailAspectDataAsPlannedResponse": { + "type": "object", + "properties": { + "validityPeriodFrom": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "2022-09-26T12:43:51.079Z" + }, + "validityPeriodTo": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "20232-07-13T12:00:00.000Z" + } } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "DetailAspectDataResponse": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/DetailAspectDataAsBuiltResponse" + }, + { + "$ref": "#/components/schemas/DetailAspectDataAsPlannedResponse" + }, + { + "$ref": "#/components/schemas/PartSiteInformationAsPlannedResponse" + }, + { + "$ref": "#/components/schemas/DetailAspectDataTractionBatteryCodeResponse" + } + ] + }, + "DetailAspectDataTractionBatteryCodeResponse": { + "type": "object", + "properties": { + "productType": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "pack" + }, + "tractionBatteryCode": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "X12MCPM27KLPCLX2M2382320" + }, + "subcomponents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectDataTractionBatteryCodeSubcomponentResponse" + } + } } - } - } - }, - "204" : { - "description" : "No Content." - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "DetailAspectDataTractionBatteryCodeSubcomponentResponse": { + "type": "object", + "properties": { + "productType": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "pack" + }, + "tractionBatteryCode": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "X12MCPM27KLPCLX2M2382320" + } } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "DetailAspectModelResponse": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "PART_SITE_INFORMATION_AS_PLANNED", + "enum": [ + "AS_BUILT", + "AS_PLANNED", + "TRACTION_BATTERY_CODE", + "SINGLE_LEVEL_BOM_AS_BUILT", + "SINGLE_LEVEL_USAGE_AS_BUILT", + "SINGLE_LEVEL_BOM_AS_PLANNED", + "PART_SITE_INFORMATION_AS_PLANNED" + ] + }, + "data": { + "$ref": "#/components/schemas/DetailAspectDataResponse" + } } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "PartSiteInformationAsPlannedResponse": { + "type": "object", + "properties": { + "functionValidUntil": { + "type": "string", + "example": "2025-02-08T04:30:48.000Z" + }, + "function": { + "type": "string", + "example": "production" + }, + "functionValidFrom": { + "type": "string", + "example": "2023-10-13T14:30:45+01:00" + }, + "catenaXSiteId": { + "type": "string", + "example": "urn:uuid:0fed587c-7ab4-4597-9841-1718e9693003" + } } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/bpn-config/{bpn}" : { - "delete" : { - "tags" : [ - "BpnEdcMapping" - ], - "summary" : "Deletes BPN EDC URL mappings", - "description" : "The endpoint deletes BPN EDC URL mappings", - "operationId" : "deleteBpnEdcUrlMappings", - "parameters" : [ - { - "name" : "bpn", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "UpdateAssetRequest": { + "required": [ + "qualityType" + ], + "type": "object", + "properties": { + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + } } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "IrsPolicyResponse": { + "type": "object", + "properties": { + "validUntil": { + "type": "string", + "format": "date-time" + }, + "payload": { + "$ref": "#/components/schemas/Payload" + } + }, + "example": [ + { + "validUntil": "2025-12-12T23:59:59.999Z", + "payload": { + "@context": { + "@vocab": "https://w3id.org/edc/v0.0.1/ns/", + "edc": "https://w3id.org/edc/v0.0.1/ns/", + "cx-policy": "https://w3id.org/catenax/policy/", + "odrl": "http://www.w3.org/ns/odrl/2/" + }, + "@id": "policy-id", + "policy": { + "odrl:permission": [ + { + "odrl:action": "use", + "odrl:constraint": { + "odrl:and": [ + { + "odrl:leftOperand": "Membership", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "active" + }, + { + "odrl:leftOperand": "PURPOSE", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "ID 3.1 Trace" + } + ] + } + } + ] + } + } + } + ] + }, + "ConstraintResponse": { + "type": "object", + "properties": { + "leftOperand": { + "type": "string", + "example": "PURPOSE" + }, + "operatorTypeResponse": { + "type": "string", + "enum": [ + "EQ", + "NEQ", + "LT", + "GT", + "IN", + "LTEQ", + "GTEQ", + "ISA", + "HASPART", + "ISPARTOF", + "ISONEOF", + "ISALLOF", + "ISNONEOF" + ] + }, + "rightOperand": { + "type": "string", + "example": "ID Trace 3.1" + } } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "ConstraintsResponse": { + "type": "object", + "properties": { + "and": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConstraintResponse" + } + }, + "or": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConstraintResponse" + } + } } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "PermissionResponse": { + "type": "object", + "properties": { + "action": { + "type": "string", + "example": "USE", + "enum": [ + "ACCESS", + "USE" + ] + }, + "constraints": { + "$ref": "#/components/schemas/ConstraintsResponse" + } } - } - } - }, - "200" : { - "description" : "Okay" - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "PolicyResponse": { + "type": "object", + "properties": { + "policyId": { + "type": "string", + "example": "5a00bb50-0253-405f-b9f1-1a3150b9d51d" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "validUntil": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PermissionResponse" + } + }, + "businessPartnerNumber": { + "type": "string" + } } - } - } - }, - "204" : { - "description" : "Deleted." - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "DashboardResponse": { + "type": "object", + "properties": { + "asBuiltCustomerParts": { + "type": "integer", + "format": "int64", + "example": 5 + }, + "asPlannedCustomerParts": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "asBuiltSupplierParts": { + "type": "integer", + "format": "int64", + "example": 2 + }, + "asPlannedSupplierParts": { + "type": "integer", + "format": "int64", + "example": 3 + }, + "asBuiltOwnParts": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "asPlannedOwnParts": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "myPartsWithOpenAlerts": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "myPartsWithOpenInvestigations": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "supplierPartsWithOpenAlerts": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "customerPartsWithOpenAlerts": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "supplierPartsWithOpenInvestigations": { + "type": "integer", + "format": "int64", + "example": 2 + }, + "customerPartsWithOpenInvestigations": { + "type": "integer", + "format": "int64", + "example": 2 + }, + "receivedActiveAlerts": { + "type": "integer", + "format": "int64", + "example": 2 + }, + "receivedActiveInvestigations": { + "type": "integer", + "format": "int64", + "example": 2 + }, + "sentActiveAlerts": { + "type": "integer", + "format": "int64", + "example": 2 + }, + "sentActiveInvestigations": { + "type": "integer", + "format": "int64", + "example": 2 + } } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "ImportJobResponse": { + "type": "object", + "properties": { + "importJobStatus": { + "type": "string", + "enum": [ + "INITIALIZING", + "RUNNING", + "ERROR", + "COMPLETED" + ] + }, + "importId": { + "type": "string", + "example": "456a952e-05eb-40dc-a6f2-9c2cb9c1387f" + }, + "startedOn": { + "maxLength": 50, + "type": "string", + "example": "2099-02-21T21:27:10.734950Z" + }, + "completedOn": { + "maxLength": 50, + "type": "string", + "example": "2099-02-21T21:27:10.734950Z" + } + } + }, + "ImportReportResponse": { + "type": "object", + "properties": { + "importJob": { + "$ref": "#/components/schemas/ImportJobResponse" + }, + "importedAsset": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportedAssetResponse" + } + } + } + }, + "ImportedAssetResponse": { + "type": "object", + "properties": { + "importState": { + "type": "string", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "catenaxId": { + "type": "string", + "example": "urn:uuid:7eeeac86-7b69-444d-81e6-655d0f1513bd}" + }, + "importedOn": { + "maxLength": 50, + "type": "string", + "example": "2099-02-21T21:27:10.734950Z" + }, + "importMessage": { + "type": "string", + "example": "Asset created successfully in transient state." + } } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - } - }, - "components" : { - "schemas" : { - "UpdatePolicyRequest" : { - "type" : "object", - "properties" : { - "businessPartnerNumbers" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "policyIds" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "validUntil" : { - "type" : "string", - "format" : "date-time" - } - } - }, - "ErrorResponse" : { - "type" : "object", - "properties" : { - "message" : { - "maxLength" : 1000, - "minLength" : 0, - "pattern" : "^.*$", - "type" : "string", - "example" : "Access Denied" - } - } - }, - "EditNotificationRequest" : { - "required" : [ - "affectedPartIds", - "description", - "receiverBpn", - "severity" - ], - "type" : "object", - "properties" : { - "title" : { - "maxLength" : 255, - "minLength" : 1, - "type" : "string", - "example" : "title" - }, - "receiverBpn" : { - "type" : "string", - "example" : "BPNL00000003CNKC" - }, - "severity" : { - "type" : "string", - "enum" : [ - "MINOR", - "MAJOR", - "CRITICAL", - "LIFE-THREATENING" - ] - }, - "targetDate" : { - "type" : "string", - "format" : "date-time", - "example" : "2099-03-11T22:44:06.333826952Z" - }, - "description" : { - "maxLength" : 1000, - "minLength" : 15, - "type" : "string", - "example" : "The description" - }, - "affectedPartIds" : { - "maxLength" : 50, - "minLength" : 1, - "maxItems" : 50, - "minItems" : 1, - "type" : "array", - "example" : [ - "urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978" - ], - "items" : { - "maxLength" : 50, - "minLength" : 1, - "type" : "string", - "example" : "[\"urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978\"]" - } - } - } - }, - "BpnMappingRequest" : { - "required" : [ - "bpn", - "url" - ], - "type" : "object", - "properties" : { - "bpn" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "url" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string" - } - } - }, - "BpnEdcMappingResponse" : { - "type" : "object", - "properties" : { - "bpn" : { - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "url" : { - "type" : "string", - "example" : "https://trace-x-test-edc.dev.demo.catena-x.net/a1" - } - } - }, - "Constraint" : { - "type" : "object", - "properties" : { - "leftOperand" : { - "type" : "string", - "example" : "string" - }, - "operator" : { - "$ref" : "#/components/schemas/Operator" - }, - "odrl:rightOperand" : { - "type" : "string", - "example" : "string" - } - } - }, - "Constraints" : { - "type" : "object", - "properties" : { - "and" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Constraint" - } - }, - "or" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Constraint" - } - } - } - }, - "Context" : { - "type" : "object", - "properties" : { - "odrl" : { - "type" : "string" - } - } - }, - "Operator" : { - "type" : "object", - "properties" : { - "@id" : { - "type" : "string", - "example" : "odrl:eq", - "enum" : [ - "eq", - "neq", - "lt", - "gt", - "in", - "lteq", - "gteq", - "isA", - "hasPart", - "isPartOf", - "isOneOf", - "isAllOf", - "isNoneOf" - ] - } - } - }, - "Payload" : { - "type" : "object", - "properties" : { - "@context" : { - "$ref" : "#/components/schemas/Context" - }, - "@id" : { - "type" : "string" - }, - "policy" : { - "$ref" : "#/components/schemas/Policy" - } - } - }, - "Permission" : { - "type" : "object", - "properties" : { - "action" : { - "type" : "string", - "example" : "use", - "enum" : [ - "access", - "use" - ] - }, - "constraint" : { - "$ref" : "#/components/schemas/Constraints" - } - } - }, - "Policy" : { - "type" : "object", - "properties" : { - "policyId" : { - "type" : "string", - "example" : "f253718e-a270-4367-901b-9d50d9bd8462" - }, - "createdOn" : { - "type" : "string", - "format" : "date-time" - }, - "validUntil" : { - "type" : "string", - "format" : "date-time" - }, - "permissions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Permission" - } - } - } - }, - "RegisterPolicyRequest" : { - "type" : "object", - "properties" : { - "validUntil" : { - "type" : "string", - "format" : "date-time" - }, - "businessPartnerNumber" : { - "type" : "string" - }, - "payload" : { - "$ref" : "#/components/schemas/Payload" - } - } - }, - "CreatePolicyResponse" : { - "type" : "object", - "properties" : { - "policyId" : { - "type" : "string" - } - } - }, - "StartNotificationRequest" : { - "required" : [ - "receiverBpn", - "severity", - "type" - ], - "type" : "object", - "properties" : { - "title" : { - "maxLength" : 255, - "minLength" : 1, - "type" : "string", - "example" : "title" - }, - "affectedPartIds" : { - "maxLength" : 100, - "minLength" : 1, - "maxItems" : 50, - "minItems" : 1, - "type" : "array", - "example" : [ - "urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978" - ], - "items" : { - "maxLength" : 100, - "minLength" : 1, - "type" : "string", - "example" : "[\"urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978\"]" - } - }, - "description" : { - "maxLength" : 1000, - "minLength" : 15, - "type" : "string", - "example" : "The description" - }, - "targetDate" : { - "type" : "string", - "format" : "date-time", - "example" : "2099-03-11T22:44:06.333826952Z" - }, - "severity" : { - "type" : "string", - "enum" : [ - "MINOR", - "MAJOR", - "CRITICAL", - "LIFE-THREATENING" - ] - }, - "receiverBpn" : { - "type" : "string", - "example" : "BPNL00000003CNKC" - }, - "type" : { - "type" : "string", - "example" : "ALERT", - "enum" : [ - "ALERT", - "INVESTIGATION" - ] - } - } - }, - "NotificationIdResponse" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - } - }, - "UpdateNotificationStatusTransitionRequest" : { - "required" : [ - "status" - ], - "type" : "object", - "properties" : { - "status" : { - "type" : "string", - "description" : "The UpdateInvestigationStatus", - "enum" : [ - "ACKNOWLEDGED", - "ACCEPTED", - "DECLINED" - ] - }, - "reason" : { - "type" : "string", - "example" : "The reason." - } - } - }, - "CloseNotificationRequest" : { - "type" : "object", - "properties" : { - "reason" : { - "maxLength" : 1000, - "minLength" : 15, - "type" : "string", - "example" : "The reason." - } - } - }, - "OwnPageable" : { - "type" : "object", - "properties" : { - "page" : { - "type" : "integer", - "format" : "int32" - }, - "size" : { - "type" : "integer", - "format" : "int32" - }, - "sort" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Content of Assets PageResults", - "example" : "manufacturerPartId,desc", - "items" : { - "type" : "string" - } - } - } - }, - "PageableFilterRequest" : { - "type" : "object", - "properties" : { - "pageAble" : { - "$ref" : "#/components/schemas/OwnPageable" - }, - "searchCriteria" : { - "$ref" : "#/components/schemas/SearchCriteriaRequestParam" - } - } - }, - "SearchCriteriaRequestParam" : { - "type" : "object", - "properties" : { - "filter" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Filter Criteria", - "example" : "owner,EQUAL,OWN", - "items" : { - "type" : "string" - } - } - } - }, - "NotificationMessageResponse" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "sentBy" : { - "type" : "string" - }, - "sentByName" : { - "type" : "string" - }, - "sendTo" : { - "type" : "string" - }, - "sendToName" : { - "type" : "string" - }, - "contractAgreementId" : { - "type" : "string" - }, - "notificationReferenceId" : { - "type" : "string" - }, - "edcNotificationId" : { - "type" : "string" - }, - "messageDate" : { - "maxLength" : 50, - "type" : "string", - "example" : "2023-02-21T21:27:10.734950Z" - }, - "messageId" : { - "type" : "string" - }, - "status" : { - "type" : "string", - "enum" : [ - "CREATED", - "SENT", - "RECEIVED", - "ACKNOWLEDGED", - "ACCEPTED", - "DECLINED", - "CANCELED", - "CLOSED" - ] - }, - "errorMessage" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "EDC not reachable" - }, - "message" : { - "type" : "string" - } - } - }, - "NotificationResponse" : { - "type" : "object", - "properties" : { - "id" : { - "maximum" : 255, - "minimum" : 0, - "maxLength" : 255, - "type" : "integer", - "format" : "int64", - "example" : 66 - }, - "title" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Title" - }, - "status" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "CREATED", - "enum" : [ - "CREATED", - "SENT", - "RECEIVED", - "ACKNOWLEDGED", - "ACCEPTED", - "DECLINED", - "CANCELED", - "CLOSED" - ] - }, - "description" : { - "maxLength" : 1000, - "minLength" : 0, - "type" : "string", - "example" : "DescriptionText" - }, - "createdBy" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003AYRE" - }, - "createdByName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "createdDate" : { - "maxLength" : 50, - "minLength" : 0, - "type" : "string", - "example" : "2023-02-21T21:27:10.734950Z" - }, - "updatedDate" : { - "maxLength" : 50, - "minLength" : 0, - "type" : "string", - "example" : "2023-02-21T21:27:10.734950Z" - }, - "assetIds" : { - "maxItems" : 1000, - "minItems" : 0, - "type" : "array", - "example" : [ - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd", - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd", - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd" - ], - "items" : { - "type" : "string", - "example" : "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd\"]" - } - }, - "channel" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "SENDER", - "enum" : [ - "SENDER", - "RECEIVER" - ] - }, - "sendTo" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003AYRE" - }, - "sendToName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "severity" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "MINOR", - "enum" : [ - "MINOR", - "MAJOR", - "CRITICAL", - "LIFE-THREATENING" - ] - }, - "type" : { - "maxLength" : 50, - "minLength" : 0, - "type" : "string", - "example" : "ALERT", - "enum" : [ - "ALERT", - "INVESTIGATION" - ] - }, - "targetDate" : { - "maxLength" : 50, - "minLength" : 0, - "type" : "string", - "example" : "2099-02-21T21:27:10.734950Z" - }, - "messages" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NotificationMessageResponse" - } - } - } - }, - "CreateNotificationContractRequest" : { - "required" : [ - "notificationMethod", - "notificationType" - ], - "type" : "object", - "properties" : { - "notificationType" : { - "type" : "string", - "enum" : [ - "QUALITY_INVESTIGATION", - "QUALITY_ALERT" - ] - }, - "notificationMethod" : { - "type" : "string", - "enum" : [ - "RECEIVE", - "UPDATE", - "RESOLVE" - ] - } - } - }, - "CreateNotificationContractResponse" : { - "type" : "object", - "properties" : { - "notificationAssetId" : { - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "accessPolicyId" : { - "type" : "string", - "example" : "123" - }, - "contractDefinitionId" : { - "type" : "string", - "example" : "456" - } - } - }, - "ContractResponse" : { - "type" : "object", - "properties" : { - "contractId" : { - "maxLength" : 255, - "type" : "string", - "example" : "66" - }, - "counterpartyAddress" : { - "maxLength" : 255, - "type" : "string", - "example" : "https://trace-x-edc-e2e-a.dev.demo.catena-x.net/api/v1/dsp" - }, - "creationDate" : { - "maxLength" : 255, - "type" : "string", - "format" : "date-time", - "example" : "2023-02-21T21:27:10.73495Z" - }, - "endDate" : { - "maxLength" : 255, - "type" : "string", - "format" : "date-time", - "example" : "2023-02-21T21:27:10.73495Z" - }, - "state" : { - "maxLength" : 255, - "type" : "string", - "example" : "FINALIZED" - }, - "policy" : { - "maxLength" : 255, - "type" : "string", - "example" : "{\\\"@id\\\":\\\"eb0c8486-914a-4d36-84c0-b4971cbc52e4\\\",\\\"@type\\\":\\\"odrl:Set\\\",\\\"odrl:permission\\\":{\\\"odrl:target\\\":\\\"registry-asset\\\",\\\"odrl:action\\\":{\\\"odrl:type\\\":\\\"USE\\\"},\\\"odrl:constraint\\\":{\\\"odrl:or\\\":{\\\"odrl:leftOperand\\\":\\\"PURPOSE\\\",\\\"odrl:operator\\\":{\\\"@id\\\":\\\"odrl:eq\\\"},\\\"odrl:rightOperand\\\":\\\"ID 3.0 Trace\\\"}}},\\\"odrl:prohibition\\\":[],\\\"odrl:obligation\\\":[],\\\"odrl:target\\\":\\\"registry-asset\\\"}" - } - } - }, - "PageResultContractResponse" : { - "type" : "object", - "properties" : { - "content" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "description" : "Content of PageResults", - "items" : { - "$ref" : "#/components/schemas/ContractResponse" - } - }, - "page" : { - "type" : "integer", - "format" : "int32", - "example" : 1 - }, - "pageCount" : { - "type" : "integer", - "format" : "int32", - "example" : 15 - }, - "pageSize" : { - "type" : "integer", - "format" : "int32", - "example" : 10 - }, - "totalItems" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - } - }, - "RegisterAssetRequest" : { - "required" : [ - "assetIds", - "policyId" - ], - "type" : "object", - "properties" : { - "policyId" : { - "type" : "string", - "example" : "a644a7cb-3de5-493b-9259-f01db315a46e" - }, - "assetIds" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - }, - "ImportResponse" : { - "type" : "object", - "properties" : { - "jobId" : { - "type" : "string" - }, - "importStateMessage" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ImportStateMessage" - } - }, - "validationResult" : { - "$ref" : "#/components/schemas/ValidationResponse" - } - } - }, - "ImportStateMessage" : { - "type" : "object", - "properties" : { - "catenaXId" : { - "type" : "string" - }, - "persistedOrUpdated" : { - "type" : "boolean" - } - } - }, - "ValidationResponse" : { - "type" : "object", - "properties" : { - "validationErrors" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - }, - "SyncAssetsRequest" : { - "type" : "object", - "properties" : { - "globalAssetIds" : { - "maxItems" : 100, - "minItems" : 1, - "type" : "array", - "example" : [ - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - ], - "items" : { - "type" : "string", - "example" : "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\"]" - } - } - } - }, - "GetDetailInformationRequest" : { - "type" : "object", - "properties" : { - "assetIds" : { - "maxLength" : 50, - "minLength" : 1, - "maxItems" : 50, - "minItems" : 1, - "type" : "array", - "example" : [ - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - ], - "items" : { - "maxLength" : 50, - "minLength" : 1, - "type" : "string", - "example" : "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\"]" - } - } - } - }, - "DescriptionsResponse" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:a4a26b9c-9460-4cc5-8645-85916b86adb0" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - } - } - }, - "DetailAspectDataAsBuiltResponse" : { - "type" : "object", - "properties" : { - "partId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "95657762-59" - }, - "customerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "01697F7-65" - }, - "nameAtCustomer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Door front-left" - }, - "manufacturingCountry" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "DEU" - }, - "manufacturingDate" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "2022-02-04T13:48:54Z" - } - } - }, - "DetailAspectDataAsPlannedResponse" : { - "type" : "object", - "properties" : { - "validityPeriodFrom" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "2022-09-26T12:43:51.079Z" - }, - "validityPeriodTo" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "20232-07-13T12:00:00.000Z" - } - } - }, - "DetailAspectDataResponse" : { - "type" : "object", - "oneOf" : [ - { - "$ref" : "#/components/schemas/DetailAspectDataAsBuiltResponse" - }, - { - "$ref" : "#/components/schemas/DetailAspectDataAsPlannedResponse" - }, - { - "$ref" : "#/components/schemas/PartSiteInformationAsPlannedResponse" - }, - { - "$ref" : "#/components/schemas/DetailAspectDataTractionBatteryCodeResponse" - } - ] - }, - "DetailAspectDataTractionBatteryCodeResponse" : { - "type" : "object", - "properties" : { - "productType" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "pack" - }, - "tractionBatteryCode" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "X12MCPM27KLPCLX2M2382320" - }, - "subcomponents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectDataTractionBatteryCodeSubcomponentResponse" } - } - } - }, - "DetailAspectDataTractionBatteryCodeSubcomponentResponse" : { - "type" : "object", - "properties" : { - "productType" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "pack" - }, - "tractionBatteryCode" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "X12MCPM27KLPCLX2M2382320" - } - } - }, - "DetailAspectModelResponse" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "example" : "PART_SITE_INFORMATION_AS_PLANNED", - "enum" : [ - "AS_BUILT", - "AS_PLANNED", - "TRACTION_BATTERY_CODE", - "SINGLE_LEVEL_BOM_AS_BUILT", - "SINGLE_LEVEL_USAGE_AS_BUILT", - "SINGLE_LEVEL_BOM_AS_PLANNED", - "PART_SITE_INFORMATION_AS_PLANNED" - ] - }, - "data" : { - "$ref" : "#/components/schemas/DetailAspectDataResponse" - } - } - }, - "PartSiteInformationAsPlannedResponse" : { - "type" : "object", - "properties" : { - "functionValidUntil" : { - "type" : "string", - "example" : "2025-02-08T04:30:48.000Z" - }, - "function" : { - "type" : "string", - "example" : "production" - }, - "functionValidFrom" : { - "type" : "string", - "example" : "2023-10-13T14:30:45+01:00" - }, - "catenaXSiteId" : { - "type" : "string", - "example" : "urn:uuid:0fed587c-7ab4-4597-9841-1718e9693003" - } - } - }, - "UpdateAssetRequest" : { - "required" : [ - "qualityType" - ], - "type" : "object", - "properties" : { - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - } - } - }, - "IrsPolicyResponse" : { - "type" : "object", - "properties" : { - "validUntil" : { - "type" : "string", - "format" : "date-time" - }, - "payload" : { - "$ref" : "#/components/schemas/Payload" - } }, - "example" : [ - { - "validUntil" : "2025-12-12T23:59:59.999Z", - "payload" : { - "@context" : { - "@vocab" : "https://w3id.org/edc/v0.0.1/ns/", - "edc" : "https://w3id.org/edc/v0.0.1/ns/", - "cx-policy" : "https://w3id.org/catenax/policy/", - "odrl" : "http://www.w3.org/ns/odrl/2/" - }, - "@id" : "policy-id", - "policy" : { - "odrl:permission" : [ - { - "odrl:action" : "use", - "odrl:constraint" : { - "odrl:and" : [ - { - "odrl:leftOperand" : "Membership", - "odrl:operator" : { - "@id" : "odrl:eq" - }, - "odrl:rightOperand" : "active" - }, - { - "odrl:leftOperand" : "PURPOSE", - "odrl:operator" : { - "@id" : "odrl:eq" - }, - "odrl:rightOperand" : "ID 3.1 Trace" - } - ] - } - } - ] - } - } - } - ] - }, - "ConstraintResponse" : { - "type" : "object", - "properties" : { - "leftOperand" : { - "type" : "string", - "example" : "PURPOSE" - }, - "operatorTypeResponse" : { - "type" : "string", - "enum" : [ - "EQ", - "NEQ", - "LT", - "GT", - "IN", - "LTEQ", - "GTEQ", - "ISA", - "HASPART", - "ISPARTOF", - "ISONEOF", - "ISALLOF", - "ISNONEOF" - ] - }, - "rightOperand" : { - "type" : "string", - "example" : "ID Trace 3.1" - } - } - }, - "ConstraintsResponse" : { - "type" : "object", - "properties" : { - "and" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ConstraintResponse" - } - }, - "or" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ConstraintResponse" - } - } - } - }, - "PermissionResponse" : { - "type" : "object", - "properties" : { - "action" : { - "type" : "string", - "example" : "USE", - "enum" : [ - "ACCESS", - "USE" - ] - }, - "constraints" : { - "$ref" : "#/components/schemas/ConstraintsResponse" - } - } - }, - "PolicyResponse" : { - "type" : "object", - "properties" : { - "policyId" : { - "type" : "string", - "example" : "5a00bb50-0253-405f-b9f1-1a3150b9d51d" - }, - "createdOn" : { - "type" : "string", - "format" : "date-time" - }, - "validUntil" : { - "type" : "string", - "format" : "date-time" - }, - "permissions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PermissionResponse" - } - }, - "businessPartnerNumber" : { - "type" : "string" - } - } - }, - "DashboardResponse" : { - "type" : "object", - "properties" : { - "asBuiltCustomerParts" : { - "type" : "integer", - "format" : "int64", - "example" : 5 - }, - "asPlannedCustomerParts" : { - "type" : "integer", - "format" : "int64", - "example" : 10 - }, - "asBuiltSupplierParts" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - }, - "asPlannedSupplierParts" : { - "type" : "integer", - "format" : "int64", - "example" : 3 - }, - "asBuiltOwnParts" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - }, - "asPlannedOwnParts" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - }, - "myPartsWithOpenAlerts" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - }, - "myPartsWithOpenInvestigations" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - }, - "supplierPartsWithOpenAlerts" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - }, - "customerPartsWithOpenAlerts" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - }, - "supplierPartsWithOpenInvestigations" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - }, - "customerPartsWithOpenInvestigations" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - }, - "receivedActiveAlerts" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - }, - "receivedActiveInvestigations" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - }, - "sentActiveAlerts" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - }, - "sentActiveInvestigations" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - } - }, - "ImportJobResponse" : { - "type" : "object", - "properties" : { - "importJobStatus" : { - "type" : "string", - "enum" : [ - "INITIALIZING", - "RUNNING", - "ERROR", - "COMPLETED" - ] - }, - "importId" : { - "type" : "string", - "example" : "456a952e-05eb-40dc-a6f2-9c2cb9c1387f" - }, - "startedOn" : { - "maxLength" : 50, - "type" : "string", - "example" : "2099-02-21T21:27:10.734950Z" - }, - "completedOn" : { - "maxLength" : 50, - "type" : "string", - "example" : "2099-02-21T21:27:10.734950Z" - } - } - }, - "ImportReportResponse" : { - "type" : "object", - "properties" : { - "importJob" : { - "$ref" : "#/components/schemas/ImportJobResponse" - }, - "importedAsset" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ImportedAssetResponse" - } - } - } - }, - "ImportedAssetResponse" : { - "type" : "object", - "properties" : { - "importState" : { - "type" : "string", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "catenaxId" : { - "type" : "string", - "example" : "urn:uuid:7eeeac86-7b69-444d-81e6-655d0f1513bd}" - }, - "importedOn" : { - "maxLength" : 50, - "type" : "string", - "example" : "2099-02-21T21:27:10.734950Z" - }, - "importMessage" : { - "type" : "string", - "example" : "Asset created successfully in transient state." - } - } - } - }, - "securitySchemes" : { - "oAuth2" : { - "type" : "oauth2", - "flows" : { - "clientCredentials" : { - "tokenUrl" : "https://example.com/api/oauth/token", - "scopes" : { - "profile email" : "" + "securitySchemes": { + "oAuth2": { + "type": "oauth2", + "flows": { + "clientCredentials": { + "tokenUrl": "https://example.com/api/oauth/token", + "scopes": { + "profile email": "" + } + } + } } - } } - } } - } -} +} \ No newline at end of file diff --git a/tx-backend/openapi/traceability-foss-backend.json b/tx-backend/openapi/traceability-foss-backend.json index 1a6732b486..371e20c363 100644 --- a/tx-backend/openapi/traceability-foss-backend.json +++ b/tx-backend/openapi/traceability-foss-backend.json @@ -1,8117 +1,8123 @@ { - "openapi" : "3.0.1", - "info" : { - "title" : "Tractus-X Traceability Foss", - "description" : "Trace-FOSS is a system 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. This saves costs by seamlessly tracking parts and creates trust through clearly defined and secure data access by the companies and persons involved in the process.", - "license" : { - "name" : "License: Apache 2.0" - }, - "version" : "1.0.0" - }, - "servers" : [ - { - "url" : "http://localhost:9998/api", - "description" : "Generated server url" - } - ], - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ], - "paths" : { - "/policies" : { - "get" : { - "tags" : [ - "Policies" - ], - "summary" : "Get all policies ", - "description" : "The endpoint returns all policies .", - "operationId" : "policy", - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the policies", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/IrsPolicyResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } + "openapi": "3.0.1", + "info": { + "title": "Tractus-X Traceability Foss", + "description": "Trace-FOSS is a system 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. This saves costs by seamlessly tracking parts and creates trust through clearly defined and secure data access by the companies and persons involved in the process.", + "license": { + "name": "License: Apache 2.0" }, - "security" : [ - { - "oAuth2" : [ - "profile email" + "version": "1.0.0" + }, + "servers": [ + { + "url": "http://localhost:9998/api", + "description": "Generated server url" + } + ], + "security": [ + { + "oAuth2": [ + "profile email" ] - } - ] - }, - "put" : { - "tags" : [ - "Policies" - ], - "summary" : "Updates policies ", - "description" : "The endpoint updates policies.", - "operationId" : "updatePolicy", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/UpdatePolicyRequest" - } + } + ], + "paths": { + "/policies": { + "get": { + "tags": [ + "Policies" + ], + "summary": "Get all policies ", + "description": "The endpoint returns all policies .", + "operationId": "policy", + "responses": { + "200": { + "description": "Returns the policies", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IrsPolicyResponse" + } + } + } + }, + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] + }, + "put": { + "tags": [ + "Policies" + ], + "summary": "Updates policies ", + "description": "The endpoint updates policies.", + "operationId": "updatePolicy", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdatePolicyRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Update successful", + "content": { + "application/json": { + + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] + }, + "post": { + "tags": [ + "Policies" + ], + "summary": "Create a policy ", + "description": "The endpoint creates a policy.", + "operationId": "createPolicy", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RegisterPolicyRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the policies", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePolicyResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "200" : { - "description" : "Update successful", - "content" : { - "application/json" : {} - } - }, - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/notifications/{notificationId}/edit": { + "put": { + "tags": [ + "Notifications" + ], + "summary": "Update notification by id", + "description": "The endpoint updates notification by their id.", + "operationId": "updateNotification", + "parameters": [ + { + "name": "notificationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EditNotificationRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No content." + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - }, - "post" : { - "tags" : [ - "Policies" - ], - "summary" : "Create a policy ", - "description" : "The endpoint creates a policy.", - "operationId" : "createPolicy", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/RegisterPolicyRequest" - } + "/bpn-config": { + "get": { + "tags": [ + "BpnEdcMapping" + ], + "summary": "Get BPN EDC URL mappings", + "description": "The endpoint returns a result of BPN EDC URL mappings.", + "operationId": "getBpnEdcs", + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/BpnEdcMappingResponse" + } + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] + }, + "put": { + "tags": [ + "BpnEdcMapping" + ], + "summary": "Updates BPN EDC URL mappings", + "description": "The endpoint updates BPN EDC URL mappings", + "operationId": "updateBpnEdcMappings", + "requestBody": { + "content": { + "application/json": { + "schema": { + "maxItems": 1000, + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/BpnMappingRequest" + } + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found for BpnEdcMapping", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/BpnEdcMappingResponse" + } + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] + }, + "post": { + "tags": [ + "BpnEdcMapping" + ], + "summary": "Creates BPN EDC URL mappings", + "description": "The endpoint creates BPN EDC URL mappings", + "operationId": "createBpnEdcUrlMappings", + "requestBody": { + "content": { + "application/json": { + "schema": { + "maxItems": 1000, + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/BpnMappingRequest" + } + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found for BpnEdcMapping", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/BpnEdcMappingResponse" + } + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the policies", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CreatePolicyResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/submodel/data/{submodelId}": { + "get": { + "tags": [ + "Submodel" + ], + "summary": "Gets Submodel by its id", + "description": "The endpoint returns Submodel for given id. Used for data providing functionality", + "operationId": "getSubmodelById", + "parameters": [ + { + "name": "submodelId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns submodel payload", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] + }, + "post": { + "tags": [ + "Submodel" + ], + "summary": "Save Submodel", + "description": "This endpoint allows you to save a Submodel identified by its ID.", + "operationId": "saveSubmodel", + "parameters": [ + { + "name": "submodelId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Ok." + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No Content." + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}/edit" : { - "put" : { - "tags" : [ - "Notifications" - ], - "summary" : "Update notification by id", - "description" : "The endpoint updates notification by their id.", - "operationId" : "updateNotification", - "parameters" : [ - { - "name" : "notificationId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int64" - } - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/EditNotificationRequest" - } + "/notifications": { + "post": { + "tags": [ + "Notifications" + ], + "summary": "Start notification by part ids", + "description": "The endpoint starts notification based on part ids provided.", + "operationId": "notifyAssets", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartNotificationRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Created.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationIdResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "204" : { - "description" : "No content." - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/notifications/{notificationId}/update": { + "post": { + "tags": [ + "Notifications" + ], + "summary": "Update notification by id", + "description": "The endpoint updates notification by their id.", + "operationId": "updateNotification_1", + "parameters": [ + { + "name": "notificationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateNotificationStatusTransitionRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No content." + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/bpn-config" : { - "get" : { - "tags" : [ - "BpnEdcMapping" - ], - "summary" : "Get BPN EDC URL mappings", - "description" : "The endpoint returns a result of BPN EDC URL mappings.", - "operationId" : "getBpnEdcs", - "responses" : { - "200" : { - "description" : "Returns the paged result found", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BpnEdcMappingResponse" - } - } - } - } - }, - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/notifications/{notificationId}/close": { + "post": { + "tags": [ + "Notifications" + ], + "summary": "Close notification by id", + "description": "The endpoint closes Notification by id.", + "operationId": "closeNotification", + "parameters": [ + { + "name": "notificationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CloseNotificationRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Ok." + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No content." + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - }, - "put" : { - "tags" : [ - "BpnEdcMapping" - ], - "summary" : "Updates BPN EDC URL mappings", - "description" : "The endpoint updates BPN EDC URL mappings", - "operationId" : "updateBpnEdcMappings", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 1000, - "minItems" : 0, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BpnMappingRequest" - } - } + "/notifications/{notificationId}/cancel": { + "post": { + "tags": [ + "Notifications" + ], + "summary": "Cancels notification by id", + "description": "The endpoint cancels notification by id.", + "operationId": "cancelNotification", + "parameters": [ + { + "name": "notificationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Ok." + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No content." + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the paged result found for BpnEdcMapping", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BpnEdcMappingResponse" - } - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/notifications/{notificationId}/approve": { + "post": { + "tags": [ + "Notifications" + ], + "summary": "Approves notification by id", + "description": "The endpoint approves notification by id.", + "operationId": "approveNotification", + "parameters": [ + { + "name": "notificationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Ok." + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No content." + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - }, - "post" : { - "tags" : [ - "BpnEdcMapping" - ], - "summary" : "Creates BPN EDC URL mappings", - "description" : "The endpoint creates BPN EDC URL mappings", - "operationId" : "createBpnEdcUrlMappings", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 1000, - "minItems" : 0, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BpnMappingRequest" - } - } + "/notifications/filter": { + "post": { + "tags": [ + "Notifications" + ], + "summary": "Filter notifications defined by the request body", + "description": "The endpoint returns notifications as paged result.", + "operationId": "filterNotifications", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PageableFilterRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found for Notifications", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Notifications", + "items": { + "type": "object", + "properties": { + "id": { + "maximum": 255, + "minimum": 0, + "maxLength": 255, + "type": "integer", + "format": "int64", + "example": 66 + }, + "title": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Title" + }, + "status": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "CREATED", + "enum": [ + "CREATED", + "SENT", + "RECEIVED", + "ACKNOWLEDGED", + "ACCEPTED", + "DECLINED", + "CANCELED", + "CLOSED" + ] + }, + "description": { + "maxLength": 1000, + "minLength": 0, + "type": "string", + "example": "DescriptionText" + }, + "createdBy": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003AYRE" + }, + "createdByName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "createdDate": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "example": "2023-02-21T21:27:10.734950Z" + }, + "updatedDate": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "example": "2023-02-21T21:27:10.734950Z" + }, + "assetIds": { + "maxItems": 1000, + "minItems": 0, + "type": "array", + "example": [ + "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd", + "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd", + "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd" + ], + "items": { + "type": "string", + "example": "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd\"]" + } + }, + "channel": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "SENDER", + "enum": [ + "SENDER", + "RECEIVER" + ] + }, + "sendTo": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003AYRE" + }, + "sendToName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "severity": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "MINOR", + "enum": [ + "MINOR", + "MAJOR", + "CRITICAL", + "LIFE-THREATENING" + ] + }, + "type": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "example": "ALERT", + "enum": [ + "ALERT", + "INVESTIGATION" + ] + }, + "targetDate": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "example": "2099-02-21T21:27:10.734950Z" + }, + "messages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NotificationMessageResponse" + } + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the paged result found for BpnEdcMapping", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BpnEdcMappingResponse" - } - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/edc/notification/contract": { + "post": { + "tags": [ + "Notifications" + ], + "summary": "Triggers EDC notification contract", + "description": "The endpoint Triggers EDC notification contract based on notification type and method", + "operationId": "createNotificationContract", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateNotificationContractRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Created.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateNotificationContractResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/submodel/data/{submodelId}" : { - "get" : { - "tags" : [ - "Submodel" - ], - "summary" : "Gets Submodel by its id", - "description" : "The endpoint returns Submodel for given id. Used for data providing functionality", - "operationId" : "getSubmodelById", - "parameters" : [ - { - "name" : "submodelId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "200" : { - "description" : "Returns submodel payload", - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - } - }, - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/contracts": { + "post": { + "tags": [ + "Contracts" + ], + "summary": "All contract agreements for all assets", + "description": "This endpoint returns all contract agreements for all assets in Trace-X", + "operationId": "contracts", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PageableFilterRequest" + } + } + }, + "required": true + }, + "responses": { + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "type": "string", + "example": { + "message": "Too many requests." + } + } + } + } + }, + "415": { + "description": "Unsupported media type.", + "content": { + "application/json": { + "schema": { + "type": "string", + "example": { + "message": "Unsupported media type." + } + } + } + } + }, + "200": { + "description": "Ok.", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "description": "PageResults", + "items": { + "$ref": "#/components/schemas/PageResultContractResponse" + } + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "type": "string", + "example": { + "message": "Bad request." + } + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "type": "string", + "example": { + "message": "Internal server error." + } + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "type": "string", + "example": { + "message": "Not found." + } + } + } + } + }, + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "type": "string", + "example": { + "message": "Authorization failed." + } + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "type": "string", + "example": { + "message": "Forbidden." + } + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - }, - "post" : { - "tags" : [ - "Submodel" - ], - "summary" : "Save Submodel", - "description" : "This endpoint allows you to save a Submodel identified by its ID.", - "operationId" : "saveSubmodel", - "parameters" : [ - { - "name" : "submodelId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } + "/assets/publish": { + "post": { + "tags": [ + "AssetsImport", + "AssetsPublish" + ], + "summary": "asset publish", + "description": "This endpoint publishes assets to the Catena-X network.", + "operationId": "publishAssets", + "parameters": [ + { + "name": "triggerSynchronizeAssets", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": true + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RegisterAssetRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "OK.", + "content": { + "application/json": { + + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Ok." - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "204" : { - "description" : "No Content." - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/assets/import": { + "post": { + "tags": [ + "AssetsImport" + ], + "summary": "asset upload", + "description": "This endpoint stores assets in the application. Those can be later published in the Catena-X network.", + "operationId": "importJson", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "required": [ + "file" + ], + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportResponse" + } + } + } + }, + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications" : { - "post" : { - "tags" : [ - "Notifications" - ], - "summary" : "Start notification by part ids", - "description" : "The endpoint starts notification based on part ids provided.", - "operationId" : "notifyAssets", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/StartNotificationRequest" - } + "/assets/as-planned/sync": { + "post": { + "tags": [ + "AssetsAsPlanned" + ], + "summary": "Synchronizes assets from IRS", + "description": "The endpoint synchronizes the assets from irs.", + "operationId": "sync", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SyncAssetsRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Created." + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "201" : { - "description" : "Created.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/NotificationIdResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/assets/as-planned/detail-information": { + "post": { + "tags": [ + "AssetsAsPlanned" + ], + "summary": "Searches for assets by ids.", + "description": "The endpoint searchs for assets by id and returns a list of them.", + "operationId": "getDetailInformation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetDetailInformationRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found for Asset", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}/update" : { - "post" : { - "tags" : [ - "Notifications" - ], - "summary" : "Update notification by id", - "description" : "The endpoint updates notification by their id.", - "operationId" : "updateNotification_1", - "parameters" : [ - { - "name" : "notificationId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int64" - } - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/UpdateNotificationStatusTransitionRequest" - } + "/assets/as-built/sync": { + "post": { + "tags": [ + "AssetsAsBuilt" + ], + "summary": "Synchronizes assets from IRS", + "description": "The endpoint synchronizes the assets from irs.", + "operationId": "sync_1", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SyncAssetsRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "201": { + "description": "Created." + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/assets/as-built/detail-information": { + "post": { + "tags": [ + "AssetsAsBuilt" + ], + "summary": "Searches for assets by ids.", + "description": "The endpoint searchs for assets by id and returns a list of them.", + "operationId": "getDetailInformation_1", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetDetailInformationRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found for Asset", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "204" : { - "description" : "No content." - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}/close" : { - "post" : { - "tags" : [ - "Notifications" - ], - "summary" : "Close notification by id", - "description" : "The endpoint closes Notification by id.", - "operationId" : "closeNotification", - "parameters" : [ - { - "name" : "notificationId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int64" - } - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CloseNotificationRequest" - } - } - }, - "required" : true - }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Ok." - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "204" : { - "description" : "No content." - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}/cancel" : { - "post" : { - "tags" : [ - "Notifications" - ], - "summary" : "Cancels notification by id", - "description" : "The endpoint cancels notification by id.", - "operationId" : "cancelNotification", - "parameters" : [ - { - "name" : "notificationId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int64" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Ok." - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "204" : { - "description" : "No content." - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}/approve" : { - "post" : { - "tags" : [ - "Notifications" - ], - "summary" : "Approves notification by id", - "description" : "The endpoint approves notification by id.", - "operationId" : "approveNotification", - "parameters" : [ - { - "name" : "notificationId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int64" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Ok." - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "204" : { - "description" : "No content." - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications/filter" : { - "post" : { - "tags" : [ - "Notifications" - ], - "summary" : "Filter notifications defined by the request body", - "description" : "The endpoint returns notifications as paged result.", - "operationId" : "filterNotifications", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PageableFilterRequest" - } - } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the paged result found for Notifications", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Notifications", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maximum" : 255, - "minimum" : 0, - "maxLength" : 255, - "type" : "integer", - "format" : "int64", - "example" : 66 - }, - "title" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Title" - }, - "status" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "CREATED", - "enum" : [ - "CREATED", - "SENT", - "RECEIVED", - "ACKNOWLEDGED", - "ACCEPTED", - "DECLINED", - "CANCELED", - "CLOSED" - ] - }, - "description" : { - "maxLength" : 1000, - "minLength" : 0, - "type" : "string", - "example" : "DescriptionText" - }, - "createdBy" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003AYRE" - }, - "createdByName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "createdDate" : { - "maxLength" : 50, - "minLength" : 0, - "type" : "string", - "example" : "2023-02-21T21:27:10.734950Z" - }, - "updatedDate" : { - "maxLength" : 50, - "minLength" : 0, - "type" : "string", - "example" : "2023-02-21T21:27:10.734950Z" - }, - "assetIds" : { - "maxItems" : 1000, - "minItems" : 0, - "type" : "array", - "example" : [ - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd", - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd", - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd" - ], - "items" : { - "type" : "string", - "example" : "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd\"]" - } - }, - "channel" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "SENDER", - "enum" : [ - "SENDER", - "RECEIVER" - ] - }, - "sendTo" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003AYRE" - }, - "sendToName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "severity" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "MINOR", - "enum" : [ - "MINOR", - "MAJOR", - "CRITICAL", - "LIFE-THREATENING" + "/assets/as-planned/{assetId}": { + "get": { + "tags": [ + "AssetsAsPlanned" + ], + "summary": "Get asset by id", + "description": "The endpoint returns an asset filtered by id .", + "operationId": "assetById", + "parameters": [ + { + "name": "assetId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the assets found", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" ] - }, - "type" : { - "maxLength" : 50, - "minLength" : 0, - "type" : "string", - "example" : "ALERT", - "enum" : [ - "ALERT", - "INVESTIGATION" + } + ] + }, + "patch": { + "tags": [ + "AssetsAsPlanned" + ], + "summary": "Updates asset", + "description": "The endpoint updates asset by provided quality type.", + "operationId": "updateAsset", + "parameters": [ + { + "name": "assetId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateAssetRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the updated asset", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" ] - }, - "targetDate" : { - "maxLength" : 50, - "minLength" : 0, - "type" : "string", - "example" : "2099-02-21T21:27:10.734950Z" - }, - "messages" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NotificationMessageResponse" - } - } - } - } - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/edc/notification/contract" : { - "post" : { - "tags" : [ - "Notifications" - ], - "summary" : "Triggers EDC notification contract", - "description" : "The endpoint Triggers EDC notification contract based on notification type and method", - "operationId" : "createNotificationContract", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CreateNotificationContractRequest" - } + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "201" : { - "description" : "Created.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CreateNotificationContractResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/assets/as-built/{assetId}": { + "get": { + "tags": [ + "AssetsAsBuilt" + ], + "summary": "Get asset by id", + "description": "The endpoint returns an asset filtered by id .", + "operationId": "assetById_1", + "parameters": [ + { + "name": "assetId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the assets found", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] + }, + "patch": { + "tags": [ + "AssetsAsBuilt" + ], + "summary": "Updates asset", + "description": "The endpoint updates asset by provided quality type.", + "operationId": "updateAsset_1", + "parameters": [ + { + "name": "assetId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateAssetRequest" + } + } + }, + "required": true + }, + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the updated asset", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/contracts" : { - "post" : { - "tags" : [ - "Contracts" - ], - "summary" : "All contract agreements for all assets", - "description" : "This endpoint returns all contract agreements for all assets in Trace-X", - "operationId" : "contracts", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PageableFilterRequest" - } + "/registry/reload": { + "get": { + "tags": [ + "Registry" + ], + "summary": "Triggers reload of shell descriptors", + "description": "The endpoint Triggers reload of shell descriptors.", + "operationId": "reload", + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "202": { + "description": "Created registry reload job." + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "type" : "string", - "example" : { - "message" : "Authorization failed." - } - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "type" : "string", - "example" : { - "message" : "Too many requests." - } - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "type" : "string", - "example" : { - "message" : "Internal server error." - } - } - } - } - }, - "200" : { - "description" : "Ok.", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "description" : "PageResults", - "items" : { - "$ref" : "#/components/schemas/PageResultContractResponse" - } - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "type" : "string", - "example" : { - "message" : "Forbidden." - } - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "type" : "string", - "example" : { - "message" : "Bad request." - } - } - } - } - }, - "415" : { - "description" : "Unsupported media type.", - "content" : { - "application/json" : { - "schema" : { - "type" : "string", - "example" : { - "message" : "Unsupported media type." - } - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "type" : "string", - "example" : { - "message" : "Not found." - } - } - } + "/policies/{policyId}": { + "get": { + "tags": [ + "Policies" + ], + "summary": "Gets policy by id", + "description": "The endpoint returns policy by id.", + "operationId": "getPolicyById", + "parameters": [ + { + "name": "policyId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "OK.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] + }, + "delete": { + "tags": [ + "Policies" + ], + "summary": "Deletes a policy ", + "description": "The endpoint deletes policies.", + "operationId": "deletePolicy", + "parameters": [ + { + "name": "policyId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Deletion successful", + "content": { + "application/json": { + + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/publish" : { - "post" : { - "tags" : [ - "AssetsImport", - "AssetsPublish" - ], - "summary" : "asset publish", - "description" : "This endpoint publishes assets to the Catena-X network.", - "operationId" : "publishAssets", - "parameters" : [ - { - "name" : "triggerSynchronizeAssets", - "in" : "query", - "required" : false, - "schema" : { - "type" : "boolean", - "default" : true - } - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/RegisterAssetRequest" - } + "/notifications/{notificationId}": { + "get": { + "tags": [ + "Notifications" + ], + "summary": "Gets notification by id", + "description": "The endpoint returns notification by id.", + "operationId": "getNotification", + "parameters": [ + { + "name": "notificationId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "OK.", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Notifications", + "items": { + "$ref": "#/components/schemas/NotificationResponse" + } + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "required" : true }, - "responses" : { - "200" : { - "description" : "OK.", - "content" : { - "application/json" : {} - } - }, - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "204" : { - "description" : "No Content." - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/import" : { - "post" : { - "tags" : [ - "AssetsImport" - ], - "summary" : "asset upload", - "description" : "This endpoint stores assets in the application. Those can be later published in the Catena-X network.", - "operationId" : "importJson", - "requestBody" : { - "content" : { - "multipart/form-data" : { - "schema" : { - "required" : [ - "file" + "/notifications/distinctFilterValues": { + "get": { + "tags": [ + "Notifications" ], - "type" : "object", - "properties" : { - "file" : { - "type" : "string", - "format" : "binary" - } - } - } - } - } - }, - "responses" : { - "200" : { - "description" : "OK.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ImportResponse" - } - } - } - }, - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "204" : { - "description" : "No Content." - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned/sync" : { - "post" : { - "tags" : [ - "AssetsAsPlanned" - ], - "summary" : "Synchronizes assets from IRS", - "description" : "The endpoint synchronizes the assets from irs.", - "operationId" : "sync", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/SyncAssetsRequest" - } - } - }, - "required" : true - }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "201" : { - "description" : "Created." - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned/detail-information" : { - "post" : { - "tags" : [ - "AssetsAsPlanned" - ], - "summary" : "Searches for assets by ids.", - "description" : "The endpoint searchs for assets by id and returns a list of them.", - "operationId" : "getDetailInformation", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/GetDetailInformationRequest" - } - } - }, - "required" : true - }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the paged result found for Asset", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/sync" : { - "post" : { - "tags" : [ - "AssetsAsBuilt" - ], - "summary" : "Synchronizes assets from IRS", - "description" : "The endpoint synchronizes the assets from irs.", - "operationId" : "sync_1", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/SyncAssetsRequest" - } - } - }, - "required" : true - }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "201" : { - "description" : "Created." - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/detail-information" : { - "post" : { - "tags" : [ - "AssetsAsBuilt" - ], - "summary" : "Searches for assets by ids.", - "description" : "The endpoint searchs for assets by id and returns a list of them.", - "operationId" : "getDetailInformation_1", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/GetDetailInformationRequest" - } - } - }, - "required" : true - }, - "responses" : { - "200" : { - "description" : "Returns the paged result found for Asset", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } - } - } - } - }, - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned/{assetId}" : { - "get" : { - "tags" : [ - "AssetsAsPlanned" - ], - "summary" : "Get asset by id", - "description" : "The endpoint returns an asset filtered by id .", - "operationId" : "assetById", - "parameters" : [ - { - "name" : "assetId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the assets found", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - }, - "patch" : { - "tags" : [ - "AssetsAsPlanned" - ], - "summary" : "Updates asset", - "description" : "The endpoint updates asset by provided quality type.", - "operationId" : "updateAsset", - "parameters" : [ - { - "name" : "assetId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/UpdateAssetRequest" - } - } - }, - "required" : true - }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the updated asset", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/{assetId}" : { - "get" : { - "tags" : [ - "AssetsAsBuilt" - ], - "summary" : "Get asset by id", - "description" : "The endpoint returns an asset filtered by id .", - "operationId" : "assetById_1", - "parameters" : [ - { - "name" : "assetId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the assets found", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - }, - "patch" : { - "tags" : [ - "AssetsAsBuilt" - ], - "summary" : "Updates asset", - "description" : "The endpoint updates asset by provided quality type.", - "operationId" : "updateAsset_1", - "parameters" : [ - { - "name" : "assetId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/UpdateAssetRequest" - } - } - }, - "required" : true - }, - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the updated asset", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/registry/reload" : { - "get" : { - "tags" : [ - "Registry" - ], - "summary" : "Triggers reload of shell descriptors", - "description" : "The endpoint Triggers reload of shell descriptors.", - "operationId" : "reload", - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "202" : { - "description" : "Created registry reload job." - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/policies/{policyId}" : { - "get" : { - "tags" : [ - "Policies" - ], - "summary" : "Gets policy by id", - "description" : "The endpoint returns policy by id.", - "operationId" : "getPolicyById", - "parameters" : [ - { - "name" : "policyId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns the policies", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PolicyResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - }, - "delete" : { - "tags" : [ - "Policies" - ], - "summary" : "Deletes a policy ", - "description" : "The endpoint deletes policies.", - "operationId" : "deletePolicy", - "parameters" : [ - { - "name" : "policyId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Deletion successful", - "content" : { - "application/json" : {} - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}" : { - "get" : { - "tags" : [ - "Notifications" - ], - "summary" : "Gets notification by id", - "description" : "The endpoint returns notification by id.", - "operationId" : "getNotification", - "parameters" : [ - { - "name" : "notificationId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int64" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "OK.", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Notifications", - "items" : { - "$ref" : "#/components/schemas/NotificationResponse" - } - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/notifications/distinctFilterValues" : { - "get" : { - "tags" : [ - "Notifications" - ], - "summary" : "getDistinctFilterValues", - "description" : "The endpoint returns a distinct filter values for given fieldName of notification.", - "operationId" : "distinctFilterValues", - "parameters" : [ - { - "name" : "fieldName", - "in" : "query", - "required" : true, - "schema" : { - "type" : "string" - } - }, - { - "name" : "size", - "in" : "query", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int32" - } - }, - { - "name" : "startWith", - "in" : "query", - "required" : true, - "schema" : { - "type" : "string" - } - }, - { - "name" : "channel", - "in" : "query", - "required" : true, - "schema" : { - "type" : "string", - "enum" : [ - "SENDER", - "RECEIVER" - ] - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns a distinct filter values for given fieldName.", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "type" : "string" - } - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/dashboard" : { - "get" : { - "tags" : [ - "Dashboard" - ], - "summary" : "Returns dashboard related data", - "description" : "The endpoint can return limited data based on the user role", - "operationId" : "dashboard", - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns dashboard data", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/DashboardResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/import/report/{importJobId}" : { - "get" : { - "tags" : [ - "ImportReport", - "AssetsImport" - ], - "summary" : "report of the imported assets", - "description" : "This endpoint returns information about the imported assets to Trace-X.", - "operationId" : "importReport", - "parameters" : [ - { - "name" : "importJobId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "204" : { - "description" : "No Content." - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "OK.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ImportReportResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned" : { - "get" : { - "tags" : [ - "AssetsAsPlanned" - ], - "summary" : "Get assets by pagination", - "description" : "The endpoint returns a paged result of assets.", - "operationId" : "AssetsAsPlanned", - "parameters" : [ - { - "name" : "pageable", - "in" : "query", - "required" : true, - "schema" : { - "$ref" : "#/components/schemas/OwnPageable" - } - }, - { - "name" : "filter", - "in" : "query", - "required" : true, - "schema" : { - "$ref" : "#/components/schemas/SearchCriteriaRequestParam" - } - } - ], - "responses" : { - "200" : { - "description" : "Returns the paged result found for Asset", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } - } - } - } - }, - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned/distinctFilterValues" : { - "get" : { - "tags" : [ - "Assets", - "AssetsAsPlanned" - ], - "summary" : "getDistinctFilterValues", - "description" : "The endpoint returns a distinct filter values for given fieldName.", - "operationId" : "distinctFilterValues_1", - "parameters" : [ - { - "name" : "fieldName", - "in" : "query", - "required" : true, - "schema" : { - "type" : "string" - } - }, - { - "name" : "size", - "in" : "query", - "required" : false, - "schema" : { - "type" : "integer", - "format" : "int32" - } - }, - { - "name" : "startWith", - "in" : "query", - "required" : false, - "schema" : { - "type" : "string" - } - }, - { - "name" : "owner", - "in" : "query", - "required" : false, - "schema" : { - "type" : "string", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - } - }, - { - "name" : "inAssetIds", - "in" : "query", - "required" : false, - "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "200" : { - "description" : "Returns a distinct filter values for given fieldName.", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "type" : "string" - } - } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "summary": "getDistinctFilterValues", + "description": "The endpoint returns a distinct filter values for given fieldName of notification.", + "operationId": "distinctFilterValues", + "parameters": [ + { + "name": "fieldName", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "size", + "in": "query", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "startWith", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "channel", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "SENDER", + "RECEIVER" + ] + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns a distinct filter values for given fieldName.", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned/*/children/{childId}" : { - "get" : { - "tags" : [ - "AssetsAsPlanned" - ], - "summary" : "Get asset by child id", - "description" : "The endpoint returns an asset filtered by child id.", - "operationId" : "assetByChildIdAndAssetId", - "parameters" : [ - { - "name" : "childId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + "/dashboard": { + "get": { + "tags": [ + "Dashboard" + ], + "summary": "Returns dashboard related data", + "description": "The endpoint can return limited data based on the user role", + "operationId": "dashboard", + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns dashboard data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DashboardResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + }, + "/assets/import/report/{importJobId}": { + "get": { + "tags": [ + "ImportReport", + "AssetsImport" + ], + "summary": "report of the imported assets", + "description": "This endpoint returns information about the imported assets to Trace-X.", + "operationId": "importReport", + "parameters": [ + { + "name": "importJobId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "OK.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportReportResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No Content." + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + }, + "/assets/as-planned": { + "get": { + "tags": [ + "AssetsAsPlanned" + ], + "summary": "Get assets by pagination", + "description": "The endpoint returns a paged result of assets.", + "operationId": "AssetsAsPlanned", + "parameters": [ + { + "name": "pageable", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/OwnPageable" + } + }, + { + "name": "filter", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/SearchCriteriaRequestParam" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found for Asset", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "200" : { - "description" : "Returns the asset by childId", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" + }, + "/assets/as-planned/distinctFilterValues": { + "get": { + "tags": [ + "Assets", + "AssetsAsPlanned" + ], + "summary": "getDistinctFilterValues", + "description": "The endpoint returns a distinct filter values for given fieldName.", + "operationId": "distinctFilterValues_1", + "parameters": [ + { + "name": "fieldName", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "size", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "startWith", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "owner", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + } + }, + { + "name": "inAssetIds", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns a distinct filter values for given fieldName.", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" + } + ] + } + }, + "/assets/as-planned/*/children/{childId}": { + "get": { + "tags": [ + "AssetsAsPlanned" + ], + "summary": "Get asset by child id", + "description": "The endpoint returns an asset filtered by child id.", + "operationId": "assetByChildIdAndAssetId", + "parameters": [ + { + "name": "childId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the asset by childId", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" + } + ] + } + }, + "/assets/as-built": { + "get": { + "tags": [ + "AssetsAsBuilt" + ], + "summary": "Get assets by pagination", + "description": "The endpoint returns a paged result of assets.", + "operationId": "assets", + "parameters": [ + { + "name": "pageable", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/OwnPageable" + } + }, + { + "name": "searchCriteriaRequestParam", + "in": "query", + "required": true, + "schema": { + "$ref": "#/components/schemas/SearchCriteriaRequestParam" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the paged result found for Asset", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" + } + ] + } + }, + "/assets/as-built/distinctFilterValues": { + "get": { + "tags": [ + "AssetsAsBuilt", + "Assets" + ], + "summary": "getDistinctFilterValues", + "description": "The endpoint returns a distinct filter values for given fieldName.", + "operationId": "distinctFilterValues_2", + "parameters": [ + { + "name": "fieldName", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "size", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "startWith", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "owner", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + } + }, + { + "name": "inAssetIds", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns a distinct filter values for given fieldName.", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } - } + } + ] } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + }, + "/assets/as-built/countries": { + "get": { + "tags": [ + "AssetsAsBuilt" + ], + "summary": "Get map of assets", + "description": "The endpoint returns a map for assets consumed by the map.", + "operationId": "assetsCountryMap", + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the assets found", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" - } - } + }, + "/assets/as-built/*/children/{childId}": { + "get": { + "tags": [ + "AssetsAsBuilt" + ], + "summary": "Get asset by child id", + "description": "The endpoint returns an asset filtered by child id.", + "operationId": "assetByChildId", + "parameters": [ + { + "name": "childId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Returns the asset by childId", + "content": { + "application/json": { + "schema": { + "maxItems": 2147483647, + "type": "array", + "description": "Assets", + "items": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + }, + "semanticModelId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "NO-246880451848384868750731" + }, + "businessPartner": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "manufacturerName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "nameAtManufacturer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "manufacturerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "owner": { + "type": "string", + "example": "CUSTOMER", + "enum": [ + "SUPPLIER", + "CUSTOMER", + "OWN", + "UNKNOWN" + ] + }, + "childRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Child relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "parentRelations": { + "maxItems": 2147483647, + "type": "array", + "description": "Parent relationships", + "items": { + "$ref": "#/components/schemas/DescriptionsResponse" + } + }, + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + }, + "van": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "OMAYSKEITUGNVHKKX" + }, + "semanticDataModel": { + "type": "string", + "example": "BATCH", + "enum": [ + "BATCH", + "SERIALPART", + "UNKNOWN", + "PARTASPLANNED", + "JUSTINSEQUENCE", + "TOMBSTONEASBUILT", + "TOMBSTONEASPLANNED" + ] + }, + "classification": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "component" + }, + "detailAspectModels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectModelResponse" + } + }, + "sentQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "receivedQualityAlertIdsInStatusActive": { + "type": "array", + "example": 1, + "items": { + "type": "integer", + "format": "int64", + "example": 1 + } + }, + "sentQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "receivedQualityInvestigationIdsInStatusActive": { + "type": "array", + "example": 2, + "items": { + "type": "integer", + "format": "int64", + "example": 2 + } + }, + "importState": { + "type": "string", + "example": "TRANSIENT", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "importNote": { + "type": "string", + "example": "Asset created successfully in transient state" + }, + "tombstone": { + "type": "string", + "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" + }, + "contractAgreementId": { + "type": "string", + "example": "TODO" + } + } + } + } + } + } + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built" : { - "get" : { - "tags" : [ - "AssetsAsBuilt" - ], - "summary" : "Get assets by pagination", - "description" : "The endpoint returns a paged result of assets.", - "operationId" : "assets", - "parameters" : [ - { - "name" : "pageable", - "in" : "query", - "required" : true, - "schema" : { - "$ref" : "#/components/schemas/OwnPageable" + "/submodel/data": { + "delete": { + "tags": [ + "Submodel" + ], + "summary": "Delete All Submodels", + "description": "Deletes all submodels from the system.", + "operationId": "deleteSubmodels", + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Ok." + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "No Content." + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - }, - { - "name" : "searchCriteriaRequestParam", - "in" : "query", - "required" : true, - "schema" : { - "$ref" : "#/components/schemas/SearchCriteriaRequestParam" + }, + "/bpn-config/{bpn}": { + "delete": { + "tags": [ + "BpnEdcMapping" + ], + "summary": "Deletes BPN EDC URL mappings", + "description": "The endpoint deletes BPN EDC URL mappings", + "operationId": "deleteBpnEdcUrlMappings", + "parameters": [ + { + "name": "bpn", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "401": { + "description": "Authorization failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "415": { + "description": "Unsupported media type", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "204": { + "description": "Deleted." + }, + "403": { + "description": "Forbidden.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "200": { + "description": "Okay" + }, + "429": { + "description": "Too many requests.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "Bad request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "security": [ + { + "oAuth2": [ + "profile email" + ] + } + ] } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + } + }, + "components": { + "schemas": { + "UpdatePolicyRequest": { + "type": "object", + "properties": { + "businessPartnerNumbers": { + "type": "array", + "items": { + "type": "string" + } + }, + "policyIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "validUntil": { + "type": "string", + "format": "date-time" + } } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "ErrorResponse": { + "type": "object", + "properties": { + "message": { + "maxLength": 1000, + "minLength": 0, + "pattern": "^.*$", + "type": "string", + "example": "Access Denied" + } } - } - } - }, - "200" : { - "description" : "Returns the paged result found for Asset", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } - } + }, + "EditNotificationRequest": { + "required": [ + "affectedPartIds", + "description", + "receiverBpn", + "severity" + ], + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "minLength": 1, + "type": "string", + "example": "title" + }, + "receiverBpn": { + "type": "string", + "example": "BPNL00000003CNKC" + }, + "severity": { + "type": "string", + "enum": [ + "MINOR", + "MAJOR", + "CRITICAL", + "LIFE-THREATENING" + ] + }, + "targetDate": { + "type": "string", + "format": "date-time", + "example": "2099-03-11T22:44:06.333826952Z" + }, + "description": { + "maxLength": 1000, + "minLength": 15, + "type": "string", + "example": "The description" + }, + "affectedPartIds": { + "maxLength": 50, + "minLength": 1, + "maxItems": 50, + "minItems": 1, + "type": "array", + "example": [ + "urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978" + ], + "items": { + "maxLength": 50, + "minLength": 1, + "type": "string", + "example": "[\"urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978\"]" + } + } } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "BpnMappingRequest": { + "required": [ + "bpn", + "url" + ], + "type": "object", + "properties": { + "bpn": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003CSGV" + }, + "url": { + "maxLength": 255, + "minLength": 0, + "type": "string" + } } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "BpnEdcMappingResponse": { + "type": "object", + "properties": { + "bpn": { + "type": "string", + "example": "BPNL00000003CSGV" + }, + "url": { + "type": "string", + "example": "https://trace-x-test-edc.dev.demo.catena-x.net/a1" + } } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "Constraint": { + "type": "object", + "properties": { + "leftOperand": { + "type": "string", + "example": "string" + }, + "operator": { + "$ref": "#/components/schemas/Operator" + }, + "odrl:rightOperand": { + "type": "string", + "example": "string" + } } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "Constraints": { + "type": "object", + "properties": { + "and": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Constraint" + } + }, + "or": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Constraint" + } + } } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "Context": { + "type": "object", + "properties": { + "odrl": { + "type": "string" + } } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/distinctFilterValues" : { - "get" : { - "tags" : [ - "AssetsAsBuilt", - "Assets" - ], - "summary" : "getDistinctFilterValues", - "description" : "The endpoint returns a distinct filter values for given fieldName.", - "operationId" : "distinctFilterValues_2", - "parameters" : [ - { - "name" : "fieldName", - "in" : "query", - "required" : true, - "schema" : { - "type" : "string" - } - }, - { - "name" : "size", - "in" : "query", - "required" : false, - "schema" : { - "type" : "integer", - "format" : "int32" - } - }, - { - "name" : "startWith", - "in" : "query", - "required" : false, - "schema" : { - "type" : "string" - } - }, - { - "name" : "owner", - "in" : "query", - "required" : false, - "schema" : { - "type" : "string", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - } - }, - { - "name" : "inAssetIds", - "in" : "query", - "required" : false, - "schema" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "Operator": { + "type": "object", + "properties": { + "@id": { + "type": "string", + "example": "odrl:eq", + "enum": [ + "eq", + "neq", + "lt", + "gt", + "in", + "lteq", + "gteq", + "isA", + "hasPart", + "isPartOf", + "isOneOf", + "isAllOf", + "isNoneOf" + ] + } + } + }, + "Payload": { + "type": "object", + "properties": { + "@context": { + "$ref": "#/components/schemas/Context" + }, + "@id": { + "type": "string" + }, + "policy": { + "$ref": "#/components/schemas/Policy" + } } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "Permission": { + "type": "object", + "properties": { + "action": { + "type": "string", + "example": "use", + "enum": [ + "access", + "use" + ] + }, + "constraint": { + "$ref": "#/components/schemas/Constraints" + } } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "Policy": { + "type": "object", + "properties": { + "policyId": { + "type": "string", + "example": "f253718e-a270-4367-901b-9d50d9bd8462" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "validUntil": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Permission" + } + } } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "RegisterPolicyRequest": { + "type": "object", + "properties": { + "validUntil": { + "type": "string", + "format": "date-time" + }, + "businessPartnerNumber": { + "type": "string" + }, + "payload": { + "$ref": "#/components/schemas/Payload" + } } - } - } - }, - "200" : { - "description" : "Returns a distinct filter values for given fieldName.", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "type" : "string" - } + }, + "CreatePolicyResponse": { + "type": "object", + "properties": { + "policyId": { + "type": "string" + } } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "StartNotificationRequest": { + "required": [ + "receiverBpn", + "severity", + "type" + ], + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "minLength": 1, + "type": "string", + "example": "title" + }, + "affectedPartIds": { + "maxLength": 100, + "minLength": 1, + "maxItems": 50, + "minItems": 1, + "type": "array", + "example": [ + "urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978" + ], + "items": { + "maxLength": 100, + "minLength": 1, + "type": "string", + "example": "[\"urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978\"]" + } + }, + "description": { + "maxLength": 1000, + "minLength": 15, + "type": "string", + "example": "The description" + }, + "targetDate": { + "type": "string", + "format": "date-time", + "example": "2099-03-11T22:44:06.333826952Z" + }, + "severity": { + "type": "string", + "enum": [ + "MINOR", + "MAJOR", + "CRITICAL", + "LIFE-THREATENING" + ] + }, + "receiverBpn": { + "type": "string", + "example": "BPNL00000003CNKC" + }, + "type": { + "type": "string", + "example": "ALERT", + "enum": [ + "ALERT", + "INVESTIGATION" + ] + } } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "NotificationIdResponse": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + } } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "UpdateNotificationStatusTransitionRequest": { + "required": [ + "status" + ], + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The UpdateInvestigationStatus", + "enum": [ + "ACKNOWLEDGED", + "ACCEPTED", + "DECLINED" + ] + }, + "reason": { + "type": "string", + "example": "The reason." + } } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/countries" : { - "get" : { - "tags" : [ - "AssetsAsBuilt" - ], - "summary" : "Get map of assets", - "description" : "The endpoint returns a map for assets consumed by the map.", - "operationId" : "assetsCountryMap", - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "CloseNotificationRequest": { + "type": "object", + "properties": { + "reason": { + "maxLength": 1000, + "minLength": 15, + "type": "string", + "example": "The reason." + } } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "OwnPageable": { + "type": "object", + "properties": { + "page": { + "type": "integer", + "format": "int32" + }, + "size": { + "type": "integer", + "format": "int32" + }, + "sort": { + "maxItems": 2147483647, + "type": "array", + "description": "Content of Assets PageResults", + "example": "manufacturerPartId,desc", + "items": { + "type": "string" + } + } } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "PageableFilterRequest": { + "type": "object", + "properties": { + "pageAble": { + "$ref": "#/components/schemas/OwnPageable" + }, + "searchCriteria": { + "$ref": "#/components/schemas/SearchCriteriaRequestParam" + } } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "SearchCriteriaRequestParam": { + "type": "object", + "properties": { + "filter": { + "maxItems": 2147483647, + "type": "array", + "description": "Filter Criteria", + "example": "owner,EQUAL,OWN", + "items": { + "type": "string" + } + } } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "NotificationMessageResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "sentBy": { + "type": "string" + }, + "sentByName": { + "type": "string" + }, + "sendTo": { + "type": "string" + }, + "sendToName": { + "type": "string" + }, + "contractAgreementId": { + "type": "string" + }, + "notificationReferenceId": { + "type": "string" + }, + "edcNotificationId": { + "type": "string" + }, + "messageDate": { + "maxLength": 50, + "type": "string", + "example": "2023-02-21T21:27:10.734950Z" + }, + "messageId": { + "type": "string" + }, + "status": { + "type": "string", + "enum": [ + "CREATED", + "SENT", + "RECEIVED", + "ACKNOWLEDGED", + "ACCEPTED", + "DECLINED", + "CANCELED", + "CLOSED" + ] + }, + "errorMessage": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "EDC not reachable" + }, + "message": { + "type": "string" + } } - } - } - }, - "200" : { - "description" : "Returns the assets found", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "items" : { - "type" : "string" - } + }, + "NotificationResponse": { + "type": "object", + "properties": { + "id": { + "maximum": 255, + "minimum": 0, + "maxLength": 255, + "type": "integer", + "format": "int64", + "example": 66 + }, + "title": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Title" + }, + "status": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "CREATED", + "enum": [ + "CREATED", + "SENT", + "RECEIVED", + "ACKNOWLEDGED", + "ACCEPTED", + "DECLINED", + "CANCELED", + "CLOSED" + ] + }, + "description": { + "maxLength": 1000, + "minLength": 0, + "type": "string", + "example": "DescriptionText" + }, + "createdBy": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003AYRE" + }, + "createdByName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "createdDate": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "example": "2023-02-21T21:27:10.734950Z" + }, + "updatedDate": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "example": "2023-02-21T21:27:10.734950Z" + }, + "assetIds": { + "maxItems": 1000, + "minItems": 0, + "type": "array", + "example": [ + "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd", + "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd", + "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd" + ], + "items": { + "type": "string", + "example": "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd\"]" + } + }, + "channel": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "SENDER", + "enum": [ + "SENDER", + "RECEIVER" + ] + }, + "sendTo": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "BPNL00000003AYRE" + }, + "sendToName": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Tier C" + }, + "severity": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "MINOR", + "enum": [ + "MINOR", + "MAJOR", + "CRITICAL", + "LIFE-THREATENING" + ] + }, + "type": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "example": "ALERT", + "enum": [ + "ALERT", + "INVESTIGATION" + ] + }, + "targetDate": { + "maxLength": 50, + "minLength": 0, + "type": "string", + "example": "2099-02-21T21:27:10.734950Z" + }, + "messages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NotificationMessageResponse" + } + } } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "CreateNotificationContractRequest": { + "required": [ + "notificationMethod", + "notificationType" + ], + "type": "object", + "properties": { + "notificationType": { + "type": "string", + "enum": [ + "QUALITY_INVESTIGATION", + "QUALITY_ALERT" + ] + }, + "notificationMethod": { + "type": "string", + "enum": [ + "RECEIVE", + "UPDATE", + "RESOLVE" + ] + } } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "CreateNotificationContractResponse": { + "type": "object", + "properties": { + "notificationAssetId": { + "type": "string", + "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + }, + "accessPolicyId": { + "type": "string", + "example": "123" + }, + "contractDefinitionId": { + "type": "string", + "example": "456" + } } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/*/children/{childId}" : { - "get" : { - "tags" : [ - "AssetsAsBuilt" - ], - "summary" : "Get asset by child id", - "description" : "The endpoint returns an asset filtered by child id.", - "operationId" : "assetByChildId", - "parameters" : [ - { - "name" : "childId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "ContractResponse": { + "type": "object", + "properties": { + "contractId": { + "maxLength": 255, + "type": "string", + "example": "66" + }, + "counterpartyAddress": { + "maxLength": 255, + "type": "string", + "example": "https://trace-x-edc-e2e-a.dev.demo.catena-x.net/api/v1/dsp" + }, + "creationDate": { + "maxLength": 255, + "type": "string", + "format": "date-time", + "example": "2023-02-21T21:27:10.73495Z" + }, + "endDate": { + "maxLength": 255, + "type": "string", + "format": "date-time", + "example": "2023-02-21T21:27:10.73495Z" + }, + "state": { + "maxLength": 255, + "type": "string", + "example": "FINALIZED" + }, + "policy": { + "maxLength": 255, + "type": "string", + "example": "{\\\"@id\\\":\\\"eb0c8486-914a-4d36-84c0-b4971cbc52e4\\\",\\\"@type\\\":\\\"odrl:Set\\\",\\\"odrl:permission\\\":{\\\"odrl:target\\\":\\\"registry-asset\\\",\\\"odrl:action\\\":{\\\"odrl:type\\\":\\\"USE\\\"},\\\"odrl:constraint\\\":{\\\"odrl:or\\\":{\\\"odrl:leftOperand\\\":\\\"PURPOSE\\\",\\\"odrl:operator\\\":{\\\"@id\\\":\\\"odrl:eq\\\"},\\\"odrl:rightOperand\\\":\\\"ID 3.0 Trace\\\"}}},\\\"odrl:prohibition\\\":[],\\\"odrl:obligation\\\":[],\\\"odrl:target\\\":\\\"registry-asset\\\"}" + } } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "PageResultContractResponse": { + "type": "object", + "properties": { + "content": { + "maxItems": 2147483647, + "minItems": 0, + "type": "array", + "description": "Content of PageResults", + "items": { + "$ref": "#/components/schemas/ContractResponse" + } + }, + "page": { + "type": "integer", + "format": "int32", + "example": 1 + }, + "pageCount": { + "type": "integer", + "format": "int32", + "example": 15 + }, + "pageSize": { + "type": "integer", + "format": "int32", + "example": 10 + }, + "totalItems": { + "type": "integer", + "format": "int64", + "example": 2 + } } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "RegisterAssetRequest": { + "required": [ + "assetIds", + "policyId" + ], + "type": "object", + "properties": { + "policyId": { + "type": "string", + "example": "a644a7cb-3de5-493b-9259-f01db315a46e" + }, + "assetIds": { + "type": "array", + "items": { + "type": "string" + } + } } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "ImportResponse": { + "type": "object", + "properties": { + "jobId": { + "type": "string" + }, + "importStateMessage": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportStateMessage" + } + }, + "validationResult": { + "$ref": "#/components/schemas/ValidationResponse" + } } - } - } - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "ImportStateMessage": { + "type": "object", + "properties": { + "catenaXId": { + "type": "string" + }, + "persistedOrUpdated": { + "type": "boolean" + } } - } - } - }, - "200" : { - "description" : "Returns the asset by childId", - "content" : { - "application/json" : { - "schema" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Assets", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - }, - "semanticModelId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "NO-246880451848384868750731" - }, - "businessPartner" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "manufacturerName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "nameAtManufacturer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "manufacturerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "owner" : { - "type" : "string", - "example" : "CUSTOMER", - "enum" : [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Child relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Parent relationships", - "items" : { - "$ref" : "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel" : { - "type" : "string", - "example" : "BATCH", - "enum" : [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "component" - }, - "detailAspectModels" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "receivedQualityAlertIdsInStatusActive" : { - "type" : "array", - "example" : 1, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - }, - "sentQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive" : { - "type" : "array", - "example" : 2, - "items" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - }, - "importState" : { - "type" : "string", - "example" : "TRANSIENT", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote" : { - "type" : "string", - "example" : "Asset created successfully in transient state" - }, - "tombstone" : { - "type" : "string", - "example" : " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId" : { - "type" : "string", - "example" : "TODO" - } - } - } + }, + "ValidationResponse": { + "type": "object", + "properties": { + "validationErrors": { + "type": "array", + "items": { + "type": "string" + } + } } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "SyncAssetsRequest": { + "type": "object", + "properties": { + "globalAssetIds": { + "maxItems": 100, + "minItems": 1, + "type": "array", + "example": [ + "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + ], + "items": { + "type": "string", + "example": "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\"]" + } + } } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "GetDetailInformationRequest": { + "type": "object", + "properties": { + "assetIds": { + "maxLength": 50, + "minLength": 1, + "maxItems": 50, + "minItems": 1, + "type": "array", + "example": [ + "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + ], + "items": { + "maxLength": 50, + "minLength": 1, + "type": "string", + "example": "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\"]" + } + } } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/submodel/data" : { - "delete" : { - "tags" : [ - "Submodel" - ], - "summary" : "Delete All Submodels", - "description" : "Deletes all submodels from the system.", - "operationId" : "deleteSubmodels", - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "DescriptionsResponse": { + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "urn:uuid:a4a26b9c-9460-4cc5-8645-85916b86adb0" + }, + "idShort": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "assembly-part-relationship" + } } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "DetailAspectDataAsBuiltResponse": { + "type": "object", + "properties": { + "partId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "95657762-59" + }, + "customerPartId": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "01697F7-65" + }, + "nameAtCustomer": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "Door front-left" + }, + "manufacturingCountry": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "DEU" + }, + "manufacturingDate": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "2022-02-04T13:48:54Z" + } } - } - } - }, - "200" : { - "description" : "Ok." - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "DetailAspectDataAsPlannedResponse": { + "type": "object", + "properties": { + "validityPeriodFrom": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "2022-09-26T12:43:51.079Z" + }, + "validityPeriodTo": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "20232-07-13T12:00:00.000Z" + } } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "DetailAspectDataResponse": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/DetailAspectDataAsBuiltResponse" + }, + { + "$ref": "#/components/schemas/DetailAspectDataAsPlannedResponse" + }, + { + "$ref": "#/components/schemas/PartSiteInformationAsPlannedResponse" + }, + { + "$ref": "#/components/schemas/DetailAspectDataTractionBatteryCodeResponse" + } + ] + }, + "DetailAspectDataTractionBatteryCodeResponse": { + "type": "object", + "properties": { + "productType": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "pack" + }, + "tractionBatteryCode": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "X12MCPM27KLPCLX2M2382320" + }, + "subcomponents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailAspectDataTractionBatteryCodeSubcomponentResponse" + } + } } - } - } - }, - "204" : { - "description" : "No Content." - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "DetailAspectDataTractionBatteryCodeSubcomponentResponse": { + "type": "object", + "properties": { + "productType": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "pack" + }, + "tractionBatteryCode": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "example": "X12MCPM27KLPCLX2M2382320" + } } - } - } - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "DetailAspectModelResponse": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "PART_SITE_INFORMATION_AS_PLANNED", + "enum": [ + "AS_BUILT", + "AS_PLANNED", + "TRACTION_BATTERY_CODE", + "SINGLE_LEVEL_BOM_AS_BUILT", + "SINGLE_LEVEL_USAGE_AS_BUILT", + "SINGLE_LEVEL_BOM_AS_PLANNED", + "PART_SITE_INFORMATION_AS_PLANNED" + ] + }, + "data": { + "$ref": "#/components/schemas/DetailAspectDataResponse" + } } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "PartSiteInformationAsPlannedResponse": { + "type": "object", + "properties": { + "functionValidUntil": { + "type": "string", + "example": "2025-02-08T04:30:48.000Z" + }, + "function": { + "type": "string", + "example": "production" + }, + "functionValidFrom": { + "type": "string", + "example": "2023-10-13T14:30:45+01:00" + }, + "catenaXSiteId": { + "type": "string", + "example": "urn:uuid:0fed587c-7ab4-4597-9841-1718e9693003" + } } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - }, - "/bpn-config/{bpn}" : { - "delete" : { - "tags" : [ - "BpnEdcMapping" - ], - "summary" : "Deletes BPN EDC URL mappings", - "description" : "The endpoint deletes BPN EDC URL mappings", - "operationId" : "deleteBpnEdcUrlMappings", - "parameters" : [ - { - "name" : "bpn", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } - ], - "responses" : { - "401" : { - "description" : "Authorization failed.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "UpdateAssetRequest": { + "required": [ + "qualityType" + ], + "type": "object", + "properties": { + "qualityType": { + "type": "string", + "example": "Ok", + "enum": [ + "Ok", + "Minor", + "Major", + "Critical", + "LifeThreatening" + ] + } } - } - } - }, - "500" : { - "description" : "Internal server error.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "IrsPolicyResponse": { + "type": "object", + "properties": { + "validUntil": { + "type": "string", + "format": "date-time" + }, + "payload": { + "$ref": "#/components/schemas/Payload" + } + }, + "example": [ + { + "validUntil": "2025-12-12T23:59:59.999Z", + "payload": { + "@context": { + "@vocab": "https://w3id.org/edc/v0.0.1/ns/", + "edc": "https://w3id.org/edc/v0.0.1/ns/", + "cx-policy": "https://w3id.org/catenax/policy/", + "odrl": "http://www.w3.org/ns/odrl/2/" + }, + "@id": "policy-id", + "policy": { + "odrl:permission": [ + { + "odrl:action": "use", + "odrl:constraint": { + "odrl:and": [ + { + "odrl:leftOperand": "Membership", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "active" + }, + { + "odrl:leftOperand": "PURPOSE", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "ID 3.1 Trace" + } + ] + } + } + ] + } + } + } + ] + }, + "ConstraintResponse": { + "type": "object", + "properties": { + "leftOperand": { + "type": "string", + "example": "PURPOSE" + }, + "operatorTypeResponse": { + "type": "string", + "enum": [ + "EQ", + "NEQ", + "LT", + "GT", + "IN", + "LTEQ", + "GTEQ", + "ISA", + "HASPART", + "ISPARTOF", + "ISONEOF", + "ISALLOF", + "ISNONEOF" + ] + }, + "rightOperand": { + "type": "string", + "example": "ID Trace 3.1" + } } - } - } - }, - "404" : { - "description" : "Not found.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "ConstraintsResponse": { + "type": "object", + "properties": { + "and": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConstraintResponse" + } + }, + "or": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConstraintResponse" + } + } } - } - } - }, - "429" : { - "description" : "Too many requests.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "PermissionResponse": { + "type": "object", + "properties": { + "action": { + "type": "string", + "example": "USE", + "enum": [ + "ACCESS", + "USE" + ] + }, + "constraints": { + "$ref": "#/components/schemas/ConstraintsResponse" + } } - } - } - }, - "200" : { - "description" : "Okay" - }, - "403" : { - "description" : "Forbidden.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "PolicyResponse": { + "type": "object", + "properties": { + "policyId": { + "type": "string", + "example": "5a00bb50-0253-405f-b9f1-1a3150b9d51d" + }, + "createdOn": { + "type": "string", + "format": "date-time" + }, + "validUntil": { + "type": "string", + "format": "date-time" + }, + "permissions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PermissionResponse" + } + }, + "businessPartnerNumber": { + "type": "string" + } } - } - } - }, - "204" : { - "description" : "Deleted." - }, - "400" : { - "description" : "Bad request.", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "DashboardResponse": { + "type": "object", + "properties": { + "asBuiltCustomerParts": { + "type": "integer", + "format": "int64", + "example": 5 + }, + "asPlannedCustomerParts": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "asBuiltSupplierParts": { + "type": "integer", + "format": "int64", + "example": 2 + }, + "asPlannedSupplierParts": { + "type": "integer", + "format": "int64", + "example": 3 + }, + "asBuiltOwnParts": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "asPlannedOwnParts": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "myPartsWithOpenAlerts": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "myPartsWithOpenInvestigations": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "supplierPartsWithOpenAlerts": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "customerPartsWithOpenAlerts": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "supplierPartsWithOpenInvestigations": { + "type": "integer", + "format": "int64", + "example": 2 + }, + "customerPartsWithOpenInvestigations": { + "type": "integer", + "format": "int64", + "example": 2 + }, + "receivedActiveAlerts": { + "type": "integer", + "format": "int64", + "example": 2 + }, + "receivedActiveInvestigations": { + "type": "integer", + "format": "int64", + "example": 2 + }, + "sentActiveAlerts": { + "type": "integer", + "format": "int64", + "example": 2 + }, + "sentActiveInvestigations": { + "type": "integer", + "format": "int64", + "example": 2 + } } - } - } - }, - "415" : { - "description" : "Unsupported media type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ErrorResponse" + }, + "ImportJobResponse": { + "type": "object", + "properties": { + "importJobStatus": { + "type": "string", + "enum": [ + "INITIALIZING", + "RUNNING", + "ERROR", + "COMPLETED" + ] + }, + "importId": { + "type": "string", + "example": "456a952e-05eb-40dc-a6f2-9c2cb9c1387f" + }, + "startedOn": { + "maxLength": 50, + "type": "string", + "example": "2099-02-21T21:27:10.734950Z" + }, + "completedOn": { + "maxLength": 50, + "type": "string", + "example": "2099-02-21T21:27:10.734950Z" + } + } + }, + "ImportReportResponse": { + "type": "object", + "properties": { + "importJob": { + "$ref": "#/components/schemas/ImportJobResponse" + }, + "importedAsset": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportedAssetResponse" + } + } + } + }, + "ImportedAssetResponse": { + "type": "object", + "properties": { + "importState": { + "type": "string", + "enum": [ + "TRANSIENT", + "PERSISTENT", + "ERROR", + "IN_SYNCHRONIZATION", + "PUBLISHED_TO_CORE_SERVICES", + "UNSET" + ] + }, + "catenaxId": { + "type": "string", + "example": "urn:uuid:7eeeac86-7b69-444d-81e6-655d0f1513bd}" + }, + "importedOn": { + "maxLength": 50, + "type": "string", + "example": "2099-02-21T21:27:10.734950Z" + }, + "importMessage": { + "type": "string", + "example": "Asset created successfully in transient state." + } } - } - } - } - }, - "security" : [ - { - "oAuth2" : [ - "profile email" - ] - } - ] - } - } - }, - "components" : { - "schemas" : { - "UpdatePolicyRequest" : { - "type" : "object", - "properties" : { - "businessPartnerNumbers" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "policyIds" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "validUntil" : { - "type" : "string", - "format" : "date-time" - } - } - }, - "ErrorResponse" : { - "type" : "object", - "properties" : { - "message" : { - "maxLength" : 1000, - "minLength" : 0, - "pattern" : "^.*$", - "type" : "string", - "example" : "Access Denied" - } - } - }, - "EditNotificationRequest" : { - "required" : [ - "affectedPartIds", - "description", - "receiverBpn", - "severity" - ], - "type" : "object", - "properties" : { - "title" : { - "maxLength" : 255, - "minLength" : 1, - "type" : "string", - "example" : "title" - }, - "receiverBpn" : { - "type" : "string", - "example" : "BPNL00000003CNKC" - }, - "severity" : { - "type" : "string", - "enum" : [ - "MINOR", - "MAJOR", - "CRITICAL", - "LIFE-THREATENING" - ] - }, - "targetDate" : { - "type" : "string", - "format" : "date-time", - "example" : "2099-03-11T22:44:06.333826952Z" - }, - "description" : { - "maxLength" : 1000, - "minLength" : 15, - "type" : "string", - "example" : "The description" - }, - "affectedPartIds" : { - "maxLength" : 50, - "minLength" : 1, - "maxItems" : 50, - "minItems" : 1, - "type" : "array", - "example" : [ - "urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978" - ], - "items" : { - "maxLength" : 50, - "minLength" : 1, - "type" : "string", - "example" : "[\"urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978\"]" - } - } - } - }, - "BpnMappingRequest" : { - "required" : [ - "bpn", - "url" - ], - "type" : "object", - "properties" : { - "bpn" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "url" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string" - } - } - }, - "BpnEdcMappingResponse" : { - "type" : "object", - "properties" : { - "bpn" : { - "type" : "string", - "example" : "BPNL00000003CSGV" - }, - "url" : { - "type" : "string", - "example" : "https://trace-x-test-edc.dev.demo.catena-x.net/a1" - } - } - }, - "Constraint" : { - "type" : "object", - "properties" : { - "leftOperand" : { - "type" : "string", - "example" : "string" - }, - "operator" : { - "$ref" : "#/components/schemas/Operator" - }, - "odrl:rightOperand" : { - "type" : "string", - "example" : "string" - } - } - }, - "Constraints" : { - "type" : "object", - "properties" : { - "and" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Constraint" - } - }, - "or" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Constraint" - } - } - } - }, - "Context" : { - "type" : "object", - "properties" : { - "odrl" : { - "type" : "string" - } - } - }, - "Operator" : { - "type" : "object", - "properties" : { - "@id" : { - "type" : "string", - "example" : "odrl:eq", - "enum" : [ - "eq", - "neq", - "lt", - "gt", - "in", - "lteq", - "gteq", - "isA", - "hasPart", - "isPartOf", - "isOneOf", - "isAllOf", - "isNoneOf" - ] - } - } - }, - "Payload" : { - "type" : "object", - "properties" : { - "@context" : { - "$ref" : "#/components/schemas/Context" - }, - "@id" : { - "type" : "string" - }, - "policy" : { - "$ref" : "#/components/schemas/Policy" - } - } - }, - "Permission" : { - "type" : "object", - "properties" : { - "action" : { - "type" : "string", - "example" : "use", - "enum" : [ - "access", - "use" - ] - }, - "constraint" : { - "$ref" : "#/components/schemas/Constraints" - } - } - }, - "Policy" : { - "type" : "object", - "properties" : { - "policyId" : { - "type" : "string", - "example" : "f253718e-a270-4367-901b-9d50d9bd8462" - }, - "createdOn" : { - "type" : "string", - "format" : "date-time" - }, - "validUntil" : { - "type" : "string", - "format" : "date-time" - }, - "permissions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Permission" - } - } - } - }, - "RegisterPolicyRequest" : { - "type" : "object", - "properties" : { - "validUntil" : { - "type" : "string", - "format" : "date-time" - }, - "businessPartnerNumber" : { - "type" : "string" - }, - "payload" : { - "$ref" : "#/components/schemas/Payload" - } - } - }, - "CreatePolicyResponse" : { - "type" : "object", - "properties" : { - "policyId" : { - "type" : "string" - } - } - }, - "StartNotificationRequest" : { - "required" : [ - "receiverBpn", - "severity", - "type" - ], - "type" : "object", - "properties" : { - "title" : { - "maxLength" : 255, - "minLength" : 1, - "type" : "string", - "example" : "title" - }, - "affectedPartIds" : { - "maxLength" : 100, - "minLength" : 1, - "maxItems" : 50, - "minItems" : 1, - "type" : "array", - "example" : [ - "urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978" - ], - "items" : { - "maxLength" : 100, - "minLength" : 1, - "type" : "string", - "example" : "[\"urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978\"]" - } - }, - "description" : { - "maxLength" : 1000, - "minLength" : 15, - "type" : "string", - "example" : "The description" - }, - "targetDate" : { - "type" : "string", - "format" : "date-time", - "example" : "2099-03-11T22:44:06.333826952Z" - }, - "severity" : { - "type" : "string", - "enum" : [ - "MINOR", - "MAJOR", - "CRITICAL", - "LIFE-THREATENING" - ] - }, - "receiverBpn" : { - "type" : "string", - "example" : "BPNL00000003CNKC" - }, - "type" : { - "type" : "string", - "example" : "ALERT", - "enum" : [ - "ALERT", - "INVESTIGATION" - ] - } - } - }, - "NotificationIdResponse" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - } - } - }, - "UpdateNotificationStatusTransitionRequest" : { - "required" : [ - "status" - ], - "type" : "object", - "properties" : { - "status" : { - "type" : "string", - "description" : "The UpdateInvestigationStatus", - "enum" : [ - "ACKNOWLEDGED", - "ACCEPTED", - "DECLINED" - ] - }, - "reason" : { - "type" : "string", - "example" : "The reason." - } - } - }, - "CloseNotificationRequest" : { - "type" : "object", - "properties" : { - "reason" : { - "maxLength" : 1000, - "minLength" : 15, - "type" : "string", - "example" : "The reason." - } - } - }, - "OwnPageable" : { - "type" : "object", - "properties" : { - "page" : { - "type" : "integer", - "format" : "int32" - }, - "size" : { - "type" : "integer", - "format" : "int32" - }, - "sort" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Content of Assets PageResults", - "example" : "manufacturerPartId,desc", - "items" : { - "type" : "string" - } - } - } - }, - "PageableFilterRequest" : { - "type" : "object", - "properties" : { - "pageAble" : { - "$ref" : "#/components/schemas/OwnPageable" - }, - "searchCriteria" : { - "$ref" : "#/components/schemas/SearchCriteriaRequestParam" - } - } - }, - "SearchCriteriaRequestParam" : { - "type" : "object", - "properties" : { - "filter" : { - "maxItems" : 2147483647, - "type" : "array", - "description" : "Filter Criteria", - "example" : "owner,EQUAL,OWN", - "items" : { - "type" : "string" - } - } - } - }, - "NotificationMessageResponse" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "sentBy" : { - "type" : "string" - }, - "sentByName" : { - "type" : "string" - }, - "sendTo" : { - "type" : "string" - }, - "sendToName" : { - "type" : "string" - }, - "contractAgreementId" : { - "type" : "string" - }, - "notificationReferenceId" : { - "type" : "string" - }, - "edcNotificationId" : { - "type" : "string" - }, - "messageDate" : { - "maxLength" : 50, - "type" : "string", - "example" : "2023-02-21T21:27:10.734950Z" - }, - "messageId" : { - "type" : "string" - }, - "status" : { - "type" : "string", - "enum" : [ - "CREATED", - "SENT", - "RECEIVED", - "ACKNOWLEDGED", - "ACCEPTED", - "DECLINED", - "CANCELED", - "CLOSED" - ] - }, - "errorMessage" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "EDC not reachable" - }, - "message" : { - "type" : "string" - } - } - }, - "NotificationResponse" : { - "type" : "object", - "properties" : { - "id" : { - "maximum" : 255, - "minimum" : 0, - "maxLength" : 255, - "type" : "integer", - "format" : "int64", - "example" : 66 - }, - "title" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Title" - }, - "status" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "CREATED", - "enum" : [ - "CREATED", - "SENT", - "RECEIVED", - "ACKNOWLEDGED", - "ACCEPTED", - "DECLINED", - "CANCELED", - "CLOSED" - ] - }, - "description" : { - "maxLength" : 1000, - "minLength" : 0, - "type" : "string", - "example" : "DescriptionText" - }, - "createdBy" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003AYRE" - }, - "createdByName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "createdDate" : { - "maxLength" : 50, - "minLength" : 0, - "type" : "string", - "example" : "2023-02-21T21:27:10.734950Z" - }, - "updatedDate" : { - "maxLength" : 50, - "minLength" : 0, - "type" : "string", - "example" : "2023-02-21T21:27:10.734950Z" - }, - "assetIds" : { - "maxItems" : 1000, - "minItems" : 0, - "type" : "array", - "example" : [ - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd", - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd", - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd" - ], - "items" : { - "type" : "string", - "example" : "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd\"]" - } - }, - "channel" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "SENDER", - "enum" : [ - "SENDER", - "RECEIVER" - ] - }, - "sendTo" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "BPNL00000003AYRE" - }, - "sendToName" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Tier C" - }, - "severity" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "MINOR", - "enum" : [ - "MINOR", - "MAJOR", - "CRITICAL", - "LIFE-THREATENING" - ] - }, - "type" : { - "maxLength" : 50, - "minLength" : 0, - "type" : "string", - "example" : "ALERT", - "enum" : [ - "ALERT", - "INVESTIGATION" - ] - }, - "targetDate" : { - "maxLength" : 50, - "minLength" : 0, - "type" : "string", - "example" : "2099-02-21T21:27:10.734950Z" - }, - "messages" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NotificationMessageResponse" - } - } - } - }, - "CreateNotificationContractRequest" : { - "required" : [ - "notificationMethod", - "notificationType" - ], - "type" : "object", - "properties" : { - "notificationType" : { - "type" : "string", - "enum" : [ - "QUALITY_INVESTIGATION", - "QUALITY_ALERT" - ] - }, - "notificationMethod" : { - "type" : "string", - "enum" : [ - "RECEIVE", - "UPDATE", - "RESOLVE" - ] - } - } - }, - "CreateNotificationContractResponse" : { - "type" : "object", - "properties" : { - "notificationAssetId" : { - "type" : "string", - "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "accessPolicyId" : { - "type" : "string", - "example" : "123" - }, - "contractDefinitionId" : { - "type" : "string", - "example" : "456" - } - } - }, - "ContractResponse" : { - "type" : "object", - "properties" : { - "contractId" : { - "maxLength" : 255, - "type" : "string", - "example" : "66" - }, - "counterpartyAddress" : { - "maxLength" : 255, - "type" : "string", - "example" : "https://trace-x-edc-e2e-a.dev.demo.catena-x.net/api/v1/dsp" - }, - "creationDate" : { - "maxLength" : 255, - "type" : "string", - "format" : "date-time", - "example" : "2023-02-21T21:27:10.73495Z" - }, - "endDate" : { - "maxLength" : 255, - "type" : "string", - "format" : "date-time", - "example" : "2023-02-21T21:27:10.73495Z" - }, - "state" : { - "maxLength" : 255, - "type" : "string", - "example" : "FINALIZED" - }, - "policy" : { - "maxLength" : 255, - "type" : "string", - "example" : "{\\\"@id\\\":\\\"eb0c8486-914a-4d36-84c0-b4971cbc52e4\\\",\\\"@type\\\":\\\"odrl:Set\\\",\\\"odrl:permission\\\":{\\\"odrl:target\\\":\\\"registry-asset\\\",\\\"odrl:action\\\":{\\\"odrl:type\\\":\\\"USE\\\"},\\\"odrl:constraint\\\":{\\\"odrl:or\\\":{\\\"odrl:leftOperand\\\":\\\"PURPOSE\\\",\\\"odrl:operator\\\":{\\\"@id\\\":\\\"odrl:eq\\\"},\\\"odrl:rightOperand\\\":\\\"ID 3.0 Trace\\\"}}},\\\"odrl:prohibition\\\":[],\\\"odrl:obligation\\\":[],\\\"odrl:target\\\":\\\"registry-asset\\\"}" - } - } - }, - "PageResultContractResponse" : { - "type" : "object", - "properties" : { - "content" : { - "maxItems" : 2147483647, - "minItems" : 0, - "type" : "array", - "description" : "Content of PageResults", - "items" : { - "$ref" : "#/components/schemas/ContractResponse" - } - }, - "page" : { - "type" : "integer", - "format" : "int32", - "example" : 1 - }, - "pageCount" : { - "type" : "integer", - "format" : "int32", - "example" : 15 - }, - "pageSize" : { - "type" : "integer", - "format" : "int32", - "example" : 10 - }, - "totalItems" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - } - }, - "RegisterAssetRequest" : { - "required" : [ - "assetIds", - "policyId" - ], - "type" : "object", - "properties" : { - "policyId" : { - "type" : "string", - "example" : "a644a7cb-3de5-493b-9259-f01db315a46e" - }, - "assetIds" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - }, - "ImportResponse" : { - "type" : "object", - "properties" : { - "jobId" : { - "type" : "string" - }, - "importStateMessage" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ImportStateMessage" - } - }, - "validationResult" : { - "$ref" : "#/components/schemas/ValidationResponse" - } - } - }, - "ImportStateMessage" : { - "type" : "object", - "properties" : { - "catenaXId" : { - "type" : "string" - }, - "persistedOrUpdated" : { - "type" : "boolean" - } - } - }, - "ValidationResponse" : { - "type" : "object", - "properties" : { - "validationErrors" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - }, - "SyncAssetsRequest" : { - "type" : "object", - "properties" : { - "globalAssetIds" : { - "maxItems" : 100, - "minItems" : 1, - "type" : "array", - "example" : [ - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - ], - "items" : { - "type" : "string", - "example" : "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\"]" - } - } - } - }, - "GetDetailInformationRequest" : { - "type" : "object", - "properties" : { - "assetIds" : { - "maxLength" : 50, - "minLength" : 1, - "maxItems" : 50, - "minItems" : 1, - "type" : "array", - "example" : [ - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - ], - "items" : { - "maxLength" : 50, - "minLength" : 1, - "type" : "string", - "example" : "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\"]" - } - } - } - }, - "DescriptionsResponse" : { - "type" : "object", - "properties" : { - "id" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "urn:uuid:a4a26b9c-9460-4cc5-8645-85916b86adb0" - }, - "idShort" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "assembly-part-relationship" - } - } - }, - "DetailAspectDataAsBuiltResponse" : { - "type" : "object", - "properties" : { - "partId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "95657762-59" - }, - "customerPartId" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "01697F7-65" - }, - "nameAtCustomer" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "Door front-left" - }, - "manufacturingCountry" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "DEU" - }, - "manufacturingDate" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "2022-02-04T13:48:54Z" - } - } - }, - "DetailAspectDataAsPlannedResponse" : { - "type" : "object", - "properties" : { - "validityPeriodFrom" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "2022-09-26T12:43:51.079Z" - }, - "validityPeriodTo" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "20232-07-13T12:00:00.000Z" - } - } - }, - "DetailAspectDataResponse" : { - "type" : "object", - "oneOf" : [ - { - "$ref" : "#/components/schemas/DetailAspectDataAsBuiltResponse" - }, - { - "$ref" : "#/components/schemas/DetailAspectDataAsPlannedResponse" - }, - { - "$ref" : "#/components/schemas/PartSiteInformationAsPlannedResponse" - }, - { - "$ref" : "#/components/schemas/DetailAspectDataTractionBatteryCodeResponse" - } - ] - }, - "DetailAspectDataTractionBatteryCodeResponse" : { - "type" : "object", - "properties" : { - "productType" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "pack" - }, - "tractionBatteryCode" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "X12MCPM27KLPCLX2M2382320" - }, - "subcomponents" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DetailAspectDataTractionBatteryCodeSubcomponentResponse" } - } - } - }, - "DetailAspectDataTractionBatteryCodeSubcomponentResponse" : { - "type" : "object", - "properties" : { - "productType" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "pack" - }, - "tractionBatteryCode" : { - "maxLength" : 255, - "minLength" : 0, - "type" : "string", - "example" : "X12MCPM27KLPCLX2M2382320" - } - } - }, - "DetailAspectModelResponse" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "example" : "PART_SITE_INFORMATION_AS_PLANNED", - "enum" : [ - "AS_BUILT", - "AS_PLANNED", - "TRACTION_BATTERY_CODE", - "SINGLE_LEVEL_BOM_AS_BUILT", - "SINGLE_LEVEL_USAGE_AS_BUILT", - "SINGLE_LEVEL_BOM_AS_PLANNED", - "PART_SITE_INFORMATION_AS_PLANNED" - ] - }, - "data" : { - "$ref" : "#/components/schemas/DetailAspectDataResponse" - } - } - }, - "PartSiteInformationAsPlannedResponse" : { - "type" : "object", - "properties" : { - "functionValidUntil" : { - "type" : "string", - "example" : "2025-02-08T04:30:48.000Z" - }, - "function" : { - "type" : "string", - "example" : "production" - }, - "functionValidFrom" : { - "type" : "string", - "example" : "2023-10-13T14:30:45+01:00" - }, - "catenaXSiteId" : { - "type" : "string", - "example" : "urn:uuid:0fed587c-7ab4-4597-9841-1718e9693003" - } - } - }, - "UpdateAssetRequest" : { - "required" : [ - "qualityType" - ], - "type" : "object", - "properties" : { - "qualityType" : { - "type" : "string", - "example" : "Ok", - "enum" : [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - } - } - }, - "IrsPolicyResponse" : { - "type" : "object", - "properties" : { - "validUntil" : { - "type" : "string", - "format" : "date-time" - }, - "payload" : { - "$ref" : "#/components/schemas/Payload" - } }, - "example" : [ - { - "validUntil" : "2025-12-12T23:59:59.999Z", - "payload" : { - "@context" : { - "@vocab" : "https://w3id.org/edc/v0.0.1/ns/", - "edc" : "https://w3id.org/edc/v0.0.1/ns/", - "cx-policy" : "https://w3id.org/catenax/policy/", - "odrl" : "http://www.w3.org/ns/odrl/2/" - }, - "@id" : "policy-id", - "policy" : { - "odrl:permission" : [ - { - "odrl:action" : "use", - "odrl:constraint" : { - "odrl:and" : [ - { - "odrl:leftOperand" : "Membership", - "odrl:operator" : { - "@id" : "odrl:eq" - }, - "odrl:rightOperand" : "active" - }, - { - "odrl:leftOperand" : "PURPOSE", - "odrl:operator" : { - "@id" : "odrl:eq" - }, - "odrl:rightOperand" : "ID 3.1 Trace" - } - ] - } - } - ] - } - } - } - ] - }, - "ConstraintResponse" : { - "type" : "object", - "properties" : { - "leftOperand" : { - "type" : "string", - "example" : "PURPOSE" - }, - "operatorTypeResponse" : { - "type" : "string", - "enum" : [ - "EQ", - "NEQ", - "LT", - "GT", - "IN", - "LTEQ", - "GTEQ", - "ISA", - "HASPART", - "ISPARTOF", - "ISONEOF", - "ISALLOF", - "ISNONEOF" - ] - }, - "rightOperand" : { - "type" : "string", - "example" : "ID Trace 3.1" - } - } - }, - "ConstraintsResponse" : { - "type" : "object", - "properties" : { - "and" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ConstraintResponse" - } - }, - "or" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ConstraintResponse" - } - } - } - }, - "PermissionResponse" : { - "type" : "object", - "properties" : { - "action" : { - "type" : "string", - "example" : "USE", - "enum" : [ - "ACCESS", - "USE" - ] - }, - "constraints" : { - "$ref" : "#/components/schemas/ConstraintsResponse" - } - } - }, - "PolicyResponse" : { - "type" : "object", - "properties" : { - "policyId" : { - "type" : "string", - "example" : "5a00bb50-0253-405f-b9f1-1a3150b9d51d" - }, - "createdOn" : { - "type" : "string", - "format" : "date-time" - }, - "validUntil" : { - "type" : "string", - "format" : "date-time" - }, - "permissions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PermissionResponse" - } - }, - "businessPartnerNumber" : { - "type" : "string" - } - } - }, - "DashboardResponse" : { - "type" : "object", - "properties" : { - "asBuiltCustomerParts" : { - "type" : "integer", - "format" : "int64", - "example" : 5 - }, - "asPlannedCustomerParts" : { - "type" : "integer", - "format" : "int64", - "example" : 10 - }, - "asBuiltSupplierParts" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - }, - "asPlannedSupplierParts" : { - "type" : "integer", - "format" : "int64", - "example" : 3 - }, - "asBuiltOwnParts" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - }, - "asPlannedOwnParts" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - }, - "myPartsWithOpenAlerts" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - }, - "myPartsWithOpenInvestigations" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - }, - "supplierPartsWithOpenAlerts" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - }, - "customerPartsWithOpenAlerts" : { - "type" : "integer", - "format" : "int64", - "example" : 1 - }, - "supplierPartsWithOpenInvestigations" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - }, - "customerPartsWithOpenInvestigations" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - }, - "receivedActiveAlerts" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - }, - "receivedActiveInvestigations" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - }, - "sentActiveAlerts" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - }, - "sentActiveInvestigations" : { - "type" : "integer", - "format" : "int64", - "example" : 2 - } - } - }, - "ImportJobResponse" : { - "type" : "object", - "properties" : { - "importJobStatus" : { - "type" : "string", - "enum" : [ - "INITIALIZING", - "RUNNING", - "ERROR", - "COMPLETED" - ] - }, - "importId" : { - "type" : "string", - "example" : "456a952e-05eb-40dc-a6f2-9c2cb9c1387f" - }, - "startedOn" : { - "maxLength" : 50, - "type" : "string", - "example" : "2099-02-21T21:27:10.734950Z" - }, - "completedOn" : { - "maxLength" : 50, - "type" : "string", - "example" : "2099-02-21T21:27:10.734950Z" - } - } - }, - "ImportReportResponse" : { - "type" : "object", - "properties" : { - "importJob" : { - "$ref" : "#/components/schemas/ImportJobResponse" - }, - "importedAsset" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ImportedAssetResponse" - } - } - } - }, - "ImportedAssetResponse" : { - "type" : "object", - "properties" : { - "importState" : { - "type" : "string", - "enum" : [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "catenaxId" : { - "type" : "string", - "example" : "urn:uuid:7eeeac86-7b69-444d-81e6-655d0f1513bd}" - }, - "importedOn" : { - "maxLength" : 50, - "type" : "string", - "example" : "2099-02-21T21:27:10.734950Z" - }, - "importMessage" : { - "type" : "string", - "example" : "Asset created successfully in transient state." - } - } - } - }, - "securitySchemes" : { - "oAuth2" : { - "type" : "oauth2", - "flows" : { - "clientCredentials" : { - "tokenUrl" : "https://example.com/api/oauth/token", - "scopes" : { - "profile email" : "" + "securitySchemes": { + "oAuth2": { + "type": "oauth2", + "flows": { + "clientCredentials": { + "tokenUrl": "https://example.com/api/oauth/token", + "scopes": { + "profile email": "" + } + } + } } - } } - } } - } -} +} \ No newline at end of file From 0cf1217ddbef2249cc3de25226f9690fd7c5a6fb Mon Sep 17 00:00:00 2001 From: Martin Maul Date: Mon, 24 Jun 2024 15:48:22 +0200 Subject: [PATCH 04/14] chore(contract): 1037 reference to assets for contract id --- .../multi-select-autocomplete.component.ts | 10 +++++++++- .../components/parts-table/parts-table.component.html | 1 + .../components/parts-table/parts-table.component.ts | 5 ++++- .../shared/components/table/table.component.html | 10 ++++++++++ frontend/src/assets/locales/de/common.json | 2 +- frontend/src/assets/locales/en/common.json | 2 +- 6 files changed, 26 insertions(+), 4 deletions(-) diff --git a/frontend/src/app/modules/shared/components/multi-select-autocomplete/multi-select-autocomplete.component.ts b/frontend/src/app/modules/shared/components/multi-select-autocomplete/multi-select-autocomplete.component.ts index 59d574c0d4..453c446046 100644 --- a/frontend/src/app/modules/shared/components/multi-select-autocomplete/multi-select-autocomplete.component.ts +++ b/frontend/src/app/modules/shared/components/multi-select-autocomplete/multi-select-autocomplete.component.ts @@ -106,6 +106,7 @@ export class MultiSelectAutocompleteComponent implements OnChanges { suggestionError: boolean = false; isLoadingSuggestions: boolean; + @Input() prefilterValue?: string; constructor(public datePipe: DatePipe, public _adapter: DateAdapter, @Inject(MAT_DATE_LOCALE) public _locale: string, @Inject(LOCALE_ID) private locale: string, public partsService: PartsService, @@ -125,6 +126,13 @@ export class MultiSelectAutocompleteComponent implements OnChanges { } }); + if (this.prefilterValue?.length > 0) { + this.searchElement = this.prefilterValue; + this.selectedValue = [ this.searchElement ]; + this.formControl.patchValue(this.selectedValue); + this.updateOptionsAndSelections(); + } + } ngOnChanges(): void { @@ -184,7 +192,7 @@ export class MultiSelectAutocompleteComponent implements OnChanges { filterItem(value: any): void { - if (!this.searchElement.length) { + if (!this.searchElement?.length) { return; } diff --git a/frontend/src/app/modules/shared/components/parts-table/parts-table.component.html b/frontend/src/app/modules/shared/components/parts-table/parts-table.component.html index c889fd4827..80c4249da0 100644 --- a/frontend/src/app/modules/shared/components/parts-table/parts-table.component.html +++ b/frontend/src/app/modules/shared/components/parts-table/parts-table.component.html @@ -135,6 +135,7 @@ [isDate]="filter.isDate" [singleSearch]="filter.singleSearch" [filterColumn]="filter.filterKey" + [prefilterValue]="filter.headerKey === 'filtercontractAgreementId' ? preFilter : null" [tableType]="tableType" [inAssetIds]="assetIdsForAutoCompleteFilter" [placeholderMultiple]="('multiSelect.multipleResults' | i18n)" diff --git a/frontend/src/app/modules/shared/components/parts-table/parts-table.component.ts b/frontend/src/app/modules/shared/components/parts-table/parts-table.component.ts index 9ec976ecd5..673ab802c7 100644 --- a/frontend/src/app/modules/shared/components/parts-table/parts-table.component.ts +++ b/frontend/src/app/modules/shared/components/parts-table/parts-table.component.ts @@ -34,7 +34,7 @@ import { MatDialog, MatDialogConfig } from '@angular/material/dialog'; import { MatPaginator, PageEvent } from '@angular/material/paginator'; import { MatSort, Sort } from '@angular/material/sort'; import { MatTableDataSource } from '@angular/material/table'; -import { Router } from '@angular/router'; +import { ActivatedRoute, Router } from '@angular/router'; import { EmptyPagination, Pagination } from '@core/model/pagination.model'; import { RoleService } from '@core/user/role.service'; import { TableSettingsService } from '@core/user/table-settings.service'; @@ -88,6 +88,7 @@ export class PartsTableComponent implements OnInit { @Input() assetIdsForAutoCompleteFilter: string[]; + preFilter: string; public tableConfig: TableConfig; @Input() set paginationData({ page, pageSize, totalItems, content }: Pagination) { @@ -134,9 +135,11 @@ export class PartsTableComponent implements OnInit { public readonly userSettingsService: BomLifecycleSettingsService, private dialog: MatDialog, private router: Router, + private route: ActivatedRoute, private deeplinkService: DeeplinkService, public roleService: RoleService, ) { + this.preFilter = route.snapshot.queryParams['contractId']; } handleKeyDownOpenDialog(event: KeyboardEvent) { diff --git a/frontend/src/app/modules/shared/components/table/table.component.html b/frontend/src/app/modules/shared/components/table/table.component.html index ed659cab80..83c43ef666 100644 --- a/frontend/src/app/modules/shared/components/table/table.component.html +++ b/frontend/src/app/modules/shared/components/table/table.component.html @@ -341,7 +341,17 @@

{{ 'table.noResultFound' | i18n }}

mat-menu-item > {{ config.icon }} +
{{ config.label | i18n }} +
diff --git a/frontend/src/assets/locales/de/common.json b/frontend/src/assets/locales/de/common.json index 37ea435d04..179d7f857e 100644 --- a/frontend/src/assets/locales/de/common.json +++ b/frontend/src/assets/locales/de/common.json @@ -178,7 +178,7 @@ "bpn" : "BPN Selektion", "constraints" : "Bedingungen", "accessType" : "Zugriffsart", - "contractAgreementId" : "Vertragsvereinbarungs-ID" + "contractAgreementId" : "Vertrags-ID" } }, "dataLoading": { diff --git a/frontend/src/assets/locales/en/common.json b/frontend/src/assets/locales/en/common.json index 3ec25d26ad..83e801f30a 100644 --- a/frontend/src/assets/locales/en/common.json +++ b/frontend/src/assets/locales/en/common.json @@ -174,7 +174,7 @@ "bpn" : "BPN selection", "constraints" : "Constraints", "accessType" : "Access type", - "contractAgreementId" : "Contract agreement ID" + "contractAgreementId" : "Contract ID" } }, "dataLoading": { From f4b807992cdaa0d247f1b46c354af670b8deefc5 Mon Sep 17 00:00:00 2001 From: Martin Maul Date: Mon, 24 Jun 2024 16:04:30 +0200 Subject: [PATCH 05/14] chore(contract): 1037 fixed tests --- CHANGELOG.md | 1 + .../src/app/modules/core/user/table-settings.service.spec.ts | 4 ++-- .../components/parts-table/parts-table.component.spec.ts | 2 ++ 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a306348c07..7bbde90420 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,7 @@ _**For better traceability add the corresponding GitHub issue number in each cha - #737 Added concept: Contract table -> parts link action - XXX Added interceptor to EdcRestTemplates to log requests - #915 Added section to documentation: EDC-BPN configuration +- #1037 Added link from contracts view to the corresponding filtered part table view ### Removed diff --git a/frontend/src/app/modules/core/user/table-settings.service.spec.ts b/frontend/src/app/modules/core/user/table-settings.service.spec.ts index 6e2aed7296..bafd29d9a1 100644 --- a/frontend/src/app/modules/core/user/table-settings.service.spec.ts +++ b/frontend/src/app/modules/core/user/table-settings.service.spec.ts @@ -42,12 +42,12 @@ describe('TableSettingsService', () => { it('should return PartsAsPlannedConfigurationModel for AS_PLANNED_OWN', () => { const result: TableViewConfig = service.initializeTableViewSettings(TableType.AS_PLANNED_OWN); - expect(result.displayedColumns.length).toBe(20); + expect(result.displayedColumns.length).toBe(21); }); it('should return PartsAsBuiltConfigurationModel for AS_BUILT_OWN', () => { const result: TableViewConfig = service.initializeTableViewSettings(TableType.AS_BUILT_OWN); - expect(result.displayedColumns.length).toBe(22); + expect(result.displayedColumns.length).toBe(23); }); it('should return NotificationsSentConfigurationModel for SENT_NOTIFICATION', () => { diff --git a/frontend/src/app/modules/shared/components/parts-table/parts-table.component.spec.ts b/frontend/src/app/modules/shared/components/parts-table/parts-table.component.spec.ts index c901166e82..c3d1315501 100644 --- a/frontend/src/app/modules/shared/components/parts-table/parts-table.component.spec.ts +++ b/frontend/src/app/modules/shared/components/parts-table/parts-table.component.spec.ts @@ -140,6 +140,7 @@ describe('PartsTableComponent', () => { 'filtersentActiveInvestigations', 'filterimportState', 'filterimportNote', + 'filtercontractAgreementId', 'Menu', ]); }); @@ -170,6 +171,7 @@ describe('PartsTableComponent', () => { 'filterfunctionValidUntil', 'filterimportState', 'filterimportNote', + 'filtercontractAgreementId', 'Menu', ]); }); From 3ae8482dc86bd5350cfb3dca2dc4611b25fce85d Mon Sep 17 00:00:00 2001 From: pweick Date: Mon, 24 Jun 2024 16:16:36 +0200 Subject: [PATCH 06/14] fix: Test generating OpenAPI spec now only generates one file --- .github/workflows/openapi-doc-check.yml | 11 +++++------ .../openapi/OpenApiDocumentationIT.java | 14 +++----------- 2 files changed, 8 insertions(+), 17 deletions(-) diff --git a/.github/workflows/openapi-doc-check.yml b/.github/workflows/openapi-doc-check.yml index 5edf2274c9..ee93ef44bd 100644 --- a/.github/workflows/openapi-doc-check.yml +++ b/.github/workflows/openapi-doc-check.yml @@ -15,11 +15,9 @@ # # SPDX-License-Identifier: Apache-2.0 -name: "[BE] Check if OpenApi doc is up to date" +name: "[BE] Update OpenAPI spec" on: - schedule: - - cron: '0 0 * * *' # run daily at midnight workflow_dispatch: jobs: @@ -37,7 +35,7 @@ jobs: distribution: 'temurin' cache: 'maven' - - name: Update OpenApi document + - name: Update OpenApi spec run: mvn test -Dsurefire.failIfNoSpecifiedTests=false -Dtest=OpenApiDocumentationIT -Dopenapi-doc.generate=true -am - name: Configure Git @@ -49,6 +47,7 @@ jobs: uses: peter-evans/create-pull-request@v6 with: token: ${{ secrets.GITHUB_TOKEN }} - branch: action/openapi-doc-update - title: "chore(OpenApi): updated OpenApi document for release" + branch: action/update-openapi-spec + title: "chore(OpenApi): updated OpenApi spec for release" labels: automated + delete-branch: true diff --git a/tx-backend/src/test/java/org/eclipse/tractusx/traceability/integration/openapi/OpenApiDocumentationIT.java b/tx-backend/src/test/java/org/eclipse/tractusx/traceability/integration/openapi/OpenApiDocumentationIT.java index 34fc78d09a..4ff14714e1 100644 --- a/tx-backend/src/test/java/org/eclipse/tractusx/traceability/integration/openapi/OpenApiDocumentationIT.java +++ b/tx-backend/src/test/java/org/eclipse/tractusx/traceability/integration/openapi/OpenApiDocumentationIT.java @@ -26,7 +26,6 @@ import java.io.File; import java.io.IOException; import java.nio.charset.StandardCharsets; -import java.util.List; import static io.restassured.RestAssured.given; import static org.apache.commons.io.FileUtils.writeStringToFile; @@ -34,11 +33,10 @@ @EnabledIf(expression = "${openapi-doc.generate}", loadContext = true) class OpenApiDocumentationIT extends IntegrationTestSpecification { - private static final List API_DOCUMENTATION_LOCATIONS = List.of("./openapi/traceability-foss-backend.json", - "../docs/api/traceability-foss-backend.json"); + private static final String API_DOCUMENTATION_LOCATION = "../docs/api/traceability-foss-backend.json"; @Test - void shouldGenerateOpenApiDoc() { + void shouldGenerateOpenApiSpec() throws IOException { // when var response = given() .when() @@ -48,12 +46,6 @@ void shouldGenerateOpenApiDoc() { response.then() .statusCode(200); - API_DOCUMENTATION_LOCATIONS.forEach(location -> { - try { - writeStringToFile(new File(location), response.body().asPrettyString(), StandardCharsets.UTF_8); - } catch (IOException e) { - throw new RuntimeException(e); - } - }); + writeStringToFile(new File(API_DOCUMENTATION_LOCATION), response.body().asPrettyString(), StandardCharsets.UTF_8); } } From 4fce350c43a7580908a468492175b756d2a4ebcb Mon Sep 17 00:00:00 2001 From: pweick Date: Mon, 24 Jun 2024 16:51:05 +0200 Subject: [PATCH 07/14] feature(release): release workflow now updates OpenAPI spec - separate workflow for the purpose of updating the spec has been removed --- .github/workflows/openapi-doc-check.yml | 53 ------------------------- .github/workflows/release.yaml | 25 ++++++++++++ 2 files changed, 25 insertions(+), 53 deletions(-) delete mode 100644 .github/workflows/openapi-doc-check.yml diff --git a/.github/workflows/openapi-doc-check.yml b/.github/workflows/openapi-doc-check.yml deleted file mode 100644 index ee93ef44bd..0000000000 --- a/.github/workflows/openapi-doc-check.yml +++ /dev/null @@ -1,53 +0,0 @@ -# Copyright (c) 2024 Contributors to the Eclipse Foundation -# -# See the NOTICE file(s) distributed with this work for additional -# information regarding copyright ownership. -# -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 - -name: "[BE] Update OpenAPI spec" - -on: - workflow_dispatch: - -jobs: - check: - runs-on: ubuntu-latest - - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - - name: Set up JDK - uses: actions/setup-java@v4 - with: - java-version: 17 - distribution: 'temurin' - cache: 'maven' - - - name: Update OpenApi spec - run: mvn test -Dsurefire.failIfNoSpecifiedTests=false -Dtest=OpenApiDocumentationIT -Dopenapi-doc.generate=true -am - - - name: Configure Git - run: | - git config user.name "$GITHUB_ACTOR" - git config user.email "$GITHUB_ACTOR@users.noreply.github.com" - - - name: Create pull request - uses: peter-evans/create-pull-request@v6 - with: - token: ${{ secrets.GITHUB_TOKEN }} - branch: action/update-openapi-spec - title: "chore(OpenApi): updated OpenApi spec for release" - labels: automated - delete-branch: true diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 595e9cb6da..675b8c70e4 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -6,6 +6,8 @@ on: tags: - '[0-9]+.[0-9]+.[0-9]+' +env: + JAVA_VERSION: 17 jobs: release: @@ -13,6 +15,13 @@ jobs: steps: - uses: actions/checkout@v4 + - name: Set up JDK + uses: actions/setup-java@v4 + with: + java-version: '${{ env.JAVA_VERSION }}' + distribution: 'temurin' + cache: 'maven' + - name: Calculate Helm release version from CHANGELOG run: echo HELM_VERSION=$(cat charts/traceability-foss/CHANGELOG.md | sed -n 's/.*\[\([0-9]\+\.[0-9]\+\.[0-9]\+\)\].*/\1/p' | head -n 1) >> $GITHUB_ENV @@ -74,6 +83,22 @@ jobs: Please check whether the Chart was updated correctly and that the CHANGELOG contains the relevant information for this release. Also, make sure that the values.yaml is correct before merging this PR. + - name: Update OpenAPI spec + run: mvn test -Dsurefire.failIfNoSpecifiedTests=false -Dtest=OpenApiDocumentationIT -Dopenapi-doc.generate=true + + - name: Create pull request + uses: peter-evans/create-pull-request@v6 + with: + token: ${{ secrets.GITHUB_TOKEN }} + branch: action/update-openapi-spec + title: "chore(OpenAPI): updated OpenAPI spec" + labels: automated + delete-branch: true + body: | + This PR updates the OpenAPI spec. Please check whether the spec was updated correctly. Unfortunately, this + action causes a lot of nonsensical changes which should, however, be clearly recognizable. + You can safely ignore these. + - name: Get previous version run: echo PREVIOUS_VERSION=$(git tag | grep -E ^[0-9]+\\.[0-9]+\\.[0-9]+ | tail -2 | head -n +1) >> $GITHUB_ENV From 5c5f758ed49204529ac2bf37d84abca486165e06 Mon Sep 17 00:00:00 2001 From: pweick Date: Mon, 24 Jun 2024 16:55:10 +0200 Subject: [PATCH 08/14] chore(OpenAPI):[xxx] remove leftover spec file --- .../openapi/traceability-foss-backend.json | 8123 ----------------- 1 file changed, 8123 deletions(-) delete mode 100644 tx-backend/openapi/traceability-foss-backend.json diff --git a/tx-backend/openapi/traceability-foss-backend.json b/tx-backend/openapi/traceability-foss-backend.json deleted file mode 100644 index 371e20c363..0000000000 --- a/tx-backend/openapi/traceability-foss-backend.json +++ /dev/null @@ -1,8123 +0,0 @@ -{ - "openapi": "3.0.1", - "info": { - "title": "Tractus-X Traceability Foss", - "description": "Trace-FOSS is a system 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. This saves costs by seamlessly tracking parts and creates trust through clearly defined and secure data access by the companies and persons involved in the process.", - "license": { - "name": "License: Apache 2.0" - }, - "version": "1.0.0" - }, - "servers": [ - { - "url": "http://localhost:9998/api", - "description": "Generated server url" - } - ], - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ], - "paths": { - "/policies": { - "get": { - "tags": [ - "Policies" - ], - "summary": "Get all policies ", - "description": "The endpoint returns all policies .", - "operationId": "policy", - "responses": { - "200": { - "description": "Returns the policies", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IrsPolicyResponse" - } - } - } - }, - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - }, - "put": { - "tags": [ - "Policies" - ], - "summary": "Updates policies ", - "description": "The endpoint updates policies.", - "operationId": "updatePolicy", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdatePolicyRequest" - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Update successful", - "content": { - "application/json": { - - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - }, - "post": { - "tags": [ - "Policies" - ], - "summary": "Create a policy ", - "description": "The endpoint creates a policy.", - "operationId": "createPolicy", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RegisterPolicyRequest" - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns the policies", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreatePolicyResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}/edit": { - "put": { - "tags": [ - "Notifications" - ], - "summary": "Update notification by id", - "description": "The endpoint updates notification by their id.", - "operationId": "updateNotification", - "parameters": [ - { - "name": "notificationId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EditNotificationRequest" - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "204": { - "description": "No content." - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/bpn-config": { - "get": { - "tags": [ - "BpnEdcMapping" - ], - "summary": "Get BPN EDC URL mappings", - "description": "The endpoint returns a result of BPN EDC URL mappings.", - "operationId": "getBpnEdcs", - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns the paged result found", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/BpnEdcMappingResponse" - } - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - }, - "put": { - "tags": [ - "BpnEdcMapping" - ], - "summary": "Updates BPN EDC URL mappings", - "description": "The endpoint updates BPN EDC URL mappings", - "operationId": "updateBpnEdcMappings", - "requestBody": { - "content": { - "application/json": { - "schema": { - "maxItems": 1000, - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/BpnMappingRequest" - } - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns the paged result found for BpnEdcMapping", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/BpnEdcMappingResponse" - } - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - }, - "post": { - "tags": [ - "BpnEdcMapping" - ], - "summary": "Creates BPN EDC URL mappings", - "description": "The endpoint creates BPN EDC URL mappings", - "operationId": "createBpnEdcUrlMappings", - "requestBody": { - "content": { - "application/json": { - "schema": { - "maxItems": 1000, - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/BpnMappingRequest" - } - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns the paged result found for BpnEdcMapping", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/BpnEdcMappingResponse" - } - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/submodel/data/{submodelId}": { - "get": { - "tags": [ - "Submodel" - ], - "summary": "Gets Submodel by its id", - "description": "The endpoint returns Submodel for given id. Used for data providing functionality", - "operationId": "getSubmodelById", - "parameters": [ - { - "name": "submodelId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns submodel payload", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - }, - "post": { - "tags": [ - "Submodel" - ], - "summary": "Save Submodel", - "description": "This endpoint allows you to save a Submodel identified by its ID.", - "operationId": "saveSubmodel", - "parameters": [ - { - "name": "submodelId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Ok." - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "204": { - "description": "No Content." - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/notifications": { - "post": { - "tags": [ - "Notifications" - ], - "summary": "Start notification by part ids", - "description": "The endpoint starts notification based on part ids provided.", - "operationId": "notifyAssets", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StartNotificationRequest" - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "201": { - "description": "Created.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationIdResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}/update": { - "post": { - "tags": [ - "Notifications" - ], - "summary": "Update notification by id", - "description": "The endpoint updates notification by their id.", - "operationId": "updateNotification_1", - "parameters": [ - { - "name": "notificationId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateNotificationStatusTransitionRequest" - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "204": { - "description": "No content." - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}/close": { - "post": { - "tags": [ - "Notifications" - ], - "summary": "Close notification by id", - "description": "The endpoint closes Notification by id.", - "operationId": "closeNotification", - "parameters": [ - { - "name": "notificationId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CloseNotificationRequest" - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Ok." - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "204": { - "description": "No content." - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}/cancel": { - "post": { - "tags": [ - "Notifications" - ], - "summary": "Cancels notification by id", - "description": "The endpoint cancels notification by id.", - "operationId": "cancelNotification", - "parameters": [ - { - "name": "notificationId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Ok." - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "204": { - "description": "No content." - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}/approve": { - "post": { - "tags": [ - "Notifications" - ], - "summary": "Approves notification by id", - "description": "The endpoint approves notification by id.", - "operationId": "approveNotification", - "parameters": [ - { - "name": "notificationId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Ok." - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "204": { - "description": "No content." - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/notifications/filter": { - "post": { - "tags": [ - "Notifications" - ], - "summary": "Filter notifications defined by the request body", - "description": "The endpoint returns notifications as paged result.", - "operationId": "filterNotifications", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PageableFilterRequest" - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns the paged result found for Notifications", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "type": "array", - "description": "Notifications", - "items": { - "type": "object", - "properties": { - "id": { - "maximum": 255, - "minimum": 0, - "maxLength": 255, - "type": "integer", - "format": "int64", - "example": 66 - }, - "title": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Title" - }, - "status": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "CREATED", - "enum": [ - "CREATED", - "SENT", - "RECEIVED", - "ACKNOWLEDGED", - "ACCEPTED", - "DECLINED", - "CANCELED", - "CLOSED" - ] - }, - "description": { - "maxLength": 1000, - "minLength": 0, - "type": "string", - "example": "DescriptionText" - }, - "createdBy": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003AYRE" - }, - "createdByName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "createdDate": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "example": "2023-02-21T21:27:10.734950Z" - }, - "updatedDate": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "example": "2023-02-21T21:27:10.734950Z" - }, - "assetIds": { - "maxItems": 1000, - "minItems": 0, - "type": "array", - "example": [ - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd", - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd", - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd" - ], - "items": { - "type": "string", - "example": "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd\"]" - } - }, - "channel": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "SENDER", - "enum": [ - "SENDER", - "RECEIVER" - ] - }, - "sendTo": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003AYRE" - }, - "sendToName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "severity": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "MINOR", - "enum": [ - "MINOR", - "MAJOR", - "CRITICAL", - "LIFE-THREATENING" - ] - }, - "type": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "example": "ALERT", - "enum": [ - "ALERT", - "INVESTIGATION" - ] - }, - "targetDate": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "example": "2099-02-21T21:27:10.734950Z" - }, - "messages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NotificationMessageResponse" - } - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/edc/notification/contract": { - "post": { - "tags": [ - "Notifications" - ], - "summary": "Triggers EDC notification contract", - "description": "The endpoint Triggers EDC notification contract based on notification type and method", - "operationId": "createNotificationContract", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateNotificationContractRequest" - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "201": { - "description": "Created.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateNotificationContractResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/contracts": { - "post": { - "tags": [ - "Contracts" - ], - "summary": "All contract agreements for all assets", - "description": "This endpoint returns all contract agreements for all assets in Trace-X", - "operationId": "contracts", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PageableFilterRequest" - } - } - }, - "required": true - }, - "responses": { - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "type": "string", - "example": { - "message": "Too many requests." - } - } - } - } - }, - "415": { - "description": "Unsupported media type.", - "content": { - "application/json": { - "schema": { - "type": "string", - "example": { - "message": "Unsupported media type." - } - } - } - } - }, - "200": { - "description": "Ok.", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "description": "PageResults", - "items": { - "$ref": "#/components/schemas/PageResultContractResponse" - } - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "type": "string", - "example": { - "message": "Bad request." - } - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "type": "string", - "example": { - "message": "Internal server error." - } - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "type": "string", - "example": { - "message": "Not found." - } - } - } - } - }, - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "type": "string", - "example": { - "message": "Authorization failed." - } - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "type": "string", - "example": { - "message": "Forbidden." - } - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/assets/publish": { - "post": { - "tags": [ - "AssetsImport", - "AssetsPublish" - ], - "summary": "asset publish", - "description": "This endpoint publishes assets to the Catena-X network.", - "operationId": "publishAssets", - "parameters": [ - { - "name": "triggerSynchronizeAssets", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": true - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RegisterAssetRequest" - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "OK.", - "content": { - "application/json": { - - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "204": { - "description": "No Content." - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/assets/import": { - "post": { - "tags": [ - "AssetsImport" - ], - "summary": "asset upload", - "description": "This endpoint stores assets in the application. Those can be later published in the Catena-X network.", - "operationId": "importJson", - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "file" - ], - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportResponse" - } - } - } - }, - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "204": { - "description": "No Content." - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned/sync": { - "post": { - "tags": [ - "AssetsAsPlanned" - ], - "summary": "Synchronizes assets from IRS", - "description": "The endpoint synchronizes the assets from irs.", - "operationId": "sync", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SyncAssetsRequest" - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "201": { - "description": "Created." - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned/detail-information": { - "post": { - "tags": [ - "AssetsAsPlanned" - ], - "summary": "Searches for assets by ids.", - "description": "The endpoint searchs for assets by id and returns a list of them.", - "operationId": "getDetailInformation", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetDetailInformationRequest" - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns the paged result found for Asset", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "maxItems": 2147483647, - "type": "array", - "description": "Assets", - "items": { - "type": "object", - "properties": { - "id": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "assembly-part-relationship" - }, - "semanticModelId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "NO-246880451848384868750731" - }, - "businessPartner": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003CSGV" - }, - "manufacturerName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "nameAtManufacturer": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "manufacturerPartId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "owner": { - "type": "string", - "example": "CUSTOMER", - "enum": [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Child relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Parent relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" - }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "receivedQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "sentQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "importState": { - "type": "string", - "example": "TRANSIENT", - "enum": [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" - }, - "tombstone": { - "type": "string", - "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId": { - "type": "string", - "example": "TODO" - } - } - } - } - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/sync": { - "post": { - "tags": [ - "AssetsAsBuilt" - ], - "summary": "Synchronizes assets from IRS", - "description": "The endpoint synchronizes the assets from irs.", - "operationId": "sync_1", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SyncAssetsRequest" - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "201": { - "description": "Created." - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/detail-information": { - "post": { - "tags": [ - "AssetsAsBuilt" - ], - "summary": "Searches for assets by ids.", - "description": "The endpoint searchs for assets by id and returns a list of them.", - "operationId": "getDetailInformation_1", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetDetailInformationRequest" - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns the paged result found for Asset", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "maxItems": 2147483647, - "type": "array", - "description": "Assets", - "items": { - "type": "object", - "properties": { - "id": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "assembly-part-relationship" - }, - "semanticModelId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "NO-246880451848384868750731" - }, - "businessPartner": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003CSGV" - }, - "manufacturerName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "nameAtManufacturer": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "manufacturerPartId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "owner": { - "type": "string", - "example": "CUSTOMER", - "enum": [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Child relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Parent relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" - }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "receivedQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "sentQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "importState": { - "type": "string", - "example": "TRANSIENT", - "enum": [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" - }, - "tombstone": { - "type": "string", - "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId": { - "type": "string", - "example": "TODO" - } - } - } - } - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned/{assetId}": { - "get": { - "tags": [ - "AssetsAsPlanned" - ], - "summary": "Get asset by id", - "description": "The endpoint returns an asset filtered by id .", - "operationId": "assetById", - "parameters": [ - { - "name": "assetId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns the assets found", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "type": "array", - "description": "Assets", - "items": { - "type": "object", - "properties": { - "id": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "assembly-part-relationship" - }, - "semanticModelId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "NO-246880451848384868750731" - }, - "businessPartner": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003CSGV" - }, - "manufacturerName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "nameAtManufacturer": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "manufacturerPartId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "owner": { - "type": "string", - "example": "CUSTOMER", - "enum": [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Child relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Parent relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" - }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "receivedQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "sentQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "importState": { - "type": "string", - "example": "TRANSIENT", - "enum": [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" - }, - "tombstone": { - "type": "string", - "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId": { - "type": "string", - "example": "TODO" - } - } - } - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - }, - "patch": { - "tags": [ - "AssetsAsPlanned" - ], - "summary": "Updates asset", - "description": "The endpoint updates asset by provided quality type.", - "operationId": "updateAsset", - "parameters": [ - { - "name": "assetId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateAssetRequest" - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns the updated asset", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "type": "array", - "description": "Assets", - "items": { - "type": "object", - "properties": { - "id": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "assembly-part-relationship" - }, - "semanticModelId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "NO-246880451848384868750731" - }, - "businessPartner": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003CSGV" - }, - "manufacturerName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "nameAtManufacturer": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "manufacturerPartId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "owner": { - "type": "string", - "example": "CUSTOMER", - "enum": [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Child relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Parent relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" - }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "receivedQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "sentQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "importState": { - "type": "string", - "example": "TRANSIENT", - "enum": [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" - }, - "tombstone": { - "type": "string", - "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId": { - "type": "string", - "example": "TODO" - } - } - } - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/{assetId}": { - "get": { - "tags": [ - "AssetsAsBuilt" - ], - "summary": "Get asset by id", - "description": "The endpoint returns an asset filtered by id .", - "operationId": "assetById_1", - "parameters": [ - { - "name": "assetId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns the assets found", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "type": "array", - "description": "Assets", - "items": { - "type": "object", - "properties": { - "id": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "assembly-part-relationship" - }, - "semanticModelId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "NO-246880451848384868750731" - }, - "businessPartner": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003CSGV" - }, - "manufacturerName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "nameAtManufacturer": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "manufacturerPartId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "owner": { - "type": "string", - "example": "CUSTOMER", - "enum": [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Child relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Parent relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" - }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "receivedQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "sentQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "importState": { - "type": "string", - "example": "TRANSIENT", - "enum": [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" - }, - "tombstone": { - "type": "string", - "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId": { - "type": "string", - "example": "TODO" - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - }, - "patch": { - "tags": [ - "AssetsAsBuilt" - ], - "summary": "Updates asset", - "description": "The endpoint updates asset by provided quality type.", - "operationId": "updateAsset_1", - "parameters": [ - { - "name": "assetId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateAssetRequest" - } - } - }, - "required": true - }, - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns the updated asset", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "type": "array", - "description": "Assets", - "items": { - "type": "object", - "properties": { - "id": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "assembly-part-relationship" - }, - "semanticModelId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "NO-246880451848384868750731" - }, - "businessPartner": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003CSGV" - }, - "manufacturerName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "nameAtManufacturer": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "manufacturerPartId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "owner": { - "type": "string", - "example": "CUSTOMER", - "enum": [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Child relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Parent relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" - }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "receivedQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "sentQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "importState": { - "type": "string", - "example": "TRANSIENT", - "enum": [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" - }, - "tombstone": { - "type": "string", - "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId": { - "type": "string", - "example": "TODO" - } - } - } - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/registry/reload": { - "get": { - "tags": [ - "Registry" - ], - "summary": "Triggers reload of shell descriptors", - "description": "The endpoint Triggers reload of shell descriptors.", - "operationId": "reload", - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "202": { - "description": "Created registry reload job." - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/policies/{policyId}": { - "get": { - "tags": [ - "Policies" - ], - "summary": "Gets policy by id", - "description": "The endpoint returns policy by id.", - "operationId": "getPolicyById", - "parameters": [ - { - "name": "policyId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PolicyResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - }, - "delete": { - "tags": [ - "Policies" - ], - "summary": "Deletes a policy ", - "description": "The endpoint deletes policies.", - "operationId": "deletePolicy", - "parameters": [ - { - "name": "policyId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Deletion successful", - "content": { - "application/json": { - - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/notifications/{notificationId}": { - "get": { - "tags": [ - "Notifications" - ], - "summary": "Gets notification by id", - "description": "The endpoint returns notification by id.", - "operationId": "getNotification", - "parameters": [ - { - "name": "notificationId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "type": "array", - "description": "Notifications", - "items": { - "$ref": "#/components/schemas/NotificationResponse" - } - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/notifications/distinctFilterValues": { - "get": { - "tags": [ - "Notifications" - ], - "summary": "getDistinctFilterValues", - "description": "The endpoint returns a distinct filter values for given fieldName of notification.", - "operationId": "distinctFilterValues", - "parameters": [ - { - "name": "fieldName", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "size", - "in": "query", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "startWith", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "channel", - "in": "query", - "required": true, - "schema": { - "type": "string", - "enum": [ - "SENDER", - "RECEIVER" - ] - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns a distinct filter values for given fieldName.", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/dashboard": { - "get": { - "tags": [ - "Dashboard" - ], - "summary": "Returns dashboard related data", - "description": "The endpoint can return limited data based on the user role", - "operationId": "dashboard", - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns dashboard data", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DashboardResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/assets/import/report/{importJobId}": { - "get": { - "tags": [ - "ImportReport", - "AssetsImport" - ], - "summary": "report of the imported assets", - "description": "This endpoint returns information about the imported assets to Trace-X.", - "operationId": "importReport", - "parameters": [ - { - "name": "importJobId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportReportResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "204": { - "description": "No Content." - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned": { - "get": { - "tags": [ - "AssetsAsPlanned" - ], - "summary": "Get assets by pagination", - "description": "The endpoint returns a paged result of assets.", - "operationId": "AssetsAsPlanned", - "parameters": [ - { - "name": "pageable", - "in": "query", - "required": true, - "schema": { - "$ref": "#/components/schemas/OwnPageable" - } - }, - { - "name": "filter", - "in": "query", - "required": true, - "schema": { - "$ref": "#/components/schemas/SearchCriteriaRequestParam" - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns the paged result found for Asset", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "maxItems": 2147483647, - "type": "array", - "description": "Assets", - "items": { - "type": "object", - "properties": { - "id": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "assembly-part-relationship" - }, - "semanticModelId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "NO-246880451848384868750731" - }, - "businessPartner": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003CSGV" - }, - "manufacturerName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "nameAtManufacturer": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "manufacturerPartId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "owner": { - "type": "string", - "example": "CUSTOMER", - "enum": [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Child relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Parent relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" - }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "receivedQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "sentQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "importState": { - "type": "string", - "example": "TRANSIENT", - "enum": [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" - }, - "tombstone": { - "type": "string", - "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId": { - "type": "string", - "example": "TODO" - } - } - } - } - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned/distinctFilterValues": { - "get": { - "tags": [ - "Assets", - "AssetsAsPlanned" - ], - "summary": "getDistinctFilterValues", - "description": "The endpoint returns a distinct filter values for given fieldName.", - "operationId": "distinctFilterValues_1", - "parameters": [ - { - "name": "fieldName", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "startWith", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "owner", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - } - }, - { - "name": "inAssetIds", - "in": "query", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns a distinct filter values for given fieldName.", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/assets/as-planned/*/children/{childId}": { - "get": { - "tags": [ - "AssetsAsPlanned" - ], - "summary": "Get asset by child id", - "description": "The endpoint returns an asset filtered by child id.", - "operationId": "assetByChildIdAndAssetId", - "parameters": [ - { - "name": "childId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns the asset by childId", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "type": "array", - "description": "Assets", - "items": { - "type": "object", - "properties": { - "id": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "assembly-part-relationship" - }, - "semanticModelId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "NO-246880451848384868750731" - }, - "businessPartner": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003CSGV" - }, - "manufacturerName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "nameAtManufacturer": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "manufacturerPartId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "owner": { - "type": "string", - "example": "CUSTOMER", - "enum": [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Child relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Parent relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" - }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "receivedQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "sentQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "importState": { - "type": "string", - "example": "TRANSIENT", - "enum": [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" - }, - "tombstone": { - "type": "string", - "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId": { - "type": "string", - "example": "TODO" - } - } - } - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built": { - "get": { - "tags": [ - "AssetsAsBuilt" - ], - "summary": "Get assets by pagination", - "description": "The endpoint returns a paged result of assets.", - "operationId": "assets", - "parameters": [ - { - "name": "pageable", - "in": "query", - "required": true, - "schema": { - "$ref": "#/components/schemas/OwnPageable" - } - }, - { - "name": "searchCriteriaRequestParam", - "in": "query", - "required": true, - "schema": { - "$ref": "#/components/schemas/SearchCriteriaRequestParam" - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns the paged result found for Asset", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "maxItems": 2147483647, - "type": "array", - "description": "Assets", - "items": { - "type": "object", - "properties": { - "id": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "assembly-part-relationship" - }, - "semanticModelId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "NO-246880451848384868750731" - }, - "businessPartner": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003CSGV" - }, - "manufacturerName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "nameAtManufacturer": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "manufacturerPartId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "owner": { - "type": "string", - "example": "CUSTOMER", - "enum": [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Child relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Parent relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" - }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "receivedQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "sentQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "importState": { - "type": "string", - "example": "TRANSIENT", - "enum": [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" - }, - "tombstone": { - "type": "string", - "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId": { - "type": "string", - "example": "TODO" - } - } - } - } - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/distinctFilterValues": { - "get": { - "tags": [ - "AssetsAsBuilt", - "Assets" - ], - "summary": "getDistinctFilterValues", - "description": "The endpoint returns a distinct filter values for given fieldName.", - "operationId": "distinctFilterValues_2", - "parameters": [ - { - "name": "fieldName", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "startWith", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "owner", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - } - }, - { - "name": "inAssetIds", - "in": "query", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns a distinct filter values for given fieldName.", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/countries": { - "get": { - "tags": [ - "AssetsAsBuilt" - ], - "summary": "Get map of assets", - "description": "The endpoint returns a map for assets consumed by the map.", - "operationId": "assetsCountryMap", - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns the assets found", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/assets/as-built/*/children/{childId}": { - "get": { - "tags": [ - "AssetsAsBuilt" - ], - "summary": "Get asset by child id", - "description": "The endpoint returns an asset filtered by child id.", - "operationId": "assetByChildId", - "parameters": [ - { - "name": "childId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Returns the asset by childId", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "type": "array", - "description": "Assets", - "items": { - "type": "object", - "properties": { - "id": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "idShort": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "assembly-part-relationship" - }, - "semanticModelId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "NO-246880451848384868750731" - }, - "businessPartner": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003CSGV" - }, - "manufacturerName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "nameAtManufacturer": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "manufacturerPartId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "owner": { - "type": "string", - "example": "CUSTOMER", - "enum": [ - "SUPPLIER", - "CUSTOMER", - "OWN", - "UNKNOWN" - ] - }, - "childRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Child relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "parentRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Parent relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" - } - }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" - }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ - "BATCH", - "SERIALPART", - "UNKNOWN", - "PARTASPLANNED", - "JUSTINSEQUENCE", - "TOMBSTONEASBUILT", - "TOMBSTONEASPLANNED" - ] - }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" - }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" - } - }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "receivedQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 - } - }, - "sentQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "receivedQualityInvestigationIdsInStatusActive": { - "type": "array", - "example": 2, - "items": { - "type": "integer", - "format": "int64", - "example": 2 - } - }, - "importState": { - "type": "string", - "example": "TRANSIENT", - "enum": [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" - }, - "tombstone": { - "type": "string", - "example": " {\n \"catenaXId\": \"urn:uuid:7e4541ea-bb0f-464c-8cb3-021abccbfaf5\",\n \"endpointURL\": \"https://irs-provider-dataplane3.dev.demo.catena-x.net/api/public/data/urn:uuid:c7b3ea3d-97ea-41e4-960d-12fb166e1da1\",\n \"processingError\": {\n \"processStep\": \"SubmodelRequest\",\n \"errorDetail\": \"org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 : \"{\"errors\":[]}\"\",\n \"lastAttempt\": \"2024-02-07T12:06:34.400493282Z\",\n \"retryCounter\": 0\n },\n \"policy\": null\n }\n" - }, - "contractAgreementId": { - "type": "string", - "example": "TODO" - } - } - } - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/submodel/data": { - "delete": { - "tags": [ - "Submodel" - ], - "summary": "Delete All Submodels", - "description": "Deletes all submodels from the system.", - "operationId": "deleteSubmodels", - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Ok." - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "204": { - "description": "No Content." - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - }, - "/bpn-config/{bpn}": { - "delete": { - "tags": [ - "BpnEdcMapping" - ], - "summary": "Deletes BPN EDC URL mappings", - "description": "The endpoint deletes BPN EDC URL mappings", - "operationId": "deleteBpnEdcUrlMappings", - "parameters": [ - { - "name": "bpn", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "204": { - "description": "Deleted." - }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "200": { - "description": "Okay" - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "security": [ - { - "oAuth2": [ - "profile email" - ] - } - ] - } - } - }, - "components": { - "schemas": { - "UpdatePolicyRequest": { - "type": "object", - "properties": { - "businessPartnerNumbers": { - "type": "array", - "items": { - "type": "string" - } - }, - "policyIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "validUntil": { - "type": "string", - "format": "date-time" - } - } - }, - "ErrorResponse": { - "type": "object", - "properties": { - "message": { - "maxLength": 1000, - "minLength": 0, - "pattern": "^.*$", - "type": "string", - "example": "Access Denied" - } - } - }, - "EditNotificationRequest": { - "required": [ - "affectedPartIds", - "description", - "receiverBpn", - "severity" - ], - "type": "object", - "properties": { - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "example": "title" - }, - "receiverBpn": { - "type": "string", - "example": "BPNL00000003CNKC" - }, - "severity": { - "type": "string", - "enum": [ - "MINOR", - "MAJOR", - "CRITICAL", - "LIFE-THREATENING" - ] - }, - "targetDate": { - "type": "string", - "format": "date-time", - "example": "2099-03-11T22:44:06.333826952Z" - }, - "description": { - "maxLength": 1000, - "minLength": 15, - "type": "string", - "example": "The description" - }, - "affectedPartIds": { - "maxLength": 50, - "minLength": 1, - "maxItems": 50, - "minItems": 1, - "type": "array", - "example": [ - "urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978" - ], - "items": { - "maxLength": 50, - "minLength": 1, - "type": "string", - "example": "[\"urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978\"]" - } - } - } - }, - "BpnMappingRequest": { - "required": [ - "bpn", - "url" - ], - "type": "object", - "properties": { - "bpn": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003CSGV" - }, - "url": { - "maxLength": 255, - "minLength": 0, - "type": "string" - } - } - }, - "BpnEdcMappingResponse": { - "type": "object", - "properties": { - "bpn": { - "type": "string", - "example": "BPNL00000003CSGV" - }, - "url": { - "type": "string", - "example": "https://trace-x-test-edc.dev.demo.catena-x.net/a1" - } - } - }, - "Constraint": { - "type": "object", - "properties": { - "leftOperand": { - "type": "string", - "example": "string" - }, - "operator": { - "$ref": "#/components/schemas/Operator" - }, - "odrl:rightOperand": { - "type": "string", - "example": "string" - } - } - }, - "Constraints": { - "type": "object", - "properties": { - "and": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Constraint" - } - }, - "or": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Constraint" - } - } - } - }, - "Context": { - "type": "object", - "properties": { - "odrl": { - "type": "string" - } - } - }, - "Operator": { - "type": "object", - "properties": { - "@id": { - "type": "string", - "example": "odrl:eq", - "enum": [ - "eq", - "neq", - "lt", - "gt", - "in", - "lteq", - "gteq", - "isA", - "hasPart", - "isPartOf", - "isOneOf", - "isAllOf", - "isNoneOf" - ] - } - } - }, - "Payload": { - "type": "object", - "properties": { - "@context": { - "$ref": "#/components/schemas/Context" - }, - "@id": { - "type": "string" - }, - "policy": { - "$ref": "#/components/schemas/Policy" - } - } - }, - "Permission": { - "type": "object", - "properties": { - "action": { - "type": "string", - "example": "use", - "enum": [ - "access", - "use" - ] - }, - "constraint": { - "$ref": "#/components/schemas/Constraints" - } - } - }, - "Policy": { - "type": "object", - "properties": { - "policyId": { - "type": "string", - "example": "f253718e-a270-4367-901b-9d50d9bd8462" - }, - "createdOn": { - "type": "string", - "format": "date-time" - }, - "validUntil": { - "type": "string", - "format": "date-time" - }, - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Permission" - } - } - } - }, - "RegisterPolicyRequest": { - "type": "object", - "properties": { - "validUntil": { - "type": "string", - "format": "date-time" - }, - "businessPartnerNumber": { - "type": "string" - }, - "payload": { - "$ref": "#/components/schemas/Payload" - } - } - }, - "CreatePolicyResponse": { - "type": "object", - "properties": { - "policyId": { - "type": "string" - } - } - }, - "StartNotificationRequest": { - "required": [ - "receiverBpn", - "severity", - "type" - ], - "type": "object", - "properties": { - "title": { - "maxLength": 255, - "minLength": 1, - "type": "string", - "example": "title" - }, - "affectedPartIds": { - "maxLength": 100, - "minLength": 1, - "maxItems": 50, - "minItems": 1, - "type": "array", - "example": [ - "urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978" - ], - "items": { - "maxLength": 100, - "minLength": 1, - "type": "string", - "example": "[\"urn:uuid:fe99da3d-b0de-4e80-81da-882aebcca978\"]" - } - }, - "description": { - "maxLength": 1000, - "minLength": 15, - "type": "string", - "example": "The description" - }, - "targetDate": { - "type": "string", - "format": "date-time", - "example": "2099-03-11T22:44:06.333826952Z" - }, - "severity": { - "type": "string", - "enum": [ - "MINOR", - "MAJOR", - "CRITICAL", - "LIFE-THREATENING" - ] - }, - "receiverBpn": { - "type": "string", - "example": "BPNL00000003CNKC" - }, - "type": { - "type": "string", - "example": "ALERT", - "enum": [ - "ALERT", - "INVESTIGATION" - ] - } - } - }, - "NotificationIdResponse": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1 - } - } - }, - "UpdateNotificationStatusTransitionRequest": { - "required": [ - "status" - ], - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "The UpdateInvestigationStatus", - "enum": [ - "ACKNOWLEDGED", - "ACCEPTED", - "DECLINED" - ] - }, - "reason": { - "type": "string", - "example": "The reason." - } - } - }, - "CloseNotificationRequest": { - "type": "object", - "properties": { - "reason": { - "maxLength": 1000, - "minLength": 15, - "type": "string", - "example": "The reason." - } - } - }, - "OwnPageable": { - "type": "object", - "properties": { - "page": { - "type": "integer", - "format": "int32" - }, - "size": { - "type": "integer", - "format": "int32" - }, - "sort": { - "maxItems": 2147483647, - "type": "array", - "description": "Content of Assets PageResults", - "example": "manufacturerPartId,desc", - "items": { - "type": "string" - } - } - } - }, - "PageableFilterRequest": { - "type": "object", - "properties": { - "pageAble": { - "$ref": "#/components/schemas/OwnPageable" - }, - "searchCriteria": { - "$ref": "#/components/schemas/SearchCriteriaRequestParam" - } - } - }, - "SearchCriteriaRequestParam": { - "type": "object", - "properties": { - "filter": { - "maxItems": 2147483647, - "type": "array", - "description": "Filter Criteria", - "example": "owner,EQUAL,OWN", - "items": { - "type": "string" - } - } - } - }, - "NotificationMessageResponse": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "sentBy": { - "type": "string" - }, - "sentByName": { - "type": "string" - }, - "sendTo": { - "type": "string" - }, - "sendToName": { - "type": "string" - }, - "contractAgreementId": { - "type": "string" - }, - "notificationReferenceId": { - "type": "string" - }, - "edcNotificationId": { - "type": "string" - }, - "messageDate": { - "maxLength": 50, - "type": "string", - "example": "2023-02-21T21:27:10.734950Z" - }, - "messageId": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "CREATED", - "SENT", - "RECEIVED", - "ACKNOWLEDGED", - "ACCEPTED", - "DECLINED", - "CANCELED", - "CLOSED" - ] - }, - "errorMessage": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "EDC not reachable" - }, - "message": { - "type": "string" - } - } - }, - "NotificationResponse": { - "type": "object", - "properties": { - "id": { - "maximum": 255, - "minimum": 0, - "maxLength": 255, - "type": "integer", - "format": "int64", - "example": 66 - }, - "title": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Title" - }, - "status": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "CREATED", - "enum": [ - "CREATED", - "SENT", - "RECEIVED", - "ACKNOWLEDGED", - "ACCEPTED", - "DECLINED", - "CANCELED", - "CLOSED" - ] - }, - "description": { - "maxLength": 1000, - "minLength": 0, - "type": "string", - "example": "DescriptionText" - }, - "createdBy": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003AYRE" - }, - "createdByName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "createdDate": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "example": "2023-02-21T21:27:10.734950Z" - }, - "updatedDate": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "example": "2023-02-21T21:27:10.734950Z" - }, - "assetIds": { - "maxItems": 1000, - "minItems": 0, - "type": "array", - "example": [ - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd", - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd", - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd" - ], - "items": { - "type": "string", - "example": "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70529fcbd\",\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70530fcbd\"]" - } - }, - "channel": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "SENDER", - "enum": [ - "SENDER", - "RECEIVER" - ] - }, - "sendTo": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003AYRE" - }, - "sendToName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" - }, - "severity": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "MINOR", - "enum": [ - "MINOR", - "MAJOR", - "CRITICAL", - "LIFE-THREATENING" - ] - }, - "type": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "example": "ALERT", - "enum": [ - "ALERT", - "INVESTIGATION" - ] - }, - "targetDate": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "example": "2099-02-21T21:27:10.734950Z" - }, - "messages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NotificationMessageResponse" - } - } - } - }, - "CreateNotificationContractRequest": { - "required": [ - "notificationMethod", - "notificationType" - ], - "type": "object", - "properties": { - "notificationType": { - "type": "string", - "enum": [ - "QUALITY_INVESTIGATION", - "QUALITY_ALERT" - ] - }, - "notificationMethod": { - "type": "string", - "enum": [ - "RECEIVE", - "UPDATE", - "RESOLVE" - ] - } - } - }, - "CreateNotificationContractResponse": { - "type": "object", - "properties": { - "notificationAssetId": { - "type": "string", - "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - }, - "accessPolicyId": { - "type": "string", - "example": "123" - }, - "contractDefinitionId": { - "type": "string", - "example": "456" - } - } - }, - "ContractResponse": { - "type": "object", - "properties": { - "contractId": { - "maxLength": 255, - "type": "string", - "example": "66" - }, - "counterpartyAddress": { - "maxLength": 255, - "type": "string", - "example": "https://trace-x-edc-e2e-a.dev.demo.catena-x.net/api/v1/dsp" - }, - "creationDate": { - "maxLength": 255, - "type": "string", - "format": "date-time", - "example": "2023-02-21T21:27:10.73495Z" - }, - "endDate": { - "maxLength": 255, - "type": "string", - "format": "date-time", - "example": "2023-02-21T21:27:10.73495Z" - }, - "state": { - "maxLength": 255, - "type": "string", - "example": "FINALIZED" - }, - "policy": { - "maxLength": 255, - "type": "string", - "example": "{\\\"@id\\\":\\\"eb0c8486-914a-4d36-84c0-b4971cbc52e4\\\",\\\"@type\\\":\\\"odrl:Set\\\",\\\"odrl:permission\\\":{\\\"odrl:target\\\":\\\"registry-asset\\\",\\\"odrl:action\\\":{\\\"odrl:type\\\":\\\"USE\\\"},\\\"odrl:constraint\\\":{\\\"odrl:or\\\":{\\\"odrl:leftOperand\\\":\\\"PURPOSE\\\",\\\"odrl:operator\\\":{\\\"@id\\\":\\\"odrl:eq\\\"},\\\"odrl:rightOperand\\\":\\\"ID 3.0 Trace\\\"}}},\\\"odrl:prohibition\\\":[],\\\"odrl:obligation\\\":[],\\\"odrl:target\\\":\\\"registry-asset\\\"}" - } - } - }, - "PageResultContractResponse": { - "type": "object", - "properties": { - "content": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "description": "Content of PageResults", - "items": { - "$ref": "#/components/schemas/ContractResponse" - } - }, - "page": { - "type": "integer", - "format": "int32", - "example": 1 - }, - "pageCount": { - "type": "integer", - "format": "int32", - "example": 15 - }, - "pageSize": { - "type": "integer", - "format": "int32", - "example": 10 - }, - "totalItems": { - "type": "integer", - "format": "int64", - "example": 2 - } - } - }, - "RegisterAssetRequest": { - "required": [ - "assetIds", - "policyId" - ], - "type": "object", - "properties": { - "policyId": { - "type": "string", - "example": "a644a7cb-3de5-493b-9259-f01db315a46e" - }, - "assetIds": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ImportResponse": { - "type": "object", - "properties": { - "jobId": { - "type": "string" - }, - "importStateMessage": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportStateMessage" - } - }, - "validationResult": { - "$ref": "#/components/schemas/ValidationResponse" - } - } - }, - "ImportStateMessage": { - "type": "object", - "properties": { - "catenaXId": { - "type": "string" - }, - "persistedOrUpdated": { - "type": "boolean" - } - } - }, - "ValidationResponse": { - "type": "object", - "properties": { - "validationErrors": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "SyncAssetsRequest": { - "type": "object", - "properties": { - "globalAssetIds": { - "maxItems": 100, - "minItems": 1, - "type": "array", - "example": [ - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - ], - "items": { - "type": "string", - "example": "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\"]" - } - } - } - }, - "GetDetailInformationRequest": { - "type": "object", - "properties": { - "assetIds": { - "maxLength": 50, - "minLength": 1, - "maxItems": 50, - "minItems": 1, - "type": "array", - "example": [ - "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" - ], - "items": { - "maxLength": 50, - "minLength": 1, - "type": "string", - "example": "[\"urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd\"]" - } - } - } - }, - "DescriptionsResponse": { - "type": "object", - "properties": { - "id": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "urn:uuid:a4a26b9c-9460-4cc5-8645-85916b86adb0" - }, - "idShort": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "assembly-part-relationship" - } - } - }, - "DetailAspectDataAsBuiltResponse": { - "type": "object", - "properties": { - "partId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "95657762-59" - }, - "customerPartId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "01697F7-65" - }, - "nameAtCustomer": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Door front-left" - }, - "manufacturingCountry": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "DEU" - }, - "manufacturingDate": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "2022-02-04T13:48:54Z" - } - } - }, - "DetailAspectDataAsPlannedResponse": { - "type": "object", - "properties": { - "validityPeriodFrom": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "2022-09-26T12:43:51.079Z" - }, - "validityPeriodTo": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "20232-07-13T12:00:00.000Z" - } - } - }, - "DetailAspectDataResponse": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/DetailAspectDataAsBuiltResponse" - }, - { - "$ref": "#/components/schemas/DetailAspectDataAsPlannedResponse" - }, - { - "$ref": "#/components/schemas/PartSiteInformationAsPlannedResponse" - }, - { - "$ref": "#/components/schemas/DetailAspectDataTractionBatteryCodeResponse" - } - ] - }, - "DetailAspectDataTractionBatteryCodeResponse": { - "type": "object", - "properties": { - "productType": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "pack" - }, - "tractionBatteryCode": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "X12MCPM27KLPCLX2M2382320" - }, - "subcomponents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectDataTractionBatteryCodeSubcomponentResponse" - } - } - } - }, - "DetailAspectDataTractionBatteryCodeSubcomponentResponse": { - "type": "object", - "properties": { - "productType": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "pack" - }, - "tractionBatteryCode": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "X12MCPM27KLPCLX2M2382320" - } - } - }, - "DetailAspectModelResponse": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "PART_SITE_INFORMATION_AS_PLANNED", - "enum": [ - "AS_BUILT", - "AS_PLANNED", - "TRACTION_BATTERY_CODE", - "SINGLE_LEVEL_BOM_AS_BUILT", - "SINGLE_LEVEL_USAGE_AS_BUILT", - "SINGLE_LEVEL_BOM_AS_PLANNED", - "PART_SITE_INFORMATION_AS_PLANNED" - ] - }, - "data": { - "$ref": "#/components/schemas/DetailAspectDataResponse" - } - } - }, - "PartSiteInformationAsPlannedResponse": { - "type": "object", - "properties": { - "functionValidUntil": { - "type": "string", - "example": "2025-02-08T04:30:48.000Z" - }, - "function": { - "type": "string", - "example": "production" - }, - "functionValidFrom": { - "type": "string", - "example": "2023-10-13T14:30:45+01:00" - }, - "catenaXSiteId": { - "type": "string", - "example": "urn:uuid:0fed587c-7ab4-4597-9841-1718e9693003" - } - } - }, - "UpdateAssetRequest": { - "required": [ - "qualityType" - ], - "type": "object", - "properties": { - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ - "Ok", - "Minor", - "Major", - "Critical", - "LifeThreatening" - ] - } - } - }, - "IrsPolicyResponse": { - "type": "object", - "properties": { - "validUntil": { - "type": "string", - "format": "date-time" - }, - "payload": { - "$ref": "#/components/schemas/Payload" - } - }, - "example": [ - { - "validUntil": "2025-12-12T23:59:59.999Z", - "payload": { - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/", - "edc": "https://w3id.org/edc/v0.0.1/ns/", - "cx-policy": "https://w3id.org/catenax/policy/", - "odrl": "http://www.w3.org/ns/odrl/2/" - }, - "@id": "policy-id", - "policy": { - "odrl:permission": [ - { - "odrl:action": "use", - "odrl:constraint": { - "odrl:and": [ - { - "odrl:leftOperand": "Membership", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "active" - }, - { - "odrl:leftOperand": "PURPOSE", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "ID 3.1 Trace" - } - ] - } - } - ] - } - } - } - ] - }, - "ConstraintResponse": { - "type": "object", - "properties": { - "leftOperand": { - "type": "string", - "example": "PURPOSE" - }, - "operatorTypeResponse": { - "type": "string", - "enum": [ - "EQ", - "NEQ", - "LT", - "GT", - "IN", - "LTEQ", - "GTEQ", - "ISA", - "HASPART", - "ISPARTOF", - "ISONEOF", - "ISALLOF", - "ISNONEOF" - ] - }, - "rightOperand": { - "type": "string", - "example": "ID Trace 3.1" - } - } - }, - "ConstraintsResponse": { - "type": "object", - "properties": { - "and": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConstraintResponse" - } - }, - "or": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConstraintResponse" - } - } - } - }, - "PermissionResponse": { - "type": "object", - "properties": { - "action": { - "type": "string", - "example": "USE", - "enum": [ - "ACCESS", - "USE" - ] - }, - "constraints": { - "$ref": "#/components/schemas/ConstraintsResponse" - } - } - }, - "PolicyResponse": { - "type": "object", - "properties": { - "policyId": { - "type": "string", - "example": "5a00bb50-0253-405f-b9f1-1a3150b9d51d" - }, - "createdOn": { - "type": "string", - "format": "date-time" - }, - "validUntil": { - "type": "string", - "format": "date-time" - }, - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PermissionResponse" - } - }, - "businessPartnerNumber": { - "type": "string" - } - } - }, - "DashboardResponse": { - "type": "object", - "properties": { - "asBuiltCustomerParts": { - "type": "integer", - "format": "int64", - "example": 5 - }, - "asPlannedCustomerParts": { - "type": "integer", - "format": "int64", - "example": 10 - }, - "asBuiltSupplierParts": { - "type": "integer", - "format": "int64", - "example": 2 - }, - "asPlannedSupplierParts": { - "type": "integer", - "format": "int64", - "example": 3 - }, - "asBuiltOwnParts": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "asPlannedOwnParts": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "myPartsWithOpenAlerts": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "myPartsWithOpenInvestigations": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "supplierPartsWithOpenAlerts": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "customerPartsWithOpenAlerts": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "supplierPartsWithOpenInvestigations": { - "type": "integer", - "format": "int64", - "example": 2 - }, - "customerPartsWithOpenInvestigations": { - "type": "integer", - "format": "int64", - "example": 2 - }, - "receivedActiveAlerts": { - "type": "integer", - "format": "int64", - "example": 2 - }, - "receivedActiveInvestigations": { - "type": "integer", - "format": "int64", - "example": 2 - }, - "sentActiveAlerts": { - "type": "integer", - "format": "int64", - "example": 2 - }, - "sentActiveInvestigations": { - "type": "integer", - "format": "int64", - "example": 2 - } - } - }, - "ImportJobResponse": { - "type": "object", - "properties": { - "importJobStatus": { - "type": "string", - "enum": [ - "INITIALIZING", - "RUNNING", - "ERROR", - "COMPLETED" - ] - }, - "importId": { - "type": "string", - "example": "456a952e-05eb-40dc-a6f2-9c2cb9c1387f" - }, - "startedOn": { - "maxLength": 50, - "type": "string", - "example": "2099-02-21T21:27:10.734950Z" - }, - "completedOn": { - "maxLength": 50, - "type": "string", - "example": "2099-02-21T21:27:10.734950Z" - } - } - }, - "ImportReportResponse": { - "type": "object", - "properties": { - "importJob": { - "$ref": "#/components/schemas/ImportJobResponse" - }, - "importedAsset": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportedAssetResponse" - } - } - } - }, - "ImportedAssetResponse": { - "type": "object", - "properties": { - "importState": { - "type": "string", - "enum": [ - "TRANSIENT", - "PERSISTENT", - "ERROR", - "IN_SYNCHRONIZATION", - "PUBLISHED_TO_CORE_SERVICES", - "UNSET" - ] - }, - "catenaxId": { - "type": "string", - "example": "urn:uuid:7eeeac86-7b69-444d-81e6-655d0f1513bd}" - }, - "importedOn": { - "maxLength": 50, - "type": "string", - "example": "2099-02-21T21:27:10.734950Z" - }, - "importMessage": { - "type": "string", - "example": "Asset created successfully in transient state." - } - } - } - }, - "securitySchemes": { - "oAuth2": { - "type": "oauth2", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/token", - "scopes": { - "profile email": "" - } - } - } - } - } - } -} \ No newline at end of file From 0045f13e2f1675c054f5224b7f605557e6c5608a Mon Sep 17 00:00:00 2001 From: pweick Date: Mon, 24 Jun 2024 17:13:01 +0200 Subject: [PATCH 09/14] fix(OpenAPI):[xxx] OpenAPI code generator goal config updated --- tx-backend/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tx-backend/pom.xml b/tx-backend/pom.xml index 5a8baf2433..9601550e47 100644 --- a/tx-backend/pom.xml +++ b/tx-backend/pom.xml @@ -366,7 +366,7 @@ SPDX-License-Identifier: Apache-2.0 generate - ${project.basedir}/openapi/traceability-foss-backend.json + ${project.basedir}/docs/api/traceability-foss-backend.json html From 0e991df5624dd318c0591bff6de7eb5049e85e9e Mon Sep 17 00:00:00 2001 From: pweick Date: Mon, 24 Jun 2024 17:16:59 +0200 Subject: [PATCH 10/14] fix(OpenAPI):[xxx] OpenAPI code generator goal config updated --- tx-backend/pom.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tx-backend/pom.xml b/tx-backend/pom.xml index 9601550e47..691f04af34 100644 --- a/tx-backend/pom.xml +++ b/tx-backend/pom.xml @@ -366,7 +366,8 @@ SPDX-License-Identifier: Apache-2.0 generate - ${project.basedir}/docs/api/traceability-foss-backend.json + ${project.parent.parent.basedir}/docs/api/traceability-foss-backend.json + html From 54fb90b533ead8f7be89de340dda2a7e5a00f49e Mon Sep 17 00:00:00 2001 From: Martin Maul Date: Mon, 24 Jun 2024 17:30:37 +0200 Subject: [PATCH 11/14] chore(contract): 1037 added tests --- .../contracts/contracts.component.spec.ts | 27 +++++++++++++++++-- .../contracts/contracts.component.ts | 7 ++--- 2 files changed, 29 insertions(+), 5 deletions(-) diff --git a/frontend/src/app/modules/page/admin/presentation/contracts/contracts.component.spec.ts b/frontend/src/app/modules/page/admin/presentation/contracts/contracts.component.spec.ts index 141ea7e247..d5c94b99a7 100644 --- a/frontend/src/app/modules/page/admin/presentation/contracts/contracts.component.spec.ts +++ b/frontend/src/app/modules/page/admin/presentation/contracts/contracts.component.spec.ts @@ -1,4 +1,5 @@ import { TestBed } from '@angular/core/testing'; +import { Router } from '@angular/router'; import { AdminModule } from '@page/admin/admin.module'; import { AdminFacade } from '@page/admin/core/admin.facade'; import { assembleContract } from '@page/admin/core/admin.model'; @@ -16,16 +17,20 @@ describe('ContractTableComponent', () => { getContracts: jasmine.createSpy().and.returnValue(of(getContracts)), }; + const routerMock = { + navigate: jasmine.createSpy('navigate'), + }; + const renderContractTableComponent = () => renderComponent(ContractsComponent, { imports: [ AdminModule ], - providers: [ { provide: AdminFacade, useValue: mockAdminFacade } ], + providers: [ { provide: AdminFacade, useValue: mockAdminFacade }, { provide: Router, useValue: routerMock } ], }); let createElementSpy: jasmine.Spy; beforeEach(() => { TestBed.configureTestingModule({ declarations: [ ContractsComponent ], - providers: [ AdminFacade, AdminService ], + providers: [ AdminFacade, AdminService, { provide: Router, useValue: routerMock } ], }); createElementSpy = spyOn(document, 'createElement').and.callThrough(); @@ -82,6 +87,24 @@ describe('ContractTableComponent', () => { }); + it('should navigate if viewAssets clicked', async () => { + const { fixture } = await renderContractTableComponent(); + const { componentInstance } = fixture; + componentInstance.viewAssetsClicked.emit({ contractId: 'test' }); + + expect(routerMock.navigate).toHaveBeenCalled(); + }); + + it('should emit viewAssetsClicked', async () => { + const { fixture } = await renderContractTableComponent(); + const { componentInstance } = fixture; + let spy = spyOn(componentInstance.viewAssetsClicked, 'emit'); + const viewAssetsAction = componentInstance.tableConfig.menuActionsConfig.filter(action => action.label === 'actions.viewParts')[0]; + viewAssetsAction.action(null); + expect(spy).toHaveBeenCalled(); + + }); + it('should convert data to csv', async () => { const { fixture } = await renderContractTableComponent(); const { componentInstance } = fixture; diff --git a/frontend/src/app/modules/page/admin/presentation/contracts/contracts.component.ts b/frontend/src/app/modules/page/admin/presentation/contracts/contracts.component.ts index 923d740666..8c861c9dff 100644 --- a/frontend/src/app/modules/page/admin/presentation/contracts/contracts.component.ts +++ b/frontend/src/app/modules/page/admin/presentation/contracts/contracts.component.ts @@ -35,11 +35,12 @@ export class ContractsComponent { this.contractsFacade.setContracts(0,10,[null,null]); } - this.viewAssetsClicked.subscribe((data) => { - this.router.navigate([ 'parts' ], { queryParams: { contractId: data?.['contractId'] } }); - }); }) + this.viewAssetsClicked.subscribe((data) => { + this.router.navigate([ 'parts' ], { queryParams: { contractId: data?.['contractId'] } }); + }); + this.pagination = { page: 0, pageSize: 10, sorting: [ '', null ] }; this.tableConfig = { displayedColumns: [ 'select', 'contractId', 'counterpartyAddress', 'creationDate', 'endDate', 'state', 'menu' ], From 9bd807172308bbe6d8b4ab44dff35a8549ae56fb Mon Sep 17 00:00:00 2001 From: Martin Maul Date: Mon, 24 Jun 2024 17:40:34 +0200 Subject: [PATCH 12/14] chore(contract): 1037 added tests --- .../multi-select-autocomplete.component.spec.ts | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/frontend/src/app/modules/shared/components/multi-select-autocomplete/multi-select-autocomplete.component.spec.ts b/frontend/src/app/modules/shared/components/multi-select-autocomplete/multi-select-autocomplete.component.spec.ts index c281983241..228af8eea9 100644 --- a/frontend/src/app/modules/shared/components/multi-select-autocomplete/multi-select-autocomplete.component.spec.ts +++ b/frontend/src/app/modules/shared/components/multi-select-autocomplete/multi-select-autocomplete.component.spec.ts @@ -7,14 +7,14 @@ import { SharedModule } from '@shared/shared.module'; import { renderComponent } from '@tests/test-render.utils'; describe('MultiSelectAutocompleteComponent', () => { - const renderMultiSelectAutoCompleteComponent = (multiple = true) => { + const renderMultiSelectAutoCompleteComponent = (multiple = true, prefilterValue = null) => { const placeholder = 'test'; const options = [ SemanticDataModel.PARTASPLANNED, SemanticDataModel.BATCH ]; return renderComponent(MultiSelectAutocompleteComponent, { imports: [ SharedModule ], providers: [ DatePipe, FormatPartSemanticDataModelToCamelCasePipe ], - componentProperties: { placeholder: placeholder, options: options }, + componentProperties: { placeholder: placeholder, options: options, prefilterValue: prefilterValue }, }); }; @@ -265,6 +265,17 @@ describe('MultiSelectAutocompleteComponent', () => { expect(option).toEqual([]); }); + it('should set prefilter value', async () => { + const { fixture } = await renderMultiSelectAutoCompleteComponent(false, 'hello'); + const { componentInstance } = fixture; + let formSpy = spyOn(componentInstance.formControl, 'patchValue'); + let updateSpy = spyOn(componentInstance, 'updateOptionsAndSelections'); + + expect(componentInstance.searchElement).toEqual('hello'); + expect(componentInstance.selectedValue).toEqual([ 'hello' ]); + + }); + it('should return when calling filterItem() without value', async () => { const { fixture } = await renderMultiSelectAutoCompleteComponent(); const { componentInstance } = fixture; From e76a1b17647ee84961e0864e447cf558417035e5 Mon Sep 17 00:00:00 2001 From: Martin Maul Date: Mon, 24 Jun 2024 17:42:59 +0200 Subject: [PATCH 13/14] chore(contract): 1037 added tests --- .../multi-select-autocomplete.component.spec.ts | 2 -- 1 file changed, 2 deletions(-) diff --git a/frontend/src/app/modules/shared/components/multi-select-autocomplete/multi-select-autocomplete.component.spec.ts b/frontend/src/app/modules/shared/components/multi-select-autocomplete/multi-select-autocomplete.component.spec.ts index 228af8eea9..e82a52275b 100644 --- a/frontend/src/app/modules/shared/components/multi-select-autocomplete/multi-select-autocomplete.component.spec.ts +++ b/frontend/src/app/modules/shared/components/multi-select-autocomplete/multi-select-autocomplete.component.spec.ts @@ -268,8 +268,6 @@ describe('MultiSelectAutocompleteComponent', () => { it('should set prefilter value', async () => { const { fixture } = await renderMultiSelectAutoCompleteComponent(false, 'hello'); const { componentInstance } = fixture; - let formSpy = spyOn(componentInstance.formControl, 'patchValue'); - let updateSpy = spyOn(componentInstance, 'updateOptionsAndSelections'); expect(componentInstance.searchElement).toEqual('hello'); expect(componentInstance.selectedValue).toEqual([ 'hello' ]); From 0a32adb7a9e8eed3235a330b964a93ee03dcaf41 Mon Sep 17 00:00:00 2001 From: pweick Date: Tue, 25 Jun 2024 08:54:56 +0200 Subject: [PATCH 14/14] chore(docs):[xxx] Updated changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index c7ba8d2d12..d19e8d9d62 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -30,6 +30,7 @@ _**For better traceability add the corresponding GitHub issue number in each cha ### Changed - XXX updated JsonSchemaTest now the test pulls the latest version of the json file +- XXX deactivated a test class in tx-backend which behaved undesirably ### Added