{ "openapi": "3.0.1", "info": { "title": "IDP Integration API", "description": "API provided on the IDP Integration Gateway covers a few usage scenarios:\n\n### Scenario 1: Masterdata & validation\n\nTo upload masterdata files, or validate their content, use corresponding method from the *idp-masterdata* group.\n\n**Note**: Masterdata upload is a 2 step process. Successful response from any upload API call should be interpreted as a valid request to a masterdata upload. Actual lookup storage import is done asynchronously.\n\n### Scenario 2: Process document – get result using polling method\n\nPrerequisite for this process is to have a published preset with which we want to process the document.\n\n1. To start document processing use one of methods from the *idp-import* group, depending on the input document type (pdf, png, tiff, jpeg)\n\n In a response to any of these methods, if document upload is successful, system will respond with process UUID assigned to uploaded document. Subsequently, obtained UUID can be used as an input parameter in the next step.\n\n2. Get-status from the *idp-process* group\n\n Provides document processing status. Get-status method returns a JSON payload with the status and last activity timestamp. Possible statuses are available in the method description.\nBoth EXPORTED and REJECTED status are final statues and once process reaches one of those two states, no more processing is performed.\nIf a process ended up in the EXPORTED state, processing result is available and one can proceed with the next step.\n\n3. Get-xml-result from the *idp-process* group can be used to download XML file with the results of processing.\n\n To fetch the resulting XML, the client needs to provide IDP process UUID.\nIn this scenario it is expected of client to store process UUID within its own datastore and use it to periodically check processing status. (polling get-status method)\n\n### Scenario 3: Process document – get result using push method\n\nThis scenario omits Get-status method and relies on the status push functionality to notify client system that processing has completed. Push functionality is configured on a pipeline level and can be combined with the pull method as well.\nThis scenario begins with one of upload methods and, after the processing is completed, IDP will send status push notification. At this point the client can use Get-xml-result method to download resulting XML.\n\n\n### Scenario 4: Process document – use IDP as a solution state store\n\nScenario 2, and to some extent Scenario 3, require management of the overall document processing state (was it processed by IDP and subsequently the result was downloaded).\nIn the Scenario 4, IDP keeps information about downstream processing status (result processed status) communicated to the system through the *acknowledge-result-processed* endpoint.\nStandard workflow in this scenario has the following steps:\n\n1. Start document processing within IDP using one of the existing upload methods, but ignore assigned process UUID. (fire and forget upload)\n2. Upload client is expected to periodically poll get-process-list from the *process-administration-controller* group to fetch a list of documents in an EXPORTED / REJECTED status with result processing not been acknowledged yet.\n3. Process results obtained in 2. are then downloaded using get-xml-result endpoint if the processing status is EXPORTED. If the status is REJECTED there is no artifact for download.\n4. Acknowledge result processing.\n\n***Note 1***: Irrespective of the process result, if a process reaches one of the final states, *get-document-pdf* endpoint from the *idp-process* group can be used for obtaining input document pdf.\n\n***Note 2***: Endpoint *acknowledge-result-processed* from the group *idp-process* must be called upon finishing steps for any of the scenarios 2-4. This call signalizes to the IDP system formal closure of the process and is\nused in IDP internally to appropriately handle such processes.\n", "version": "2.1" }, "servers": [ { "url": "https://integration.idp.de2.retarus.com", "description": "Local" } ], "security": [ { "bearerAuth": [] } ], "paths": { "/get-xml-result/{processUuid}": { "get": { "tags": [ "idp-process" ], "summary": "Get the resulting XML document", "operationId": "getXmlResult", "parameters": [ { "name": "processUuid", "in": "path", "required": true, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } }, "/get-document-pdf/{processUuid}": { "get": { "tags": [ "idp-process" ], "summary": "Get PDF document assembled from input document pages", "operationId": "getDocumentPdfFromPageImages", "parameters": [ { "name": "processUuid", "in": "path", "required": true, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "format": "byte", "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } }, "/get-original-document/{processUuid}": { "get": { "tags": [ "idp-process" ], "summary": "Get original document uploaded to ingestion", "operationId": "getOriginalDocument", "parameters": [ { "name": "processUuid", "in": "path", "required": true, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "format": "byte", "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } }, "/get-status": { "get": { "tags": [ "idp-process" ], "summary": "Get a very short info for a single process instance", "operationId": "getProcessStatus", "parameters": [ { "name": "processId", "in": "query", "required": true, "style": "FORM", "explode": true, "schema": { "exampleSetFlag": false, "types": [ "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ProcessStatusCompactResponse", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } }, "/get-process-list": { "get": { "tags": [ "idp-process" ], "summary": "Get a list of processes", "operationId": "getProcessList", "parameters": [ { "name": "range-from", "in": "query", "required": true, "style": "FORM", "explode": true, "schema": { "format": "date-time", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "range-to", "in": "query", "required": true, "style": "FORM", "explode": true, "schema": { "format": "date-time", "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "range-type", "in": "query", "required": true, "style": "FORM", "explode": true, "schema": { "exampleSetFlag": false, "types": [ "string" ], "enum": [ "INGESTION", "PROCESS_FINISHED", "LAST_ACTIVITY" ] } }, { "name": "page-size", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "maximum": 100, "minimum": 0, "format": "int64", "exampleSetFlag": false, "types": [ "integer" ], "default": 100 } }, { "name": "page-no", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "minimum": 0, "format": "int64", "exampleSetFlag": false, "types": [ "integer" ], "default": 0 } }, { "name": "ai-pipeline-code", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "process-status", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "exampleSetFlag": false, "items": { "exampleSetFlag": false, "types": [ "string" ], "enum": [ "RECEIVED", "PROCESSING", "VALIDATION", "HITL_QUEUE", "HITL_PROCESSING", "EXPORTED", "REJECTED", "PARKED" ] }, "types": [ "array" ], "default": [] } }, { "name": "download-ack", "in": "query", "required": false, "deprecated": true, "style": "FORM", "explode": true, "schema": { "exampleSetFlag": false, "types": [ "boolean" ] } }, { "name": "result-processed-ack", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "exampleSetFlag": false, "types": [ "boolean" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ProcessListResponse", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } }, "/acknowledge-result-processed": { "post": { "tags": [ "idp-process" ], "summary": "Acknowledge result processed", "operationId": "acknowledgeResultProcessed", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeResultProcessedRequest", "exampleSetFlag": false }, "exampleSetFlag": false } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } }, "/acknowledge-result-download": { "post": { "tags": [ "idp-process" ], "summary": "Update download acknowledge count", "operationId": "updateDownloadAcknowledgeCount", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeResultDownloadRequest", "exampleSetFlag": false }, "exampleSetFlag": false } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } }, "deprecated": true } }, "/upload-pdf": { "post": { "tags": [ "idp-import" ], "summary": "Upload new document to processing", "description": " All request headers beginning with **x-idp-ingestion-** will be collected into an exogenous metadata map.\n Content of this map is included in the final process result.\n Example:\n - x-idp-ingestion-user: \"John\"\n - x-idp-ingestion-request-id: \"12345\"\n", "operationId": "processUploadPdf", "parameters": [ { "name": "x-idp-ingestion-*", "in": "header", "description": "Any header starting with `x-idp-ingestion-` is accepted. Values are aggregated into a map.", "required": false, "style": "SIMPLE", "explode": false }, { "name": "channel-reference", "in": "header", "required": true, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "channel-name", "in": "header", "required": true, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "customer-billing-code", "in": "header", "required": false, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "comparisonId", "in": "header", "required": false, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "ai-pipeline-code", "in": "header", "required": false, "deprecated": true, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "ai-preset-code", "in": "header", "required": false, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonIngressResponseModel", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "412": { "description": "Precondition Failed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } }, "/upload-jpeg": { "post": { "tags": [ "idp-import" ], "summary": "Upload new document to processing", "description": " All request headers beginning with **x-idp-ingestion-** will be collected into an exogenous metadata map.\n Content of this map is included in the final process result.\n Example:\n - x-idp-ingestion-user: \"John\"\n - x-idp-ingestion-request-id: \"12345\"\n", "operationId": "processUploadPdf", "parameters": [ { "name": "x-idp-ingestion-*", "in": "header", "description": "Any header starting with `x-idp-ingestion-` is accepted. Values are aggregated into a map.", "required": false, "style": "SIMPLE", "explode": false }, { "name": "channel-reference", "in": "header", "required": true, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "channel-name", "in": "header", "required": true, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "customer-billing-code", "in": "header", "required": false, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "comparisonId", "in": "header", "required": false, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "ai-pipeline-code", "in": "header", "required": false, "deprecated": true, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "ai-preset-code", "in": "header", "required": false, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonIngressResponseModel", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "412": { "description": "Precondition Failed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } }, "/upload-png": { "post": { "tags": [ "idp-import" ], "summary": "Upload new document to processing", "description": " All request headers beginning with **x-idp-ingestion-** will be collected into an exogenous metadata map.\n Content of this map is included in the final process result.\n Example:\n - x-idp-ingestion-user: \"John\"\n - x-idp-ingestion-request-id: \"12345\"\n", "operationId": "processUploadPdf", "parameters": [ { "name": "x-idp-ingestion-*", "in": "header", "description": "Any header starting with `x-idp-ingestion-` is accepted. Values are aggregated into a map.", "required": false, "style": "SIMPLE", "explode": false }, { "name": "channel-reference", "in": "header", "required": true, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "channel-name", "in": "header", "required": true, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "customer-billing-code", "in": "header", "required": false, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "comparisonId", "in": "header", "required": false, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "ai-pipeline-code", "in": "header", "required": false, "deprecated": true, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "ai-preset-code", "in": "header", "required": false, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonIngressResponseModel", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "412": { "description": "Precondition Failed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } }, "/upload-tiff": { "post": { "tags": [ "idp-import" ], "summary": "Upload new document to processing", "description": " All request headers beginning with **x-idp-ingestion-** will be collected into an exogenous metadata map.\n Content of this map is included in the final process result.\n Example:\n - x-idp-ingestion-user: \"John\"\n - x-idp-ingestion-request-id: \"12345\"\n", "operationId": "processUploadPdf", "parameters": [ { "name": "x-idp-ingestion-*", "in": "header", "description": "Any header starting with `x-idp-ingestion-` is accepted. Values are aggregated into a map.", "required": false, "style": "SIMPLE", "explode": false }, { "name": "channel-reference", "in": "header", "required": true, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "channel-name", "in": "header", "required": true, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "customer-billing-code", "in": "header", "required": false, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "comparisonId", "in": "header", "required": false, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "ai-pipeline-code", "in": "header", "required": false, "deprecated": true, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } }, { "name": "ai-preset-code", "in": "header", "required": false, "style": "SIMPLE", "explode": false, "schema": { "exampleSetFlag": false, "types": [ "string" ] } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonIngressResponseModel", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "412": { "description": "Precondition Failed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } }, "/import/open-order/csv": { "post": { "tags": [ "idp-masterdata" ], "summary": "Import open order CSV", "operationId": "importOpenOrderCsv", "parameters": [ { "name": "containerCode", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "exampleSetFlag": false, "types": [ "string" ], "default": "DEFAULT" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ImportApiResponse", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/BadRequestProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/InternalErrorProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } } } } }, "/validate/open-order/csv": { "post": { "tags": [ "idp-masterdata" ], "summary": "Validate open order CSV", "operationId": "validateOpenOrderCsv", "parameters": [], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidationApiResponse", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } }, "/import/supplier/csv": { "post": { "tags": [ "idp-masterdata" ], "summary": "Import supplier CSV", "operationId": "importSupplierCsv", "parameters": [ { "name": "containerCode", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "exampleSetFlag": false, "types": [ "string" ], "default": "DEFAULT" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } }, "required": true }, "responses": { "200": { "description": "Successfully imported", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ImportApiResponse", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/BadRequestProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unable to import file due to validation errors", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/InternalErrorProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } } } } }, "/validate/supplier/csv": { "post": { "tags": [ "idp-masterdata" ], "summary": "Validate supplier CSV", "operationId": "validateSupplierCsv", "parameters": [], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidationApiResponse", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } }, "/import/customer-material/csv": { "post": { "tags": [ "idp-masterdata" ], "summary": "Import customer material CSV", "operationId": "importCustomerMaterialCsv", "parameters": [ { "name": "containerCode", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "exampleSetFlag": false, "types": [ "string" ], "default": "DEFAULT" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ImportApiResponse", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/BadRequestProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/InternalErrorProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } } } } }, "/validate/customer-material/csv": { "post": { "tags": [ "idp-masterdata" ], "summary": "Validate customer material CSV", "operationId": "validateCustomerMaterialCsv", "parameters": [], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidationApiResponse", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } }, "/import/customer-master/csv": { "post": { "tags": [ "idp-masterdata" ], "summary": "Import customer master CSV", "operationId": "importCustomerMasterCsv", "parameters": [ { "name": "containerCode", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "exampleSetFlag": false, "types": [ "string" ], "default": "DEFAULT" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ImportApiResponse", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/BadRequestProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/InternalErrorProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } } } } }, "/validate/customer-master/csv": { "post": { "tags": [ "idp-masterdata" ], "summary": "Validate customer master CSV", "operationId": "validateCustomerMasterCsv", "parameters": [], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidationApiResponse", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } }, "/import/customer-product/csv": { "post": { "tags": [ "idp-masterdata" ], "summary": "Import customer product CSV", "operationId": "importCustomerProductCsv", "parameters": [ { "name": "containerCode", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "exampleSetFlag": false, "types": [ "string" ], "default": "DEFAULT" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ImportApiResponse", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/BadRequestProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/InternalErrorProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } } } } }, "/validate/customer-product/csv": { "post": { "tags": [ "idp-masterdata" ], "summary": "Validate customer product CSV", "operationId": "validateCustomerProductCsv", "parameters": [], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidationApiResponse", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } }, "/import/customer-ship-to/csv": { "post": { "tags": [ "idp-masterdata" ], "summary": "Import customer ship to CSV", "operationId": "importCustomerShipToCsv", "parameters": [ { "name": "containerCode", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "exampleSetFlag": false, "types": [ "string" ], "default": "DEFAULT" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ImportApiResponse", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/BadRequestProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/InternalErrorProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } } } } }, "/validate/customer-ship-to/csv": { "post": { "tags": [ "idp-masterdata" ], "summary": "Validate customer ship to CSV", "operationId": "validateCustomerShipToCsv", "parameters": [], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidationApiResponse", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } }, "/import/keyword/csv": { "post": { "tags": [ "idp-masterdata" ], "summary": "Submit keyword CSV", "operationId": "importKeywordCsv", "parameters": [ { "name": "containerCode", "in": "query", "required": false, "style": "FORM", "explode": true, "schema": { "exampleSetFlag": false, "types": [ "string" ], "default": "DEFAULT" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ImportApiResponse", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/BadRequestProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/InternalErrorProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } } } } }, "/validate/keyword/csv": { "post": { "tags": [ "idp-masterdata" ], "summary": "Validate keyword CSV", "operationId": "validateKeywordCsv", "parameters": [], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "format": "binary", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "exampleSetFlag": false } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidationApiResponse", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetail", "exampleSetFlag": false }, "exampleSetFlag": false } } }, "422": { "description": "Unprocessable Content", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false } } } } } } }, "components": { "schemas": { "ProblemDetail": { "properties": { "type": { "format": "uri", "exampleSetFlag": false, "types": [ "string" ] }, "title": { "exampleSetFlag": false, "types": [ "string" ] }, "status": { "format": "int32", "exampleSetFlag": false, "types": [ "integer" ] }, "detail": { "exampleSetFlag": false, "types": [ "string" ] }, "instance": { "format": "uri", "exampleSetFlag": false, "types": [ "string" ] }, "properties": { "additionalProperties": { "exampleSetFlag": false }, "exampleSetFlag": false, "types": [ "object" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "CommonIngressResponseModel": { "properties": { "processId": { "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "MarkForReviewRequest": { "required": [ "note", "processId" ], "properties": { "processId": { "minLength": 1, "exampleSetFlag": false, "types": [ "string" ] }, "note": { "maxLength": 300, "minLength": 40, "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "AcknowledgeResultProcessedRequest": { "required": [ "processId" ], "properties": { "processId": { "minLength": 1, "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "AcknowledgeResultDownloadRequest": { "required": [ "processId" ], "properties": { "processId": { "minLength": 1, "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "DebugPackageResponse": { "properties": { "uuid": { "exampleSetFlag": false, "types": [ "string" ] }, "message": { "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "ProcessStatusCompactResponse": { "properties": { "processId": { "exampleSetFlag": false, "types": [ "string" ] }, "processStep": { "exampleSetFlag": false, "types": [ "string" ], "enum": [ "RECEIVED", "PROCESSING", "PARKED", "VALIDATION", "HITL_QUEUE", "HITL_PROCESSING", "EXPORTED", "REJECTED" ] }, "latestActivity": { "format": "date-time", "exampleSetFlag": false, "types": [ "string" ] }, "note": { "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "AdvancedSearchMatchInfo": { "properties": { "matchKey": { "exampleSetFlag": false, "types": [ "string" ] }, "matchHighlight": { "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "PipelineInfo": { "properties": { "code": { "exampleSetFlag": false, "types": [ "string" ] }, "name": { "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "ProcessQueryResponse": { "properties": { "processList": { "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/ProcessStatus", "exampleSetFlag": false }, "types": [ "array" ] }, "page": { "$ref": "#/components/schemas/ResultPageInfo", "exampleSetFlag": false }, "responseTimestamp": { "format": "date-time", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "ProcessStatus": { "properties": { "name": { "exampleSetFlag": false, "types": [ "string" ] }, "preset": { "$ref": "#/components/schemas/PipelineInfo", "exampleSetFlag": false }, "processId": { "exampleSetFlag": false, "types": [ "string" ] }, "receivedOn": { "format": "date-time", "exampleSetFlag": false, "types": [ "string" ] }, "processStep": { "exampleSetFlag": false, "types": [ "string" ], "enum": [ "RECEIVED", "PROCESSING", "PARKED", "VALIDATION", "HITL_QUEUE", "HITL_PROCESSING", "EXPORTED", "REJECTED" ] }, "hitlLoops": { "format": "int32", "exampleSetFlag": false, "types": [ "integer" ] }, "latestActivity": { "format": "date-time", "exampleSetFlag": false, "types": [ "string" ] }, "hasDocumentPreview": { "exampleSetFlag": false, "types": [ "boolean" ] }, "hasDownloadExport": { "exampleSetFlag": false, "types": [ "boolean" ] }, "hasReview": { "exampleSetFlag": false, "types": [ "boolean" ] }, "documentPreviewPages": { "format": "int32", "exampleSetFlag": false, "types": [ "integer" ] }, "processingUser": { "$ref": "#/components/schemas/UserInfo", "exampleSetFlag": false }, "archivingStatus": { "exampleSetFlag": false, "types": [ "string" ], "enum": [ "ALIVE", "ARCHIVED", "PURGED" ] }, "archivingTime": { "format": "date-time", "exampleSetFlag": false, "types": [ "string" ] }, "note": { "exampleSetFlag": false, "types": [ "string" ] }, "advancedSearchMatchInfos": { "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/AdvancedSearchMatchInfo", "exampleSetFlag": false }, "types": [ "array" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "ResultPageInfo": { "properties": { "pageNumber": { "format": "int32", "exampleSetFlag": false, "types": [ "integer" ] }, "numberOfPages": { "format": "int32", "exampleSetFlag": false, "types": [ "integer" ] }, "pageSize": { "format": "int32", "exampleSetFlag": false, "types": [ "integer" ] }, "totalCount": { "format": "int32", "exampleSetFlag": false, "types": [ "integer" ] }, "maxTotalCount": { "format": "int32", "exampleSetFlag": false, "types": [ "integer" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "UserInfo": { "properties": { "id": { "exampleSetFlag": false, "types": [ "string" ] }, "username": { "exampleSetFlag": false, "types": [ "string" ] }, "firstName": { "exampleSetFlag": false, "types": [ "string" ] }, "lastName": { "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "CorrectionsData": { "properties": { "name": { "exampleSetFlag": false, "types": [ "string" ] }, "inferenceModelCode": { "exampleSetFlag": false, "types": [ "string" ] }, "inferenceModelName": { "exampleSetFlag": false, "types": [ "string" ] }, "total": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "corrected": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "percentage": { "exampleSetFlag": false, "types": [ "number" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "LevelOfAutomationData": { "properties": { "date": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "automated": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "hitlValidated": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "hitlRatio": { "exampleSetFlag": false, "types": [ "number" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "ProcessReportAutomationResponse": { "properties": { "dataPerField": { "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/LevelOfAutomationData", "exampleSetFlag": false }, "types": [ "array" ] }, "dataPerDocument": { "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/LevelOfAutomationData", "exampleSetFlag": false }, "types": [ "array" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "ProcessReportCorrectionsResponse": { "properties": { "data": { "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/CorrectionsData", "exampleSetFlag": false }, "types": [ "array" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "ProcessReportResponse": { "properties": { "responseTimestamp": { "format": "date-time", "exampleSetFlag": false, "types": [ "string" ] }, "summary": { "$ref": "#/components/schemas/ProcessReportSummaryResponse", "exampleSetFlag": false }, "usage": { "$ref": "#/components/schemas/ProcessReportUsageResponse", "exampleSetFlag": false }, "levelOfAutomation": { "$ref": "#/components/schemas/ProcessReportAutomationResponse", "exampleSetFlag": false }, "correctionsPerField": { "$ref": "#/components/schemas/ProcessReportCorrectionsResponse", "exampleSetFlag": false }, "timePerDocument": { "$ref": "#/components/schemas/ProcessReportTimePerDocumentResponse", "exampleSetFlag": false } }, "exampleSetFlag": false, "types": [ "object" ] }, "ProcessReportSummaryResponse": { "properties": { "exported": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "levelOfAutomationPerField": { "exampleSetFlag": false, "types": [ "number" ] }, "automatedPerField": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "hitlValidatedPerField": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "averageDurationPerPage": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "averageDurationPerDocument": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "averageValidationDurationPerPage": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "averageValidationDurationPerDocument": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "levelOfAutomationPerDocument": { "exampleSetFlag": false, "types": [ "number" ] }, "automatedPerDocument": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "hitlValidatedPerDocument": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "ProcessReportTimePerDocumentResponse": { "properties": { "data": { "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/TimePerDocument", "exampleSetFlag": false }, "types": [ "array" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "ProcessReportUsageResponse": { "properties": { "data": { "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/UsageData", "exampleSetFlag": false }, "types": [ "array" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "TimePerDocument": { "properties": { "date": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "averageDurationPerPage": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "averageDurationPerDocument": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "averageValidationDurationPerPage": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "averageValidationDurationPerDocument": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "UsageData": { "properties": { "date": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "received": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "exported": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "rejected": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "Metadata": { "properties": { "timestamp": { "format": "date-time", "exampleSetFlag": false, "types": [ "string" ] }, "resultCount": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "resultPage": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] }, "resultNumberOfPages": { "format": "int64", "exampleSetFlag": false, "types": [ "integer" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "Process": { "properties": { "processId": { "exampleSetFlag": false, "types": [ "string" ] }, "processStep": { "exampleSetFlag": false, "types": [ "string" ] }, "latestActivity": { "format": "date-time", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "ProcessListResponse": { "properties": { "metadata": { "$ref": "#/components/schemas/Metadata", "exampleSetFlag": false }, "resultList": { "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/Process", "exampleSetFlag": false }, "types": [ "array" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "LookupDebugMetadata": { "properties": { "fieldGroup": { "exampleSetFlag": false, "types": [ "string" ] }, "fieldGroupIndex": { "exampleSetFlag": false, "types": [ "string" ] }, "lookupMetadata": { "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/LookupMetadata", "exampleSetFlag": false }, "types": [ "array" ] }, "resultMetadata": { "$ref": "#/components/schemas/ResultMetadata", "exampleSetFlag": false } }, "exampleSetFlag": false, "types": [ "object" ] }, "LookupMetadata": { "properties": { "source": { "exampleSetFlag": false, "types": [ "string" ] }, "confidence": { "exampleSetFlag": false, "types": [ "integer" ] }, "result": { "additionalProperties": { "exampleSetFlag": false, "types": [ "string" ] }, "exampleSetFlag": false, "types": [ "object" ] }, "additionalData": { "additionalProperties": { "exampleSetFlag": false }, "exampleSetFlag": false, "types": [ "object" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "ProcessInfoResponse": { "properties": { "numberOfPages": { "exampleSetFlag": false, "types": [ "integer" ] }, "lookupMetadata": { "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/LookupDebugMetadata", "exampleSetFlag": false }, "types": [ "array" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "ResultMetadata": { "properties": { "lookupType": { "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "StreamingResponseBody": { "exampleSetFlag": false }, "UnprocessableEntityProblemDetail": { "properties": { "type": { "format": "uri", "exampleSetFlag": false, "types": [ "string" ] }, "title": { "exampleSetFlag": false, "types": [ "string" ] }, "status": { "description": "HTTP status", "format": "int32", "example": 422, "exampleSetFlag": true, "types": [ "integer" ] }, "detail": { "exampleSetFlag": false, "types": [ "string" ] }, "instance": { "format": "uri", "exampleSetFlag": false, "types": [ "string" ] }, "errors": { "description": "Error list", "example": [ "(row: 3, col: 85) > Value of the field (itemEan) is required, but not present", "(row: 10, col: 68) > Value of the field (itemEan) is required, but not present" ], "exampleSetFlag": true, "items": { "exampleSetFlag": false, "types": [ "string" ] }, "types": [ "array" ] }, "warnings": { "description": "Warnings list", "example": [ "(row: 10, col: 69) > Trimmed field (name) to value (some company name...)", "Banana", "Cherry" ], "exampleSetFlag": true, "items": { "exampleSetFlag": false, "types": [ "string" ] }, "types": [ "array" ] } }, "description": "Unprocessable entity problem detail", "exampleSetFlag": false, "types": [ "object" ] }, "BadRequestProblemDetail": { "properties": { "type": { "format": "uri", "exampleSetFlag": false, "types": [ "string" ] }, "title": { "exampleSetFlag": false, "types": [ "string" ] }, "status": { "description": "HTTP status", "format": "int32", "example": 400, "exampleSetFlag": true, "types": [ "integer" ] }, "detail": { "exampleSetFlag": false, "types": [ "string" ] }, "instance": { "format": "uri", "exampleSetFlag": false, "types": [ "string" ] }, "properties": { "additionalProperties": { "exampleSetFlag": false }, "exampleSetFlag": false, "types": [ "object" ] } }, "description": "Bad request", "exampleSetFlag": false, "types": [ "object" ] }, "InternalErrorProblemDetail": { "properties": { "type": { "format": "uri", "exampleSetFlag": false, "types": [ "string" ] }, "title": { "exampleSetFlag": false, "types": [ "string" ] }, "status": { "description": "HTTP status", "format": "int32", "example": 500, "exampleSetFlag": true, "types": [ "integer" ] }, "detail": { "exampleSetFlag": false, "types": [ "string" ] }, "instance": { "format": "uri", "exampleSetFlag": false, "types": [ "string" ] } }, "description": "Internal server error", "exampleSetFlag": false, "types": [ "object" ] }, "ValidationApiResponse": { "properties": { "processId": { "exampleSetFlag": false, "types": [ "string" ] }, "validationApiResponseStatus": { "exampleSetFlag": false, "types": [ "string" ], "enum": [ "SUCCEEDED", "FAILED" ] }, "errors": { "exampleSetFlag": false, "items": { "exampleSetFlag": false, "types": [ "string" ] }, "types": [ "array" ] }, "warnings": { "exampleSetFlag": false, "items": { "exampleSetFlag": false, "types": [ "string" ] }, "types": [ "array" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "ImportApiResponse": { "properties": { "processId": { "exampleSetFlag": false, "types": [ "string" ] }, "warnings": { "exampleSetFlag": false, "items": { "exampleSetFlag": false, "types": [ "string" ] }, "types": [ "array" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "CsvFileHistoryResponse": { "properties": { "uuid": { "exampleSetFlag": false, "types": [ "string" ] }, "fileName": { "exampleSetFlag": false, "types": [ "string" ] }, "uploadProcessUuid": { "exampleSetFlag": false, "types": [ "string" ] }, "filePath": { "exampleSetFlag": false, "types": [ "string" ] }, "customerCode": { "exampleSetFlag": false, "types": [ "string" ] }, "masterdataType": { "exampleSetFlag": false, "types": [ "string" ], "enum": [ "SUPPLIER", "OPEN_ORDER", "CUSTOMER_MATERIAL", "CUSTOMER_MASTER", "CUSTOMER_PRODUCT", "CUSTOMER_SHIP_TO", "KEYWORD" ] }, "containerCode": { "exampleSetFlag": false, "types": [ "string" ] }, "status": { "exampleSetFlag": false, "types": [ "string" ], "enum": [ "AVAILABLE", "PURGED" ] }, "uploadTimestamp": { "format": "date-time", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }