diff --git a/tx-backend/openapi/traceability-foss-backend.json b/tx-backend/openapi/traceability-foss-backend.json index e521e1e566..61451dd2da 100644 --- a/tx-backend/openapi/traceability-foss-backend.json +++ b/tx-backend/openapi/traceability-foss-backend.json @@ -1,1227 +1,1197 @@ { - "openapi": "3.0.1", - "info": { - "title": "Trace-FOSS - OpenAPI Documentation", - "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" + "openapi" : "3.0.1", + "info" : { + "title" : "Trace-FOSS - OpenAPI Documentation", + "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" + "version" : "1.0.0" }, - "servers": [ + "servers" : [ { - "url": "http://localhost:9998/api", - "description": "Generated server url" + "url" : "http://localhost:9998/api", + "description" : "Generated server url" } ], - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ], - "tags": [ + "tags" : [ { - "name": "Investigations", - "description": "Operations on Investigation Notification" + "name" : "Investigations", + "description" : "Operations on Investigation Notification" } ], - "paths": { - "/bpn-config": { - "get": { - "tags": [ + "paths" : { + "/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": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "summary" : "Get BPN EDC URL mappings", + "description" : "The endpoint returns a result of BPN EDC URL mappings.", + "operationId" : "getBpnEdcs", + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "500" : { + "description" : "Internal server error.", + "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" - } + "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" } } } }, - "400": { - "description": "Bad request.", - "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" + } } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] }, - "put": { - "tags": [ + "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" + "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 + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "200" : { + "description" : "Returns the paged result found for BpnEdcMapping", + "content" : { + "application/json" : { + "schema" : { + "maxItems" : 2147483647, + "minItems" : 0, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/BpnEdcMappingResponse" + } } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "401" : { + "description" : "Authorization failed.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "404": { - "description": "Not found.", - "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 BpnEdcMapping", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/BpnEdcMappingResponse" - } + "429" : { + "description" : "Too many requests.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] }, - "post": { - "tags": [ + "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" + "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 + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "200" : { + "description" : "Returns the paged result found for BpnEdcMapping", + "content" : { + "application/json" : { + "schema" : { + "maxItems" : 2147483647, + "minItems" : 0, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/BpnEdcMappingResponse" + } } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "401" : { + "description" : "Authorization failed.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "404": { - "description": "Not found.", - "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 BpnEdcMapping", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/BpnEdcMappingResponse" - } + "429" : { + "description" : "Too many requests.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/submodel/data/{submodelId}": { - "get": { - "tags": [ + "/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": [ + "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" + "name" : "submodelId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" } } ], - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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 paged result found", - "content": { - "application/json": {} + "200" : { + "description" : "Returns the paged result found", + "content" : { + "application/json" : {} } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] }, - "post": { - "tags": [ + "post" : { + "tags" : [ "Submodel" ], - "summary": "Save Submodel", - "description": "This endpoint allows you to save a Submodel identified by its ID.", - "operationId": "saveSubmodel", - "parameters": [ + "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" + "name" : "submodelId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "string" + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" } } }, - "required": true + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } + "responses" : { + "204" : { + "description" : "No Content.", + "content" : { + "application/json" : {} } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "401" : { + "description" : "Authorization failed.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "No Content.", - "content": { - "application/json": {} - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "500" : { + "description" : "Internal server error.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "429" : { + "description" : "Too many requests.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "200": { - "description": "Ok.", - "content": { - "application/json": {} + "403" : { + "description" : "Forbidden.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } } }, - "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" } } } + }, + "200" : { + "description" : "Ok.", + "content" : { + "application/json" : {} + } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/investigations": { - "post": { - "tags": [ + "/investigations" : { + "post" : { + "tags" : [ "Investigations" ], - "summary": "Start investigations by part ids", - "description": "The endpoint starts investigations based on part ids provided.", - "operationId": "investigateAssets", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StartQualityNotificationRequest" + "summary" : "Start investigations by part ids", + "description" : "The endpoint starts investigations based on part ids provided.", + "operationId" : "investigateAssets", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/StartQualityNotificationRequest" } } }, - "required": true + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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" } } } }, - "400": { - "description": "Bad request.", - "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/QualityNotificationIdResponse" + "403" : { + "description" : "Forbidden.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "201" : { + "description" : "Created.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/QualityNotificationIdResponse" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/investigations/{investigationId}/update": { - "post": { - "tags": [ + "/investigations/{investigationId}/update" : { + "post" : { + "tags" : [ "Investigations" ], - "summary": "Update investigations by id", - "description": "The endpoint updates investigations by their id.", - "operationId": "updateInvestigation", - "parameters": [ + "summary" : "Update investigations by id", + "description" : "The endpoint updates investigations by their id.", + "operationId" : "updateInvestigation", + "parameters" : [ { - "name": "investigationId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "name" : "investigationId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int64" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateQualityNotificationRequest" + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateQualityNotificationRequest" } } }, - "required": true + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "200" : { + "description" : "Ok." + }, + "204" : { + "description" : "No content." + }, + "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" + "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." - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/investigations/{investigationId}/close": { - "post": { - "tags": [ + "/investigations/{investigationId}/close" : { + "post" : { + "tags" : [ "Investigations" ], - "summary": "Close investigations by id", - "description": "The endpoint closes investigations by their id.", - "operationId": "closeInvestigation", - "parameters": [ + "summary" : "Close investigations by id", + "description" : "The endpoint closes investigations by their id.", + "operationId" : "closeInvestigation", + "parameters" : [ { - "name": "investigationId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "name" : "investigationId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int64" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CloseQualityNotificationRequest" + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CloseQualityNotificationRequest" } } }, - "required": true + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "200" : { + "description" : "Ok." + }, + "204" : { + "description" : "No content." + }, + "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" + "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." - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/investigations/{investigationId}/cancel": { - "post": { - "tags": [ + "/investigations/{investigationId}/cancel" : { + "post" : { + "tags" : [ "Investigations" ], - "summary": "Cancles investigations by id", - "description": "The endpoint cancles investigations by their id.", - "operationId": "cancelInvestigation", - "parameters": [ + "summary" : "Cancles investigations by id", + "description" : "The endpoint cancles investigations by their id.", + "operationId" : "cancelInvestigation", + "parameters" : [ { - "name": "investigationId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "name" : "investigationId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int64" } } ], - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "200" : { + "description" : "Ok." + }, + "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" + "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." + "204" : { + "description" : "No content." }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/investigations/{investigationId}/approve": { - "post": { - "tags": [ + "/investigations/{investigationId}/approve" : { + "post" : { + "tags" : [ "Investigations" ], - "summary": "Approves investigations by id", - "description": "The endpoint approves investigations by their id.", - "operationId": "approveInvestigation", - "parameters": [ + "summary" : "Approves investigations by id", + "description" : "The endpoint approves investigations by their id.", + "operationId" : "approveInvestigation", + "parameters" : [ { - "name": "investigationId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "name" : "investigationId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int64" } } ], - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "200" : { + "description" : "Ok." + }, + "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" + "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." + "204" : { + "description" : "No content." }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/investigations/filter": { - "post": { - "tags": [ + "/investigations/filter" : { + "post" : { + "tags" : [ "Investigations" ], - "summary": "Filter investigations defined by the request body", - "description": "The endpoint returns investigations as paged result.", - "operationId": "filterInvestigations", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PageableFilterRequest" + "summary" : "Filter investigations defined by the request body", + "description" : "The endpoint returns investigations as paged result.", + "operationId" : "filterInvestigations", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PageableFilterRequest" } } }, - "required": true + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "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 Asset", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "maxItems": 2147483647, - "minItems": -2147483648, - "type": "array", - "description": "Investigations", - "items": { - "type": "object", - "properties": { - "id": { - "maximum": 255, - "minimum": 0, - "maxLength": 255, - "type": "integer", - "format": "int64", - "example": 66 + "responses" : { + "200" : { + "description" : "Returns the paged result found for Asset", + "content" : { + "application/json" : { + "schema" : { + "maxItems" : 2147483647, + "minItems" : 0, + "type" : "array", + "items" : { + "maxItems" : 2147483647, + "minItems" : -2147483648, + "type" : "array", + "description" : "Investigations", + "items" : { + "type" : "object", + "properties" : { + "id" : { + "maximum" : 255, + "minimum" : 0, + "maxLength" : 255, + "type" : "integer", + "format" : "int64", + "example" : 66 }, - "status": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "CREATED", - "enum": [ + "status" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "CREATED", + "enum" : [ "CREATED", "SENT", "RECEIVED", @@ -1232,97 +1202,97 @@ "CLOSED" ] }, - "description": { - "maxLength": 1000, - "minLength": 0, - "type": "string", - "example": "DescriptionText" + "description" : { + "maxLength" : 1000, + "minLength" : 0, + "type" : "string", + "example" : "DescriptionText" }, - "createdBy": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003AYRE" + "createdBy" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "BPNL00000003AYRE" }, - "createdByName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" + "createdByName" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "Tier C" }, - "createdDate": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "example": "2023-02-21T21:27:10.734950Z" + "createdDate" : { + "maxLength" : 50, + "minLength" : 0, + "type" : "string", + "example" : "2023-02-21T21:27:10.734950Z" }, - "assetIds": { - "maxItems": 1000, - "minItems": 0, - "type": "array", - "example": [ + "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\"]" + "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": [ + "channel" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "SENDER", + "enum" : [ "SENDER", "RECEIVER" ] }, - "reason": { - "$ref": "#/components/schemas/QualityNotificationReasonResponse" + "reason" : { + "$ref" : "#/components/schemas/QualityNotificationReasonResponse" }, - "sendTo": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003AYRE" + "sendTo" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "BPNL00000003AYRE" }, - "sendToName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" + "sendToName" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "Tier C" }, - "severity": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "MINOR", - "enum": [ + "severity" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "MINOR", + "enum" : [ "MINOR", "MAJOR", "CRITICAL", "LIFE-THREATENING" ] }, - "targetDate": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "example": "2099-02-21T21:27:10.734950Z" + "targetDate" : { + "maxLength" : 50, + "minLength" : 0, + "type" : "string", + "example" : "2099-02-21T21:27:10.734950Z" }, - "errorMessage": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "EDC not reachable" + "errorMessage" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "EDC not reachable" }, - "qualityNotificationMessageResponseList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QualityNotificationMessageResponse" + "qualityNotificationMessageResponseList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/QualityNotificationMessageResponse" } } } @@ -1332,713 +1302,805 @@ } } }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "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" + } + } + } + }, + "429" : { + "description" : "Too many requests.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/edc/notification/contract": { - "post": { - "tags": [ + "/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" + "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 + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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" } } } }, - "400": { - "description": "Bad request.", - "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" + "403" : { + "description" : "Forbidden.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "201" : { + "description" : "Created.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateNotificationContractResponse" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/contracts": { - "post": { - "tags": [ + "/contracts" : { + "post" : { + "tags" : [ + "getContracts", "Contracts" ], - "summary": "All contract agreements for all assets", - "description": "This endpoint returns all contract agreements for alls assets in Trace-X", - "operationId": "contracts", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PageableFilterRequest" + "summary" : "All contract agreements for all assets", + "description" : "This endpoint returns all contract agreements for alls assets in Trace-X", + "operationId" : "contracts", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PageableFilterRequest" } } }, - "required": true + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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": { - "$ref": "#/components/schemas/ErrorResponse" + "500" : { + "description" : "Internal server error.", + "content" : { + "application/json" : { + "schema" : { + "type" : "string", + "example" : { + "message" : "Internal server error." + } } } } }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "type" : "string", + "example" : { + "message" : "Not found." + } } } } }, - "200": { - "description": "Ok.", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "description": "PageResults", - "items": { - "$ref": "#/components/schemas/PageResultContractResponse" + "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": { - "$ref": "#/components/schemas/ErrorResponse" + "401" : { + "description" : "Authorization failed.", + "content" : { + "application/json" : { + "schema" : { + "type" : "string", + "example" : { + "message" : "Authorization failed." + } } } } }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "403" : { + "description" : "Forbidden.", + "content" : { + "application/json" : { + "schema" : { + "type" : "string", + "example" : { + "message" : "Forbidden." + } } } } }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "content" : { + "application/json" : { + "schema" : { + "type" : "string", + "example" : { + "message" : "Bad request." + } } } } }, - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "415" : { + "description" : "Unsupported media type.", + "content" : { + "application/json" : { + "schema" : { + "type" : "string", + "example" : { + "message" : "Unsupported media type." + } } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/assets/publish": { - "post": { - "tags": [ + "/assets/publish" : { + "post" : { + "tags" : [ "AssetsImport", "AssetsPublish" ], - "summary": "asset publish", - "description": "This endpoint publishes assets to the Catena-X network.", - "operationId": "publishAssets", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RegisterAssetRequest" + "summary" : "asset publish", + "description" : "This endpoint publishes assets to the Catena-X network.", + "operationId" : "publishAssets", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RegisterAssetRequest" } } }, - "required": true + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "204" : { + "description" : "No Content." + }, + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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" } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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": "OK.", - "content": { - "application/json": {} - } - }, - "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" } } } + }, + "200" : { + "description" : "OK.", + "content" : { + "application/json" : {} + } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/assets/import": { - "post": { - "tags": [ + "/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": [ + "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" + "type" : "object", + "properties" : { + "file" : { + "type" : "string", + "format" : "binary" } } } } } }, - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "204" : { + "description" : "No Content." + }, + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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" } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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": "OK.", - "content": { - "application/json": {} - } - }, - "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" } } } + }, + "200" : { + "description" : "OK.", + "content" : { + "application/json" : {} + } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/assets/as-planned/sync": { - "post": { - "tags": [ + "/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" + "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 + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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" } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "201": { - "description": "Created." - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "403" : { + "description" : "Forbidden.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "201" : { + "description" : "Created." + }, + "415" : { + "description" : "Unsupported media type", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/assets/as-planned/detail-information": { - "post": { - "tags": [ + "/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" + "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 + "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" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "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" + } + } + } + }, + "429" : { + "description" : "Too many requests.", + "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" + "idShort" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "assembly-part-relationship" }, - "semanticModelId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "NO-246880451848384868750731" + "semanticModelId" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "NO-246880451848384868750731" }, - "businessPartner": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003CSGV" + "businessPartner" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "BPNL00000003CSGV" }, - "manufacturerName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" + "manufacturerName" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "Tier C" }, - "nameAtManufacturer": { - "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" + "manufacturerPartId" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "Tier C" }, - "owner": { - "type": "string", - "example": "CUSTOMER", - "enum": [ + "owner" : { + "type" : "string", + "example" : "CUSTOMER", + "enum" : [ "SUPPLIER", "CUSTOMER", "OWN", "UNKNOWN" ] }, - "childRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Child relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" + "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" + "parentRelations" : { + "maxItems" : 2147483647, + "type" : "array", + "description" : "Parent relationships", + "items" : { + "$ref" : "#/components/schemas/DescriptionsResponse" } }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ + "qualityType" : { + "type" : "string", + "example" : "Ok", + "enum" : [ "Ok", "Minor", "Major", @@ -2046,16 +2108,16 @@ "LifeThreatening" ] }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" + "van" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "OMAYSKEITUGNVHKKX" }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ + "semanticDataModel" : { + "type" : "string", + "example" : "BATCH", + "enum" : [ "BATCH", "SERIALPART", "UNKNOWN", @@ -2065,58 +2127,58 @@ "TOMBSTONEASPLANNED" ] }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" + "classification" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "component" }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" + "detailAspectModels" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DetailAspectModelResponse" } }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 + "sentQualityAlertIdsInStatusActive" : { + "type" : "array", + "example" : 1, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 1 } }, - "receivedQualityAlertIdsInStatusActive": { - "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 + "sentQualityInvestigationIdsInStatusActive" : { + "type" : "array", + "example" : 2, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 2 } }, - "receivedQualityInvestigationIdsInStatusActive": { - "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": [ + "importState" : { + "type" : "string", + "example" : "TRANSIENT", + "enum" : [ "TRANSIENT", "PERSISTENT", "ERROR", @@ -2124,17 +2186,17 @@ "UNSET" ] }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" + "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" + "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" + "contractAgreementId" : { + "type" : "string", + "example" : "TODO" } } } @@ -2143,344 +2205,324 @@ } } }, - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/assets/as-built/sync": { - "post": { - "tags": [ + "/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" + "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 + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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" } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "201": { - "description": "Created." - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "403" : { + "description" : "Forbidden.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "201" : { + "description" : "Created." + }, + "415" : { + "description" : "Unsupported media type", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/assets/as-built/detail-information": { - "post": { - "tags": [ + "/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" + "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 + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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" } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" + "403" : { + "description" : "Forbidden.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "415" : { + "description" : "Unsupported media type", + "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" + "idShort" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "assembly-part-relationship" }, - "semanticModelId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "NO-246880451848384868750731" + "semanticModelId" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "NO-246880451848384868750731" }, - "businessPartner": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003CSGV" + "businessPartner" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "BPNL00000003CSGV" }, - "manufacturerName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" + "manufacturerName" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "Tier C" }, - "nameAtManufacturer": { - "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" + "manufacturerPartId" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "Tier C" }, - "owner": { - "type": "string", - "example": "CUSTOMER", - "enum": [ + "owner" : { + "type" : "string", + "example" : "CUSTOMER", + "enum" : [ "SUPPLIER", "CUSTOMER", "OWN", "UNKNOWN" ] }, - "childRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Child relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" + "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" + "parentRelations" : { + "maxItems" : 2147483647, + "type" : "array", + "description" : "Parent relationships", + "items" : { + "$ref" : "#/components/schemas/DescriptionsResponse" } }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ + "qualityType" : { + "type" : "string", + "example" : "Ok", + "enum" : [ "Ok", "Minor", "Major", @@ -2488,16 +2530,16 @@ "LifeThreatening" ] }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" + "van" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "OMAYSKEITUGNVHKKX" }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ + "semanticDataModel" : { + "type" : "string", + "example" : "BATCH", + "enum" : [ "BATCH", "SERIALPART", "UNKNOWN", @@ -2507,58 +2549,58 @@ "TOMBSTONEASPLANNED" ] }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" + "classification" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "component" }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" + "detailAspectModels" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DetailAspectModelResponse" } }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 + "sentQualityAlertIdsInStatusActive" : { + "type" : "array", + "example" : 1, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 1 } }, - "receivedQualityAlertIdsInStatusActive": { - "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 + "sentQualityInvestigationIdsInStatusActive" : { + "type" : "array", + "example" : 2, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 2 } }, - "receivedQualityInvestigationIdsInStatusActive": { - "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": [ + "importState" : { + "type" : "string", + "example" : "TRANSIENT", + "enum" : [ "TRANSIENT", "PERSISTENT", "ERROR", @@ -2566,17 +2608,17 @@ "UNSET" ] }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" + "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" + "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" + "contractAgreementId" : { + "type" : "string", + "example" : "TODO" } } } @@ -2584,641 +2626,641 @@ } } } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/alerts": { - "post": { - "tags": [ + "/alerts" : { + "post" : { + "tags" : [ "Alerts" ], - "summary": "Start alert by part ids", - "description": "The endpoint starts alert based on part ids provided.", - "operationId": "alertAssets", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StartQualityNotificationRequest" + "summary" : "Start alert by part ids", + "description" : "The endpoint starts alert based on part ids provided.", + "operationId" : "alertAssets", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/StartQualityNotificationRequest" } } }, - "required": true + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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" } } } }, - "400": { - "description": "Bad request.", - "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/QualityNotificationIdResponse" + "403" : { + "description" : "Forbidden.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "201" : { + "description" : "Created.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/QualityNotificationIdResponse" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/alerts/{alertId}/update": { - "post": { - "tags": [ + "/alerts/{alertId}/update" : { + "post" : { + "tags" : [ "Alerts" ], - "summary": "Update alert by id", - "description": "The endpoint updates alert by their id.", - "operationId": "updateAlert", - "parameters": [ + "summary" : "Update alert by id", + "description" : "The endpoint updates alert by their id.", + "operationId" : "updateAlert", + "parameters" : [ { - "name": "alertId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "name" : "alertId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int64" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateQualityNotificationRequest" + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateQualityNotificationRequest" } } }, - "required": true + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "204" : { + "description" : "No content." + }, + "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" + "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" } } } }, - "204": { - "description": "No content." - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/alerts/{alertId}/close": { - "post": { - "tags": [ + "/alerts/{alertId}/close" : { + "post" : { + "tags" : [ "Alerts" ], - "summary": "Close alert by id", - "description": "The endpoint closes alert by id.", - "operationId": "closeAlert", - "parameters": [ + "summary" : "Close alert by id", + "description" : "The endpoint closes alert by id.", + "operationId" : "closeAlert", + "parameters" : [ { - "name": "alertId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "name" : "alertId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int64" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CloseQualityNotificationRequest" + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CloseQualityNotificationRequest" } } }, - "required": true + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "200" : { + "description" : "Ok." + }, + "204" : { + "description" : "No content." + }, + "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" + "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." - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/alerts/{alertId}/cancel": { - "post": { - "tags": [ + "/alerts/{alertId}/cancel" : { + "post" : { + "tags" : [ "Alerts" ], - "summary": "Cancels alert by id", - "description": "The endpoint cancels alert by id.", - "operationId": "cancelAlert", - "parameters": [ + "summary" : "Cancels alert by id", + "description" : "The endpoint cancels alert by id.", + "operationId" : "cancelAlert", + "parameters" : [ { - "name": "alertId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "name" : "alertId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int64" } } ], - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "200" : { + "description" : "Ok." + }, + "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" + "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." + "204" : { + "description" : "No content." }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/alerts/{alertId}/approve": { - "post": { - "tags": [ + "/alerts/{alertId}/approve" : { + "post" : { + "tags" : [ "Alerts" ], - "summary": "Approves alert by id", - "description": "The endpoint approves alert by id.", - "operationId": "approveAlert", - "parameters": [ + "summary" : "Approves alert by id", + "description" : "The endpoint approves alert by id.", + "operationId" : "approveAlert", + "parameters" : [ { - "name": "alertId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "name" : "alertId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int64" } } ], - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "200" : { + "description" : "Ok." + }, + "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" + "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." + "204" : { + "description" : "No content." }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/alerts/filter": { - "post": { - "tags": [ + "/alerts/filter" : { + "post" : { + "tags" : [ "Alerts" ], - "summary": "Filter alerts defined by the request body", - "description": "The endpoint returns alerts as paged result.", - "operationId": "filterAlerts", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PageableFilterRequest" + "summary" : "Filter alerts defined by the request body", + "description" : "The endpoint returns alerts as paged result.", + "operationId" : "filterAlerts", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PageableFilterRequest" } } }, - "required": true + "required" : true }, - "responses": { - "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, - "type": "array", - "description": "Alerts", - "items": { - "type": "object", - "properties": { - "id": { - "maximum": 255, - "minimum": 0, - "maxLength": 255, - "type": "integer", - "format": "int64", - "example": 66 - }, - "status": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "CREATED", - "enum": [ + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "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 Asset", + "content" : { + "application/json" : { + "schema" : { + "maxItems" : 2147483647, + "type" : "array", + "description" : "Alerts", + "items" : { + "type" : "object", + "properties" : { + "id" : { + "maximum" : 255, + "minimum" : 0, + "maxLength" : 255, + "type" : "integer", + "format" : "int64", + "example" : 66 + }, + "status" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "CREATED", + "enum" : [ "CREATED", "SENT", "RECEIVED", @@ -3229,97 +3271,97 @@ "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" - }, - "assetIds": { - "maxItems": 1000, - "minItems": 0, - "type": "array", - "example": [ + "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" + }, + "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\"]" + "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": [ + "channel" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "SENDER", + "enum" : [ "SENDER", "RECEIVER" ] }, - "reason": { - "$ref": "#/components/schemas/QualityNotificationReasonResponse" - }, - "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": [ + "reason" : { + "$ref" : "#/components/schemas/QualityNotificationReasonResponse" + }, + "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" ] }, - "targetDate": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "example": "2099-02-21T21:27:10.734950Z" - }, - "errorMessage": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "EDC not reachable" - }, - "qualityNotificationMessageResponseList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QualityNotificationMessageResponse" + "targetDate" : { + "maxLength" : 50, + "minLength" : 0, + "type" : "string", + "example" : "2099-02-21T21:27:10.734950Z" + }, + "errorMessage" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "EDC not reachable" + }, + "qualityNotificationMessageResponseList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/QualityNotificationMessageResponse" } } } @@ -3328,238 +3370,198 @@ } } }, - "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" - } - } - } - }, - "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" } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/assets/as-planned/{assetId}": { - "get": { - "tags": [ + "/assets/as-planned/{assetId}" : { + "get" : { + "tags" : [ "AssetsAsPlanned" ], - "summary": "Get asset by id", - "description": "The endpoint returns an asset filtered by id .", - "operationId": "assetById", - "parameters": [ + "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" + "name" : "assetId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" } } ], - "responses": { - "403": { - "description": "Forbidden.", - "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" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "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, - "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": [ + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "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" + } + } + } + }, + "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, + "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" + "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" + "parentRelations" : { + "maxItems" : 2147483647, + "type" : "array", + "description" : "Parent relationships", + "items" : { + "$ref" : "#/components/schemas/DescriptionsResponse" } }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ + "qualityType" : { + "type" : "string", + "example" : "Ok", + "enum" : [ "Ok", "Minor", "Major", @@ -3567,16 +3569,16 @@ "LifeThreatening" ] }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" + "van" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "OMAYSKEITUGNVHKKX" }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ + "semanticDataModel" : { + "type" : "string", + "example" : "BATCH", + "enum" : [ "BATCH", "SERIALPART", "UNKNOWN", @@ -3586,58 +3588,58 @@ "TOMBSTONEASPLANNED" ] }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" + "classification" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "component" }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" + "detailAspectModels" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DetailAspectModelResponse" } }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 + "sentQualityAlertIdsInStatusActive" : { + "type" : "array", + "example" : 1, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 1 } }, - "receivedQualityAlertIdsInStatusActive": { - "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 + "sentQualityInvestigationIdsInStatusActive" : { + "type" : "array", + "example" : 2, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 2 } }, - "receivedQualityInvestigationIdsInStatusActive": { - "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": [ + "importState" : { + "type" : "string", + "example" : "TRANSIENT", + "enum" : [ "TRANSIENT", "PERSISTENT", "ERROR", @@ -3645,17 +3647,17 @@ "UNSET" ] }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" + "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" + "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" + "contractAgreementId" : { + "type" : "string", + "example" : "TODO" } } } @@ -3663,176 +3665,206 @@ } } }, - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "403" : { + "description" : "Forbidden.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "415" : { + "description" : "Unsupported media type", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] }, - "patch": { - "tags": [ + "patch" : { + "tags" : [ "AssetsAsPlanned" ], - "summary": "Updates asset", - "description": "The endpoint updates asset by provided quality type.", - "operationId": "updateAsset", - "parameters": [ + "summary" : "Updates asset", + "description" : "The endpoint updates asset by provided quality type.", + "operationId" : "updateAsset", + "parameters" : [ { - "name": "assetId", - "in": "path", - "required": true, - "schema": { - "type": "string" + "name" : "assetId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateAssetRequest" + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAssetRequest" } } }, - "required": true + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "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" - } - } - } - }, - "404": { - "description": "Not found.", - "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": [ + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "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" + } + } + } + }, + "429" : { + "description" : "Too many requests.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "400" : { + "description" : "Bad request.", + "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" + "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" + "parentRelations" : { + "maxItems" : 2147483647, + "type" : "array", + "description" : "Parent relationships", + "items" : { + "$ref" : "#/components/schemas/DescriptionsResponse" } }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ + "qualityType" : { + "type" : "string", + "example" : "Ok", + "enum" : [ "Ok", "Minor", "Major", @@ -3840,16 +3872,16 @@ "LifeThreatening" ] }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" + "van" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "OMAYSKEITUGNVHKKX" }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ + "semanticDataModel" : { + "type" : "string", + "example" : "BATCH", + "enum" : [ "BATCH", "SERIALPART", "UNKNOWN", @@ -3859,58 +3891,58 @@ "TOMBSTONEASPLANNED" ] }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" + "classification" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "component" }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" + "detailAspectModels" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DetailAspectModelResponse" } }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 + "sentQualityAlertIdsInStatusActive" : { + "type" : "array", + "example" : 1, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 1 } }, - "receivedQualityAlertIdsInStatusActive": { - "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 + "sentQualityInvestigationIdsInStatusActive" : { + "type" : "array", + "example" : 2, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 2 } }, - "receivedQualityInvestigationIdsInStatusActive": { - "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": [ + "importState" : { + "type" : "string", + "example" : "TRANSIENT", + "enum" : [ "TRANSIENT", "PERSISTENT", "ERROR", @@ -3918,17 +3950,17 @@ "UNSET" ] }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" + "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" + "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" + "contractAgreementId" : { + "type" : "string", + "example" : "TODO" } } } @@ -3936,218 +3968,138 @@ } } }, - "400": { - "description": "Bad request.", - "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" - } - } - } - }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/assets/as-built/{assetId}": { - "get": { - "tags": [ + "/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": [ + "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" + "name" : "assetId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" } } ], - "responses": { - "403": { - "description": "Forbidden.", - "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" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Authorization failed.", - "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": [ + "responses" : { + "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" + "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" + "parentRelations" : { + "maxItems" : 2147483647, + "type" : "array", + "description" : "Parent relationships", + "items" : { + "$ref" : "#/components/schemas/DescriptionsResponse" } }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ + "qualityType" : { + "type" : "string", + "example" : "Ok", + "enum" : [ "Ok", "Minor", "Major", @@ -4155,16 +4107,16 @@ "LifeThreatening" ] }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" + "van" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "OMAYSKEITUGNVHKKX" }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ + "semanticDataModel" : { + "type" : "string", + "example" : "BATCH", + "enum" : [ "BATCH", "SERIALPART", "UNKNOWN", @@ -4174,58 +4126,58 @@ "TOMBSTONEASPLANNED" ] }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" + "classification" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "component" }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" + "detailAspectModels" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DetailAspectModelResponse" } }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 + "sentQualityAlertIdsInStatusActive" : { + "type" : "array", + "example" : 1, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 1 } }, - "receivedQualityAlertIdsInStatusActive": { - "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 + "sentQualityInvestigationIdsInStatusActive" : { + "type" : "array", + "example" : 2, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 2 } }, - "receivedQualityInvestigationIdsInStatusActive": { - "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": [ + "importState" : { + "type" : "string", + "example" : "TRANSIENT", + "enum" : [ "TRANSIENT", "PERSISTENT", "ERROR", @@ -4233,184 +4185,254 @@ "UNSET" ] }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" + "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" + "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" + "contractAgreementId" : { + "type" : "string", + "example" : "TODO" } } } } } } + }, + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "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" + } + } + } + }, + "429" : { + "description" : "Too many requests.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "400" : { + "description" : "Bad request.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "403" : { + "description" : "Forbidden.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "415" : { + "description" : "Unsupported media type", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] }, - "patch": { - "tags": [ + "patch" : { + "tags" : [ "AssetsAsBuilt" ], - "summary": "Updates asset", - "description": "The endpoint updates asset by provided quality type.", - "operationId": "updateAsset_1", - "parameters": [ + "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" + "name" : "assetId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateAssetRequest" + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAssetRequest" } } }, - "required": true + "required" : true }, - "responses": { - "403": { - "description": "Forbidden.", - "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" - } - } - } - }, - "404": { - "description": "Not found.", - "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": [ + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "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" + } + } + } + }, + "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" + "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" + "parentRelations" : { + "maxItems" : 2147483647, + "type" : "array", + "description" : "Parent relationships", + "items" : { + "$ref" : "#/components/schemas/DescriptionsResponse" } }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ + "qualityType" : { + "type" : "string", + "example" : "Ok", + "enum" : [ "Ok", "Minor", "Major", @@ -4418,16 +4440,16 @@ "LifeThreatening" ] }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" + "van" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "OMAYSKEITUGNVHKKX" }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ + "semanticDataModel" : { + "type" : "string", + "example" : "BATCH", + "enum" : [ "BATCH", "SERIALPART", "UNKNOWN", @@ -4437,58 +4459,58 @@ "TOMBSTONEASPLANNED" ] }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" + "classification" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "component" }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" + "detailAspectModels" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DetailAspectModelResponse" } }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 + "sentQualityAlertIdsInStatusActive" : { + "type" : "array", + "example" : 1, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 1 } }, - "receivedQualityAlertIdsInStatusActive": { - "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 + "sentQualityInvestigationIdsInStatusActive" : { + "type" : "array", + "example" : 2, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 2 } }, - "receivedQualityInvestigationIdsInStatusActive": { - "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": [ + "importState" : { + "type" : "string", + "example" : "TRANSIENT", + "enum" : [ "TRANSIENT", "PERSISTENT", "ERROR", @@ -4496,17 +4518,17 @@ "UNSET" ] }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" + "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" + "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" + "contractAgreementId" : { + "type" : "string", + "example" : "TODO" } } } @@ -4514,863 +4536,883 @@ } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/registry/reload": { - "get": { - "tags": [ + "/registry/reload" : { + "get" : { + "tags" : [ "Registry" ], - "summary": "Triggers reload of shell descriptors", - "description": "The endpoint Triggers reload of shell descriptors.", - "operationId": "reload", - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "summary" : "Triggers reload of shell descriptors", + "description" : "The endpoint Triggers reload of shell descriptors.", + "operationId" : "reload", + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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" } } } }, - "202": { - "description": "Created registry reload job." + "202" : { + "description" : "Created registry reload job." }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/policies": { - "get": { - "tags": [ + "/policies" : { + "get" : { + "tags" : [ "Policies" ], - "summary": "Get all policies ", - "description": "The endpoint returns all policies .", - "operationId": "policy", - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "summary" : "Get all policies ", + "description" : "The endpoint returns all policies .", + "operationId" : "policy", + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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" } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/PolicyResponse" + "200" : { + "description" : "Returns the policies", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/PolicyResponse" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/investigations/{investigationId}": { - "get": { - "tags": [ + "/investigations/{investigationId}" : { + "get" : { + "tags" : [ "Investigations" ], - "summary": "Gets investigations by id", - "description": "The endpoint returns investigations as paged result by their id.", - "operationId": "getInvestigation", - "parameters": [ + "summary" : "Gets investigations by id", + "description" : "The endpoint returns investigations as paged result by their id.", + "operationId" : "getInvestigation", + "parameters" : [ { - "name": "investigationId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "name" : "investigationId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int64" } } ], - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "200" : { + "description" : "OK.", + "content" : { + "application/json" : { + "schema" : { + "maxItems" : 2147483647, + "minItems" : -2147483648, + "type" : "array", + "description" : "Investigations", + "items" : { + "$ref" : "#/components/schemas/InvestigationResponse" + } } } } }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "401" : { + "description" : "Authorization failed.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": -2147483648, - "type": "array", - "description": "Investigations", - "items": { - "$ref": "#/components/schemas/InvestigationResponse" - } + "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" } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/investigations/distinctFilterValues": { - "get": { - "tags": [ + "/investigations/distinctFilterValues" : { + "get" : { + "tags" : [ "Assets", "Investigations" ], - "summary": "getDistinctFilterValues", - "description": "The endpoint returns a distinct filter values for given fieldName.", - "operationId": "distinctFilterValues", - "parameters": [ + "summary" : "getDistinctFilterValues", + "description" : "The endpoint returns a distinct filter values for given fieldName.", + "operationId" : "distinctFilterValues", + "parameters" : [ { - "name": "fieldName", - "in": "query", - "required": true, - "schema": { - "type": "string" + "name" : "fieldName", + "in" : "query", + "required" : true, + "schema" : { + "type" : "string" } }, { - "name": "size", - "in": "query", - "required": true, - "schema": { - "type": "integer", - "format": "int32" + "name" : "size", + "in" : "query", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int32" } }, { - "name": "startWith", - "in": "query", - "required": true, - "schema": { - "type": "string" + "name" : "startWith", + "in" : "query", + "required" : true, + "schema" : { + "type" : "string" } }, { - "name": "channel", - "in": "query", - "required": true, - "schema": { - "type": "string", - "enum": [ + "name" : "channel", + "in" : "query", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "SENDER", "RECEIVER" ] } } ], - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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 a distinct filter values for given fieldName.", + "content" : { + "application/json" : { + "schema" : { + "maxItems" : 2147483647, + "minItems" : 0, + "type" : "array", + "items" : { + "type" : "string" + } } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "429" : { + "description" : "Too many requests.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/dashboard": { - "get": { - "tags": [ + "/dashboard" : { + "get" : { + "tags" : [ "Dashboard" ], - "summary": "Returns dashboard related data", - "description": "The endpoint can return limited data based on the user role", - "operationId": "dashboard", - "responses": { - "200": { - "description": "Returns dashboard data", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DashboardResponse" + "summary" : "Returns dashboard related data", + "description" : "The endpoint can return limited data based on the user role", + "operationId" : "dashboard", + "responses" : { + "404" : { + "description" : "Not found.", + "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" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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" } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/assets/import/report/{importJobId}": { - "get": { - "tags": [ + "/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": [ + "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" + "name" : "importJobId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" } } ], - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "204" : { + "description" : "No Content." + }, + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "200" : { + "description" : "OK.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ImportReportResponse" } } } }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "401" : { + "description" : "Authorization failed.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "204": { - "description": "No Content." - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "500" : { + "description" : "Internal server error.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "429" : { + "description" : "Too many requests.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "401": { - "description": "Authorization failed.", - "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/ImportReportResponse" + "415" : { + "description" : "Unsupported media type", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/assets/as-planned": { - "get": { - "tags": [ + "/assets/as-planned" : { + "get" : { + "tags" : [ "AssetsAsPlanned" ], - "summary": "Get assets by pagination", - "description": "The endpoint returns a paged result of assets.", - "operationId": "AssetsAsPlanned", - "parameters": [ + "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" : "pageable", + "in" : "query", + "required" : true, + "schema" : { + "$ref" : "#/components/schemas/OwnPageable" } }, { - "name": "filter", - "in": "query", - "required": true, - "schema": { - "$ref": "#/components/schemas/SearchCriteriaRequestParam" + "name" : "filter", + "in" : "query", + "required" : true, + "schema" : { + "$ref" : "#/components/schemas/SearchCriteriaRequestParam" } } ], - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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 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" + "400" : { + "description" : "Bad request.", + "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" + "idShort" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "assembly-part-relationship" }, - "semanticModelId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "NO-246880451848384868750731" + "semanticModelId" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "NO-246880451848384868750731" }, - "businessPartner": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003CSGV" + "businessPartner" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "BPNL00000003CSGV" }, - "manufacturerName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" + "manufacturerName" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "Tier C" }, - "nameAtManufacturer": { - "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" + "manufacturerPartId" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "Tier C" }, - "owner": { - "type": "string", - "example": "CUSTOMER", - "enum": [ + "owner" : { + "type" : "string", + "example" : "CUSTOMER", + "enum" : [ "SUPPLIER", "CUSTOMER", "OWN", "UNKNOWN" ] }, - "childRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Child relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" + "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" + "parentRelations" : { + "maxItems" : 2147483647, + "type" : "array", + "description" : "Parent relationships", + "items" : { + "$ref" : "#/components/schemas/DescriptionsResponse" } }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ + "qualityType" : { + "type" : "string", + "example" : "Ok", + "enum" : [ "Ok", "Minor", "Major", @@ -5378,16 +5420,16 @@ "LifeThreatening" ] }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" + "van" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "OMAYSKEITUGNVHKKX" }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ + "semanticDataModel" : { + "type" : "string", + "example" : "BATCH", + "enum" : [ "BATCH", "SERIALPART", "UNKNOWN", @@ -5397,58 +5439,58 @@ "TOMBSTONEASPLANNED" ] }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" + "classification" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "component" }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" + "detailAspectModels" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DetailAspectModelResponse" } }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 + "sentQualityAlertIdsInStatusActive" : { + "type" : "array", + "example" : 1, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 1 } }, - "receivedQualityAlertIdsInStatusActive": { - "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 + "sentQualityInvestigationIdsInStatusActive" : { + "type" : "array", + "example" : 2, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 2 } }, - "receivedQualityInvestigationIdsInStatusActive": { - "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": [ + "importState" : { + "type" : "string", + "example" : "TRANSIENT", + "enum" : [ "TRANSIENT", "PERSISTENT", "ERROR", @@ -5456,17 +5498,17 @@ "UNSET" ] }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" + "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" + "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" + "contractAgreementId" : { + "type" : "string", + "example" : "TODO" } } } @@ -5475,88 +5517,68 @@ } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/assets/as-planned/distinctFilterValues": { - "get": { - "tags": [ + "/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": [ + "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" : "fieldName", + "in" : "query", + "required" : true, + "schema" : { + "type" : "string" } }, { - "name": "size", - "in": "query", - "required": true, - "schema": { - "type": "integer", - "format": "int32" + "name" : "size", + "in" : "query", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int32" } }, { - "name": "startWith", - "in": "query", - "required": true, - "schema": { - "type": "string" + "name" : "startWith", + "in" : "query", + "required" : true, + "schema" : { + "type" : "string" } }, { - "name": "owner", - "in": "query", - "required": true, - "schema": { - "type": "string", - "enum": [ + "name" : "owner", + "in" : "query", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "SUPPLIER", "CUSTOMER", "OWN", @@ -5565,214 +5587,264 @@ } } ], - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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 a distinct filter values for given fieldName.", + "content" : { + "application/json" : { + "schema" : { + "maxItems" : 2147483647, + "minItems" : 0, + "type" : "array", + "items" : { + "type" : "string" + } } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "429" : { + "description" : "Too many requests.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/assets/as-planned/*/children/{childId}": { - "get": { - "tags": [ + "/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": [ + "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" + "name" : "childId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" } } ], - "responses": { - "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": [ + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "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" + } + } + } + }, + "429" : { + "description" : "Too many requests.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "400" : { + "description" : "Bad request.", + "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" + "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" + "parentRelations" : { + "maxItems" : 2147483647, + "type" : "array", + "description" : "Parent relationships", + "items" : { + "$ref" : "#/components/schemas/DescriptionsResponse" } }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ + "qualityType" : { + "type" : "string", + "example" : "Ok", + "enum" : [ "Ok", "Minor", "Major", @@ -5780,16 +5852,16 @@ "LifeThreatening" ] }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" + "van" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "OMAYSKEITUGNVHKKX" }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ + "semanticDataModel" : { + "type" : "string", + "example" : "BATCH", + "enum" : [ "BATCH", "SERIALPART", "UNKNOWN", @@ -5799,58 +5871,58 @@ "TOMBSTONEASPLANNED" ] }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" + "classification" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "component" }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" + "detailAspectModels" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DetailAspectModelResponse" } }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 + "sentQualityAlertIdsInStatusActive" : { + "type" : "array", + "example" : 1, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 1 } }, - "receivedQualityAlertIdsInStatusActive": { - "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 + "sentQualityInvestigationIdsInStatusActive" : { + "type" : "array", + "example" : 2, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 2 } }, - "receivedQualityInvestigationIdsInStatusActive": { - "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": [ + "importState" : { + "type" : "string", + "example" : "TRANSIENT", + "enum" : [ "TRANSIENT", "PERSISTENT", "ERROR", @@ -5858,17 +5930,17 @@ "UNSET" ] }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" + "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" + "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" + "contractAgreementId" : { + "type" : "string", + "example" : "TODO" } } } @@ -5876,230 +5948,140 @@ } } }, - "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" - } - } - } - }, - "404": { - "description": "Not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/assets/as-built": { - "get": { - "tags": [ + "/assets/as-built" : { + "get" : { + "tags" : [ "AssetsAsBuilt" ], - "summary": "Get assets by pagination", - "description": "The endpoint returns a paged result of assets.", - "operationId": "assets", - "parameters": [ + "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" : "pageable", + "in" : "query", + "required" : true, + "schema" : { + "$ref" : "#/components/schemas/OwnPageable" } }, { - "name": "searchCriteriaRequestParam", - "in": "query", - "required": true, - "schema": { - "$ref": "#/components/schemas/SearchCriteriaRequestParam" + "name" : "searchCriteriaRequestParam", + "in" : "query", + "required" : true, + "schema" : { + "$ref" : "#/components/schemas/SearchCriteriaRequestParam" } } ], - "responses": { - "403": { - "description": "Forbidden.", - "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" - } - } - } - }, - "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" + "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" + "idShort" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "assembly-part-relationship" }, - "semanticModelId": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "NO-246880451848384868750731" + "semanticModelId" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "NO-246880451848384868750731" }, - "businessPartner": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003CSGV" + "businessPartner" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "BPNL00000003CSGV" }, - "manufacturerName": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "Tier C" + "manufacturerName" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "Tier C" }, - "nameAtManufacturer": { - "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" + "manufacturerPartId" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "Tier C" }, - "owner": { - "type": "string", - "example": "CUSTOMER", - "enum": [ + "owner" : { + "type" : "string", + "example" : "CUSTOMER", + "enum" : [ "SUPPLIER", "CUSTOMER", "OWN", "UNKNOWN" ] }, - "childRelations": { - "maxItems": 2147483647, - "type": "array", - "description": "Child relationships", - "items": { - "$ref": "#/components/schemas/DescriptionsResponse" + "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" + "parentRelations" : { + "maxItems" : 2147483647, + "type" : "array", + "description" : "Parent relationships", + "items" : { + "$ref" : "#/components/schemas/DescriptionsResponse" } }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ + "qualityType" : { + "type" : "string", + "example" : "Ok", + "enum" : [ "Ok", "Minor", "Major", @@ -6107,16 +6089,16 @@ "LifeThreatening" ] }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" + "van" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "OMAYSKEITUGNVHKKX" }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ + "semanticDataModel" : { + "type" : "string", + "example" : "BATCH", + "enum" : [ "BATCH", "SERIALPART", "UNKNOWN", @@ -6126,58 +6108,58 @@ "TOMBSTONEASPLANNED" ] }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" + "classification" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "component" }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" + "detailAspectModels" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DetailAspectModelResponse" } }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 + "sentQualityAlertIdsInStatusActive" : { + "type" : "array", + "example" : 1, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 1 } }, - "receivedQualityAlertIdsInStatusActive": { - "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 + "sentQualityInvestigationIdsInStatusActive" : { + "type" : "array", + "example" : 2, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 2 } }, - "receivedQualityInvestigationIdsInStatusActive": { - "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": [ + "importState" : { + "type" : "string", + "example" : "TRANSIENT", + "enum" : [ "TRANSIENT", "PERSISTENT", "ERROR", @@ -6185,17 +6167,17 @@ "UNSET" ] }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" + "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" + "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" + "contractAgreementId" : { + "type" : "string", + "example" : "TODO" } } } @@ -6204,88 +6186,128 @@ } } }, - "400": { - "description": "Bad request.", - "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" + "401" : { + "description" : "Authorization failed.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "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" + } + } + } + }, + "429" : { + "description" : "Too many requests.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "400" : { + "description" : "Bad request.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "403" : { + "description" : "Forbidden.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "415" : { + "description" : "Unsupported media type", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/assets/as-built/distinctFilterValues": { - "get": { - "tags": [ + "/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": [ + "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" : "fieldName", + "in" : "query", + "required" : true, + "schema" : { + "type" : "string" } }, { - "name": "size", - "in": "query", - "required": true, - "schema": { - "type": "integer", - "format": "int32" + "name" : "size", + "in" : "query", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int32" } }, { - "name": "startWith", - "in": "query", - "required": true, - "schema": { - "type": "string" + "name" : "startWith", + "in" : "query", + "required" : true, + "schema" : { + "type" : "string" } }, { - "name": "owner", - "in": "query", - "required": true, - "schema": { - "type": "string", - "enum": [ + "name" : "owner", + "in" : "query", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "SUPPLIER", "CUSTOMER", "OWN", @@ -6294,338 +6316,378 @@ } } ], - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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 a distinct filter values for given fieldName.", + "content" : { + "application/json" : { + "schema" : { + "maxItems" : 2147483647, + "minItems" : 0, + "type" : "array", + "items" : { + "type" : "string" + } } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "429" : { + "description" : "Too many requests.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/assets/as-built/countries": { - "get": { - "tags": [ + "/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": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "summary" : "Get map of assets", + "description" : "The endpoint returns a map for assets consumed by the map.", + "operationId" : "assetsCountryMap", + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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 assets found", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "minItems": 0, - "type": "array", - "items": { - "type": "string" - } + "400" : { + "description" : "Bad request.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad request.", - "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" + "415" : { + "description" : "Unsupported media type", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "401": { - "description": "Authorization failed.", - "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" + } } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/assets/as-built/*/children/{childId}": { - "get": { - "tags": [ + "/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": [ + "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" + "name" : "childId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" } } ], - "responses": { - "403": { - "description": "Forbidden.", - "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 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": [ + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "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" + } + } + } + }, + "429" : { + "description" : "Too many requests.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "400" : { + "description" : "Bad request.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "403" : { + "description" : "Forbidden.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "415" : { + "description" : "Unsupported media type", + "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" + "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" + "parentRelations" : { + "maxItems" : 2147483647, + "type" : "array", + "description" : "Parent relationships", + "items" : { + "$ref" : "#/components/schemas/DescriptionsResponse" } }, - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ + "qualityType" : { + "type" : "string", + "example" : "Ok", + "enum" : [ "Ok", "Minor", "Major", @@ -6633,16 +6695,16 @@ "LifeThreatening" ] }, - "van": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "OMAYSKEITUGNVHKKX" + "van" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "OMAYSKEITUGNVHKKX" }, - "semanticDataModel": { - "type": "string", - "example": "BATCH", - "enum": [ + "semanticDataModel" : { + "type" : "string", + "example" : "BATCH", + "enum" : [ "BATCH", "SERIALPART", "UNKNOWN", @@ -6652,58 +6714,58 @@ "TOMBSTONEASPLANNED" ] }, - "classification": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "component" + "classification" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "component" }, - "detailAspectModels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DetailAspectModelResponse" + "detailAspectModels" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DetailAspectModelResponse" } }, - "sentQualityAlertIdsInStatusActive": { - "type": "array", - "example": 1, - "items": { - "type": "integer", - "format": "int64", - "example": 1 + "sentQualityAlertIdsInStatusActive" : { + "type" : "array", + "example" : 1, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 1 } }, - "receivedQualityAlertIdsInStatusActive": { - "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 + "sentQualityInvestigationIdsInStatusActive" : { + "type" : "array", + "example" : 2, + "items" : { + "type" : "integer", + "format" : "int64", + "example" : 2 } }, - "receivedQualityInvestigationIdsInStatusActive": { - "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": [ + "importState" : { + "type" : "string", + "example" : "TRANSIENT", + "enum" : [ "TRANSIENT", "PERSISTENT", "ERROR", @@ -6711,527 +6773,487 @@ "UNSET" ] }, - "importNote": { - "type": "string", - "example": "Asset created successfully in transient state" + "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" + "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" + "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" - } - } - } - }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/alerts/{alertId}": { - "get": { - "tags": [ + "/alerts/{alertId}" : { + "get" : { + "tags" : [ "Alerts" ], - "summary": "Gets Alert by id", - "description": "The endpoint returns alert by id.", - "operationId": "getAlert", - "parameters": [ + "summary" : "Gets Alert by id", + "description" : "The endpoint returns alert by id.", + "operationId" : "getAlert", + "parameters" : [ { - "name": "alertId", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "name" : "alertId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int64" } } ], - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" + } + } + } + }, + "200" : { + "description" : "OK.", + "content" : { + "application/json" : { + "schema" : { + "maxItems" : 2147483647, + "type" : "array", + "description" : "Alerts", + "items" : { + "$ref" : "#/components/schemas/AlertResponse" + } } } } }, - "500": { - "description": "Internal server error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "401" : { + "description" : "Authorization failed.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "maxItems": 2147483647, - "type": "array", - "description": "Alerts", - "items": { - "$ref": "#/components/schemas/AlertResponse" - } + "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" } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/alerts/distinctFilterValues": { - "get": { - "tags": [ + "/alerts/distinctFilterValues" : { + "get" : { + "tags" : [ "Assets", "Alerts" ], - "summary": "getDistinctFilterValues", - "description": "The endpoint returns a distinct filter values for given fieldName.", - "operationId": "distinctFilterValues_3", - "parameters": [ + "summary" : "getDistinctFilterValues", + "description" : "The endpoint returns a distinct filter values for given fieldName.", + "operationId" : "distinctFilterValues_3", + "parameters" : [ { - "name": "fieldName", - "in": "query", - "required": true, - "schema": { - "type": "string" + "name" : "fieldName", + "in" : "query", + "required" : true, + "schema" : { + "type" : "string" } }, { - "name": "size", - "in": "query", - "required": true, - "schema": { - "type": "integer", - "format": "int32" + "name" : "size", + "in" : "query", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int32" } }, { - "name": "startWith", - "in": "query", - "required": true, - "schema": { - "type": "string" + "name" : "startWith", + "in" : "query", + "required" : true, + "schema" : { + "type" : "string" } }, { - "name": "channel", - "in": "query", - "required": true, - "schema": { - "type": "string", - "enum": [ + "name" : "channel", + "in" : "query", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "SENDER", "RECEIVER" ] } } ], - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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 a distinct filter values for given fieldName.", + "content" : { + "application/json" : { + "schema" : { + "maxItems" : 2147483647, + "minItems" : 0, + "type" : "array", + "items" : { + "type" : "string" + } } } } }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "429" : { + "description" : "Too many requests.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "429": { - "description": "Too many requests.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/submodel/data": { - "delete": { - "tags": [ + "/submodel/data" : { + "delete" : { + "tags" : [ "Submodel" ], - "summary": "Delete All Submodels", - "description": "Deletes all submodels from the system.", - "operationId": "deleteSubmodels", - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "summary" : "Delete All Submodels", + "description" : "Deletes all submodels from the system.", + "operationId" : "deleteSubmodels", + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "200" : { + "description" : "Ok." + }, + "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" + "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." - }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "401": { - "description": "Authorization failed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "204" : { + "description" : "No Content." + }, + "415" : { + "description" : "Unsupported media type", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } ] } }, - "/bpn-config/{bpn}": { - "delete": { - "tags": [ + "/bpn-config/{bpn}" : { + "delete" : { + "tags" : [ "BpnEdcMapping" ], - "summary": "Deletes BPN EDC URL mappings", - "description": "The endpoint deletes BPN EDC URL mappings", - "operationId": "deleteBpnEdcUrlMappings", - "parameters": [ + "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" + "name" : "bpn", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" } } ], - "responses": { - "403": { - "description": "Forbidden.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "responses" : { + "404" : { + "description" : "Not found.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ErrorResponse" } } } }, - "415": { - "description": "Unsupported media type", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "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" + "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": "Okay" - }, - "204": { - "description": "Deleted." + "204" : { + "description" : "Deleted." }, - "400": { - "description": "Bad request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "400" : { + "description" : "Bad request.", + "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" } } } }, - "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" } } } + }, + "200" : { + "description" : "Okay" } }, - "security": [ + "security" : [ { - "oAuth2": [ + "oAuth2" : [ "profile email" ] } @@ -7239,209 +7261,210 @@ } } }, - "components": { - "schemas": { - "BpnMappingRequest": { - "required": [ + "components" : { + "schemas" : { + "BpnMappingRequest" : { + "required" : [ "bpn", "url" ], - "type": "object", - "properties": { - "bpn": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "BPNL00000003CSGV" - }, - "url": { - "maxLength": 255, - "minLength": 0, - "type": "string" + "type" : "object", + "properties" : { + "bpn" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "BPNL00000003CSGV" + }, + "url" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string" } } }, - "ErrorResponse": { - "type": "object", - "properties": { - "message": { - "maxLength": 1000, - "minLength": 0, - "pattern": "^.*$", - "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" } } }, - "BpnEdcMappingResponse": { - "type": "object", - "properties": { - "bpn": { - "type": "string", - "example": "BPNL00000003CSGV" - }, - "url": { - "type": "string", - "example": "https://trace-x-test-edc.dev.demo.catena-x.net/a1" + "ErrorResponse" : { + "type" : "object", + "properties" : { + "message" : { + "maxLength" : 1000, + "minLength" : 0, + "pattern" : "^.*$", + "type" : "string", + "example" : "Access Denied" } } }, - "StartQualityNotificationRequest": { - "required": [ + "StartQualityNotificationRequest" : { + "required" : [ "severity" ], - "type": "object", - "properties": { - "partIds": { - "maxLength": 100, - "minLength": 1, - "maxItems": 50, - "minItems": 1, - "type": "array", - "example": [ + "type" : "object", + "properties" : { + "partIds" : { + "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": [ + "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": "BPN00001123123AS" + "receiverBpn" : { + "type" : "string", + "example" : "BPN00001123123AS" }, - "asBuilt": { - "type": "boolean" + "asBuilt" : { + "type" : "boolean" } } }, - "QualityNotificationIdResponse": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1 + "QualityNotificationIdResponse" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64", + "example" : 1 } } }, - "UpdateQualityNotificationRequest": { - "required": [ + "UpdateQualityNotificationRequest" : { + "required" : [ "status" ], - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "The UpdateInvestigationStatus", - "enum": [ + "type" : "object", + "properties" : { + "status" : { + "type" : "string", + "description" : "The UpdateInvestigationStatus", + "enum" : [ "ACKNOWLEDGED", "ACCEPTED", "DECLINED" ] }, - "reason": { - "type": "string", - "example": "The reason." + "reason" : { + "type" : "string", + "example" : "The reason." } } }, - "CloseQualityNotificationRequest": { - "type": "object", - "properties": { - "reason": { - "maxLength": 1000, - "minLength": 15, - "type": "string", - "example": "The reason." + "CloseQualityNotificationRequest" : { + "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" + "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" + "PageableFilterRequest" : { + "type" : "object", + "properties" : { + "pageAble" : { + "$ref" : "#/components/schemas/OwnPageable" }, - "searchCriteria": { - "$ref": "#/components/schemas/SearchCriteriaRequestParam" + "searchCriteria" : { + "$ref" : "#/components/schemas/SearchCriteriaRequestParam" } } }, - "SearchCriteriaRequestParam": { - "type": "object", - "properties": { - "filter": { - "maxItems": 2147483647, - "type": "array", - "description": "Filter Criteria", - "example": "owner,EQUAL,OWN", - "items": { - "type": "string" + "SearchCriteriaRequestParam" : { + "type" : "object", + "properties" : { + "filter" : { + "maxItems" : 2147483647, + "type" : "array", + "description" : "Filter Criteria", + "example" : "owner,EQUAL,OWN", + "items" : { + "type" : "string" } } } }, - "InvestigationResponse": { - "type": "object", - "properties": { - "id": { - "maximum": 255, - "minimum": 0, - "maxLength": 255, - "type": "integer", - "format": "int64", - "example": 66 - }, - "status": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "CREATED", - "enum": [ + "InvestigationResponse" : { + "type" : "object", + "properties" : { + "id" : { + "maximum" : 255, + "minimum" : 0, + "maxLength" : 255, + "type" : "integer", + "format" : "int64", + "example" : 66 + }, + "status" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "CREATED", + "enum" : [ "CREATED", "SENT", "RECEIVED", @@ -7452,161 +7475,161 @@ "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" - }, - "assetIds": { - "maxItems": 1000, - "minItems": 0, - "type": "array", - "example": [ + "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" + }, + "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\"]" + "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": [ + "channel" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "SENDER", + "enum" : [ "SENDER", "RECEIVER" ] }, - "reason": { - "$ref": "#/components/schemas/QualityNotificationReasonResponse" - }, - "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": [ + "reason" : { + "$ref" : "#/components/schemas/QualityNotificationReasonResponse" + }, + "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" ] }, - "targetDate": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "example": "2099-02-21T21:27:10.734950Z" + "targetDate" : { + "maxLength" : 50, + "minLength" : 0, + "type" : "string", + "example" : "2099-02-21T21:27:10.734950Z" }, - "errorMessage": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "EDC not reachable" + "errorMessage" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "EDC not reachable" }, - "qualityNotificationMessageResponseList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QualityNotificationMessageResponse" + "qualityNotificationMessageResponseList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/QualityNotificationMessageResponse" } } } }, - "QualityNotificationMessageResponse": { - "type": "object", - "properties": { - "id": { - "type": "string" + "QualityNotificationMessageResponse" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" }, - "createdBy": { - "type": "string" + "createdBy" : { + "type" : "string" }, - "createdByName": { - "type": "string" + "createdByName" : { + "type" : "string" }, - "sendTo": { - "type": "string" + "sendTo" : { + "type" : "string" }, - "sendToName": { - "type": "string" + "sendToName" : { + "type" : "string" }, - "edcUrl": { - "type": "string" + "edcUrl" : { + "type" : "string" }, - "contractAgreementId": { - "type": "string" + "contractAgreementId" : { + "type" : "string" }, - "notificationReferenceId": { - "type": "string" + "notificationReferenceId" : { + "type" : "string" }, - "targetDate": { - "type": "string", - "format": "date-time" + "targetDate" : { + "type" : "string", + "format" : "date-time" }, - "severity": { - "type": "string", - "enum": [ + "severity" : { + "type" : "string", + "enum" : [ "MINOR", "MAJOR", "CRITICAL", "LIFE-THREATENING" ] }, - "edcNotificationId": { - "type": "string" + "edcNotificationId" : { + "type" : "string" }, - "created": { - "type": "string", - "format": "date-time" + "created" : { + "type" : "string", + "format" : "date-time" }, - "updated": { - "type": "string", - "format": "date-time" + "updated" : { + "type" : "string", + "format" : "date-time" }, - "messageId": { - "type": "string" + "messageId" : { + "type" : "string" }, - "isInitial": { - "type": "boolean" + "isInitial" : { + "type" : "boolean" }, - "status": { - "type": "string", - "enum": [ + "status" : { + "type" : "string", + "enum" : [ "CREATED", "SENT", "RECEIVED", @@ -7617,51 +7640,51 @@ "CLOSED" ] }, - "errorMessage": { - "type": "string" + "errorMessage" : { + "type" : "string" } } }, - "QualityNotificationReasonResponse": { - "type": "object", - "properties": { - "close": { - "maxLength": 1000, - "minLength": 0, - "type": "string", - "example": "description of closing reason" - }, - "accept": { - "maxLength": 1000, - "minLength": 0, - "type": "string", - "example": "description of accepting reason" - }, - "decline": { - "maxLength": 1000, - "minLength": 0, - "type": "string", - "example": "description of declining reason" + "QualityNotificationReasonResponse" : { + "type" : "object", + "properties" : { + "close" : { + "maxLength" : 1000, + "minLength" : 0, + "type" : "string", + "example" : "description of closing reason" + }, + "accept" : { + "maxLength" : 1000, + "minLength" : 0, + "type" : "string", + "example" : "description of accepting reason" + }, + "decline" : { + "maxLength" : 1000, + "minLength" : 0, + "type" : "string", + "example" : "description of declining reason" } } }, - "CreateNotificationContractRequest": { - "required": [ + "CreateNotificationContractRequest" : { + "required" : [ "notificationMethod", "notificationType" ], - "type": "object", - "properties": { - "notificationType": { - "type": "string", - "enum": [ + "type" : "object", + "properties" : { + "notificationType" : { + "type" : "string", + "enum" : [ "QUALITY_INVESTIGATION", "QUALITY_ALERT" ] }, - "notificationMethod": { - "type": "string", - "enum": [ + "notificationMethod" : { + "type" : "string", + "enum" : [ "RECEIVE", "UPDATE", "RESOLVE" @@ -7669,284 +7692,284 @@ } } }, - "CreateNotificationContractResponse": { - "type": "object", - "properties": { - "notificationAssetId": { - "type": "string", - "example": "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" + "CreateNotificationContractResponse" : { + "type" : "object", + "properties" : { + "notificationAssetId" : { + "type" : "string", + "example" : "urn:uuid:ceb6b964-5779-49c1-b5e9-0ee70528fcbd" }, - "accessPolicyId": { - "type": "string", - "example": "123" + "accessPolicyId" : { + "type" : "string", + "example" : "123" }, - "contractDefinitionId": { - "type": "string", - "example": "456" + "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\\\"}" + "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 + "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": [ + "RegisterAssetRequest" : { + "required" : [ "assetIds", "policyId" ], - "type": "object", - "properties": { - "policyId": { - "type": "string", - "example": "a644a7cb-3de5-493b-9259-f01db315a46e" + "type" : "object", + "properties" : { + "policyId" : { + "type" : "string", + "example" : "a644a7cb-3de5-493b-9259-f01db315a46e" }, - "assetIds": { - "type": "array", - "items": { - "type": "string" + "assetIds" : { + "type" : "array", + "items" : { + "type" : "string" } } } }, - "SyncAssetsRequest": { - "type": "object", - "properties": { - "globalAssetIds": { - "maxItems": 100, - "minItems": 1, - "type": "array", - "example": [ + "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\"]" + "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": [ + "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\"]" + "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" + "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" + "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" + "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": [ + "DetailAspectDataResponse" : { + "type" : "object", + "oneOf" : [ { - "$ref": "#/components/schemas/DetailAspectDataAsBuiltResponse" + "$ref" : "#/components/schemas/DetailAspectDataAsBuiltResponse" }, { - "$ref": "#/components/schemas/DetailAspectDataAsPlannedResponse" + "$ref" : "#/components/schemas/DetailAspectDataAsPlannedResponse" }, { - "$ref": "#/components/schemas/PartSiteInformationAsPlannedResponse" + "$ref" : "#/components/schemas/PartSiteInformationAsPlannedResponse" }, { - "$ref": "#/components/schemas/DetailAspectDataTractionBatteryCodeResponse" + "$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" + "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" + "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": [ + "DetailAspectModelResponse" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "example" : "PART_SITE_INFORMATION_AS_PLANNED", + "enum" : [ "AS_BUILT", "AS_PLANNED", "TRACTION_BATTERY_CODE", @@ -7956,49 +7979,49 @@ "PART_SITE_INFORMATION_AS_PLANNED" ] }, - "data": { - "$ref": "#/components/schemas/DetailAspectDataResponse" + "data" : { + "$ref" : "#/components/schemas/DetailAspectDataResponse" } } }, - "PartSiteInformationAsPlannedResponse": { - "type": "object", - "properties": { - "functionValidUntil": { - "type": "string", - "example": "2025-02-08T04:30:48.000Z" + "PartSiteInformationAsPlannedResponse" : { + "type" : "object", + "properties" : { + "functionValidUntil" : { + "type" : "string", + "example" : "2025-02-08T04:30:48.000Z" }, - "function": { - "type": "string", - "example": "production" + "function" : { + "type" : "string", + "example" : "production" }, - "functionValidFrom": { - "type": "string", - "example": "2023-10-13T14:30:45+01:00" + "functionValidFrom" : { + "type" : "string", + "example" : "2023-10-13T14:30:45+01:00" }, - "catenaXSiteId": { - "type": "string", - "example": "urn:uuid:0fed587c-7ab4-4597-9841-1718e9693003" + "catenaXSiteId" : { + "type" : "string", + "example" : "urn:uuid:0fed587c-7ab4-4597-9841-1718e9693003" } } }, - "AlertResponse": { - "type": "object", - "properties": { - "id": { - "maximum": 255, - "minimum": 0, - "maxLength": 255, - "type": "integer", - "format": "int64", - "example": 66 - }, - "status": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "CREATED", - "enum": [ + "AlertResponse" : { + "type" : "object", + "properties" : { + "id" : { + "maximum" : 255, + "minimum" : 0, + "maxLength" : 255, + "type" : "integer", + "format" : "int64", + "example" : 66 + }, + "status" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "CREATED", + "enum" : [ "CREATED", "SENT", "RECEIVED", @@ -8009,111 +8032,111 @@ "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" - }, - "assetIds": { - "maxItems": 1000, - "minItems": 0, - "type": "array", - "example": [ + "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" + }, + "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\"]" + "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": [ + "channel" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "SENDER", + "enum" : [ "SENDER", "RECEIVER" ] }, - "reason": { - "$ref": "#/components/schemas/QualityNotificationReasonResponse" - }, - "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": [ + "reason" : { + "$ref" : "#/components/schemas/QualityNotificationReasonResponse" + }, + "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" ] }, - "targetDate": { - "maxLength": 50, - "minLength": 0, - "type": "string", - "example": "2099-02-21T21:27:10.734950Z" + "targetDate" : { + "maxLength" : 50, + "minLength" : 0, + "type" : "string", + "example" : "2099-02-21T21:27:10.734950Z" }, - "errorMessage": { - "maxLength": 255, - "minLength": 0, - "type": "string", - "example": "EDC not reachable" + "errorMessage" : { + "maxLength" : 255, + "minLength" : 0, + "type" : "string", + "example" : "EDC not reachable" }, - "qualityNotificationMessageResponseList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QualityNotificationMessageResponse" + "qualityNotificationMessageResponseList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/QualityNotificationMessageResponse" } } } }, - "UpdateAssetRequest": { - "required": [ + "UpdateAssetRequest" : { + "required" : [ "qualityType" ], - "type": "object", - "properties": { - "qualityType": { - "type": "string", - "example": "Ok", - "enum": [ + "type" : "object", + "properties" : { + "qualityType" : { + "type" : "string", + "example" : "Ok", + "enum" : [ "Ok", "Minor", "Major", @@ -8123,16 +8146,16 @@ } } }, - "ConstraintResponse": { - "type": "object", - "properties": { - "leftOperand": { - "type": "string", - "example": "PURPOSE" - }, - "operatorTypeResponse": { - "type": "string", - "enum": [ + "ConstraintResponse" : { + "type" : "object", + "properties" : { + "leftOperand" : { + "type" : "string", + "example" : "PURPOSE" + }, + "operatorTypeResponse" : { + "type" : "string", + "enum" : [ "EQ", "NEQ", "LT", @@ -8148,201 +8171,201 @@ "ISNONEOF" ] }, - "rightOperand": { - "type": "string", - "example": "ID Trace 3.1" + "rightOperand" : { + "type" : "string", + "example" : "ID Trace 3.1" } } }, - "ConstraintsResponse": { - "type": "object", - "properties": { - "and": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConstraintResponse" + "ConstraintsResponse" : { + "type" : "object", + "properties" : { + "and" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ConstraintResponse" } }, - "or": { - "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": [ + "PermissionResponse" : { + "type" : "object", + "properties" : { + "action" : { + "type" : "string", + "example" : "USE", + "enum" : [ "ACCESS", "USE" ] }, - "constraints": { - "$ref": "#/components/schemas/ConstraintsResponse" + "constraints" : { + "$ref" : "#/components/schemas/ConstraintsResponse" } } }, - "PolicyResponse": { - "type": "object", - "properties": { - "policyId": { - "type": "string", - "example": "5a00bb50-0253-405f-b9f1-1a3150b9d51d" + "PolicyResponse" : { + "type" : "object", + "properties" : { + "policyId" : { + "type" : "string", + "example" : "5a00bb50-0253-405f-b9f1-1a3150b9d51d" }, - "createdOn": { - "type": "string", - "format": "date-time" + "createdOn" : { + "type" : "string", + "format" : "date-time" }, - "validUntil": { - "type": "string", - "format": "date-time" + "validUntil" : { + "type" : "string", + "format" : "date-time" }, - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PermissionResponse" + "permissions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PermissionResponse" } } } }, - "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 + "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": [ + "ImportJobResponse" : { + "type" : "object", + "properties" : { + "importJobStatus" : { + "type" : "string", + "enum" : [ "INITIALIZING", "RUNNING", "ERROR", "COMPLETED" ] }, - "importId": { - "type": "string", - "example": "456a952e-05eb-40dc-a6f2-9c2cb9c1387f" + "importId" : { + "type" : "string", + "example" : "456a952e-05eb-40dc-a6f2-9c2cb9c1387f" }, - "startedOn": { - "maxLength": 50, - "type": "string", - "example": "2099-02-21T21:27:10.734950Z" + "startedOn" : { + "maxLength" : 50, + "type" : "string", + "example" : "2099-02-21T21:27:10.734950Z" }, - "completedOn": { - "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" + "ImportReportResponse" : { + "type" : "object", + "properties" : { + "importJob" : { + "$ref" : "#/components/schemas/ImportJobResponse" }, - "importedAsset": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportedAssetResponse" + "importedAsset" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ImportedAssetResponse" } } } }, - "ImportedAssetResponse": { - "type": "object", - "properties": { - "importState": { - "type": "string", - "enum": [ + "ImportedAssetResponse" : { + "type" : "object", + "properties" : { + "importState" : { + "type" : "string", + "enum" : [ "TRANSIENT", "PERSISTENT", "ERROR", @@ -8350,30 +8373,30 @@ "UNSET" ] }, - "catenaxId": { - "type": "string", - "example": "urn:uuid:7eeeac86-7b69-444d-81e6-655d0f1513bd}" + "catenaxId" : { + "type" : "string", + "example" : "urn:uuid:7eeeac86-7b69-444d-81e6-655d0f1513bd}" }, - "importedOn": { - "maxLength": 50, - "type": "string", - "example": "2099-02-21T21:27:10.734950Z" + "importedOn" : { + "maxLength" : 50, + "type" : "string", + "example" : "2099-02-21T21:27:10.734950Z" }, - "importMessage": { - "type": "string", - "example": "Asset created successfully in transient state." + "importMessage" : { + "type" : "string", + "example" : "Asset created successfully in transient state." } } } }, - "securitySchemes": { - "oAuth2": { - "type": "oauth2", - "flows": { - "clientCredentials": { - "tokenUrl": "localhost", - "scopes": { - "profile email": "" + "securitySchemes" : { + "oAuth2" : { + "type" : "oauth2", + "flows" : { + "clientCredentials" : { + "tokenUrl" : "localhost", + "scopes" : { + "profile email" : "" } } } diff --git a/tx-backend/src/main/java/org/eclipse/tractusx/traceability/contracts/application/rest/ContractController.java b/tx-backend/src/main/java/org/eclipse/tractusx/traceability/contracts/application/rest/ContractController.java index 5f766b836f..a26e642d3c 100644 --- a/tx-backend/src/main/java/org/eclipse/tractusx/traceability/contracts/application/rest/ContractController.java +++ b/tx-backend/src/main/java/org/eclipse/tractusx/traceability/contracts/application/rest/ContractController.java @@ -18,7 +18,6 @@ ********************************************************************************/ package org.eclipse.tractusx.traceability.contracts.application.rest; -import assets.importpoc.ErrorResponse; import contract.response.ContractResponse; import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.media.Content; @@ -50,7 +49,7 @@ public class ContractController { @Operation(operationId = "contracts", summary = "All contract agreements for all assets", - tags = {"Contracts"}, + tags = {"getContracts"}, description = "This endpoint returns all contract agreements for alls assets in Trace-X", security = @SecurityRequirement(name = "oAuth2", scopes = "profile email")) @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Ok."), @@ -58,45 +57,37 @@ public class ContractController { responseCode = "400", description = "Bad request.", content = @Content( - mediaType = "application/json", - schema = @Schema(implementation = ErrorResponse.class, example = "Bad request."))), + mediaType = "application/json", schema = @Schema(example = "{\"message\": \"Bad request.\"}"))), @ApiResponse( responseCode = "401", description = "Authorization failed.", content = @Content( - mediaType = "application/json", - schema = @Schema(implementation = ErrorResponse.class, example = "Authorization failed."))), + mediaType = "application/json", schema = @Schema(example = "{\"message\": \"Authorization failed.\"}"))), @ApiResponse( responseCode = "403", description = "Forbidden.", content = @Content( - mediaType = "application/json", - schema = @Schema(implementation = ErrorResponse.class, example = "Forbidden."))), + mediaType = "application/json", schema = @Schema(example = "{\"message\": \"Forbidden.\"}"))), @ApiResponse( responseCode = "404", description = "Not found.", content = @Content( - mediaType = "application/json", - schema = @Schema(implementation = ErrorResponse.class, example = "Not found."))), + mediaType = "application/json", schema = @Schema(example = "{\"message\": \"Not found.\"}"))), @ApiResponse( - responseCode = "415", - description = "Unsupported media type.", + responseCode = "415", description = "Unsupported media type.", content = @Content( - mediaType = "application/json", - schema = @Schema(implementation = ErrorResponse.class, example = "Unsupported media type."))), + mediaType = "application/json", schema = @Schema(example = "{\"message\": \"Unsupported media type.\"}"))), @ApiResponse( responseCode = "429", description = "Too many requests.", content = @Content( - mediaType = "application/json", - schema = @Schema(implementation = ErrorResponse.class, example = "Too many requests."))), + mediaType = "application/json", schema = @Schema(example = "{\"message\": \"Too many requests.\"}"))), @ApiResponse( responseCode = "500", description = "Internal server error.", content = @Content( - mediaType = "application/json", - schema = @Schema(implementation = ErrorResponse.class, example = "Internal server error.")))}) + mediaType = "application/json", schema = @Schema(example = "{\"message\": \"Internal server error.\"}")))}) @PostMapping public PageResult getContracts(@Valid @RequestBody PageableFilterRequest pageableFilterRequest) { PageResult contracts = contractService.getContracts(pageableFilterRequest); diff --git a/tx-models/src/main/java/assets/importpoc/ErrorResponse.java b/tx-models/src/main/java/assets/importpoc/ErrorResponse.java index 246fef480a..e805a2779a 100644 --- a/tx-models/src/main/java/assets/importpoc/ErrorResponse.java +++ b/tx-models/src/main/java/assets/importpoc/ErrorResponse.java @@ -19,10 +19,12 @@ package assets.importpoc; +import io.swagger.v3.oas.annotations.media.Schema; import jakarta.validation.constraints.Pattern; import jakarta.validation.constraints.Size; public record ErrorResponse( + @Schema(example = "Access Denied") @Size(max = 1000) @Pattern(regexp = "^.*$", message = "Invalid message pattern") String message