{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula SmartDocs", "description": "SmartDocs API is part of FenX eco-system to manage Intelligent Document Processing All the operations require valid access token obtained from Identity service.", "version": "1.0" }, "servers": [ { "url": "/smartdocs" } ], "paths": { "/api/docsplit/preview/{documentId}": { "get": { "tags": [ "DocSplit" ], "summary": "Retrieves the document split preview by document ID.", "description": "

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch", "parameters": [ { "name": "documentId", "in": "path", "description": "The unique identifier of the document.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Returns the document split preview data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocSplitPreviewDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "If the document split preview is not found.", "type": "Error", "errorCode": "Error Code" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/docsplit/preview": { "post": { "tags": [ "DocSplit" ], "summary": "Updates and completes the document split preview.", "description": "

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The document split preview data transfer object.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocSplitPreviewDto" } ] } } } }, "responses": { "200": { "description": "If the document split preview was successfully updated and completed." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/extraction/entitydata/{entityId}/{journeyInstanceId}/{documentModelId}": { "get": { "tags": [ "Extraction" ], "summary": "Get individual document model entity data extraction", "description": "

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch", "parameters": [ { "name": "journeyInstanceId", "in": "path", "description": "Journey Instance Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "documentModelId", "in": "path", "description": "Document Model Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "entityId", "in": "path", "description": "Entity Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Data Extraction for document returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentEntityDataExtractionServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Extraction not found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/extraction/entitydata/{entityId}/{journeyInstanceId}/grouped": { "get": { "tags": [ "Extraction" ], "summary": "Get list of document model entity data extractions for given journey instance", "description": "

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch", "parameters": [ { "name": "journeyInstanceId", "in": "path", "description": "Journey Instance Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "entityId", "in": "path", "description": "Entity Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Data Extraction for documents returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupedDocumentDataExtractionServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/extraction/entitydata/{entityId}/{journeyInstanceId}": { "get": { "tags": [ "Extraction" ], "summary": "Get list of document model entity data extractions for given journey instance", "description": "

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch", "parameters": [ { "name": "journeyInstanceId", "in": "path", "description": "Journey Instance Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "entityId", "in": "path", "description": "Entity Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Data Extraction for documents returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentEntityDataExtractionIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/extraction/state/{journeyInstanceId}/{taskId}": { "get": { "tags": [ "Extraction" ], "summary": "Get Extraction State for a given journey and task", "description": "

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch", "parameters": [ { "name": "journeyInstanceId", "in": "path", "description": "Journey Instance Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "Task Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Extraction State returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractionStateServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "put": { "tags": [ "Extraction" ], "summary": "Store Extraction State for a given journey and task", "description": "

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch", "parameters": [ { "name": "journeyInstanceId", "in": "path", "description": "Journey Instance Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "Task Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Extraction State", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ExtractionState" } ] } } } }, "responses": { "200": { "description": "Success. Extraction State stored" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/extraction/status/{journeyInstanceId}": { "get": { "tags": [ "Extraction" ], "summary": "Get Extraction Status for a given journey", "description": "

Required permissions:
At least one of the following permissions is required: EntityDataAccessAndSearch", "parameters": [ { "name": "journeyInstanceId", "in": "path", "description": "Journey Instance Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Extraction Status returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractionStatusServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/rag/{resourceId}": { "get": { "tags": [ "Rag" ], "summary": "Retrieves a RAG resource by its unique identifier.", "description": "

Required permissions:
At least one of the following permissions is required: IdpRagAccess", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique identifier of the RAG resource.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRagDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "put": { "tags": [ "Rag" ], "summary": "Updates an existing RAG resource.", "description": "

Required permissions:
At least one of the following permissions is required: IdpRagEdit", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique identifier of the RAG resource to update.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The updated RAG resource.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateRagDto" } ] } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "delete": { "tags": [ "Rag" ], "summary": "Deletes a RAG resource by its unique identifier.", "description": "

Required permissions:
At least one of the following permissions is required: IdpRagDelete", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique identifier of the RAG resource to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/rag": { "get": { "tags": [ "Rag" ], "summary": "Retrieves a paginated list of RAG resources.", "description": "

Required permissions:
At least one of the following permissions is required: IdpRagAccess", "operationId": "GetPageRagResources", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "PaginationToken", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPageRagDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "post": { "tags": [ "Rag" ], "summary": "Creates a new RAG resource.", "description": "

Required permissions:
At least one of the following permissions is required: IdpRagEdit", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "The RAG resource to create.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateRagDto" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRagResponseDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "components": { "schemas": { "AccessLayer": { "type": "object", "properties": { "geographic": { "type": "array", "items": { "type": "string" }, "nullable": true }, "businessRelated": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "BaseRagDto": { "required": [ "data", "name" ], "type": "object", "properties": { "name": { "maxLength": 150, "minLength": 1, "type": "string" }, "description": { "maxLength": 200, "type": "string", "nullable": true }, "processingType": { "type": "string", "nullable": true }, "operationType": { "type": "string", "nullable": true }, "resourceType": { "type": "string", "nullable": true }, "resourceName": { "type": "string", "nullable": true }, "resourceNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "data": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "BaseState": { "type": "object", "properties": { "documentModelId": { "type": "string", "format": "uuid", "nullable": true }, "id": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CollectionState": { "allOf": [ { "$ref": "#/components/schemas/BaseState" }, { "type": "object", "properties": { "overridenValues": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "CompleteExtractionTaskResponseDto": { "type": "object", "properties": { "alreadyInProgress": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/ExtractionCompletionStatusDto" } ], "nullable": true } }, "additionalProperties": false }, "CompleteExtractionTaskResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CompleteExtractionTaskResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateRagDto": { "allOf": [ { "$ref": "#/components/schemas/BaseRagDto" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false } ] }, "CreateRagResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CreateRagResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateRagResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DecisionStatus": { "enum": [ "None", "Accepted", "Overridden", "AcceptedWithChanges", "Rejected", "KeptCurrent", "Flagged" ], "type": "string" }, "DocSplitPreviewDto": { "required": [ "documentModelId", "items" ], "type": "object", "properties": { "documentModelId": { "minLength": 1, "type": "string" }, "items": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/DocSplitPreviewItemDto" } } }, "additionalProperties": false }, "DocSplitPreviewDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocSplitPreviewDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocSplitPreviewItemDto": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "pageFrom": { "minimum": 0, "exclusiveMinimum": true, "type": "integer", "format": "int32" }, "pageTo": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DocumentEntityDataExtraction": { "type": "object", "properties": { "documentModelId": { "type": "string", "nullable": true }, "entityDataExtractions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDataExtraction" }, "nullable": true }, "entityDataCollectionExtractions": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDataCollectionExtraction" }, "nullable": true } }, "additionalProperties": false }, "DocumentEntityDataExtractionIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentEntityDataExtraction" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentEntityDataExtractionServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentEntityDataExtraction" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DocumentSourceDto": { "type": "object", "properties": { "documentModelId": { "type": "string", "nullable": true }, "documentName": { "type": "string", "nullable": true }, "page": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DocumentSourceProcessDto": { "type": "object", "properties": { "documentModelId": { "type": "string", "nullable": true }, "documentName": { "type": "string", "nullable": true }, "page": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DuplicatePropertyDto": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DuplicatePropertyDto" }, "nullable": true } }, "additionalProperties": false }, "DuplicateSearchResultDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "groupId": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "matchType": { "allOf": [ { "$ref": "#/components/schemas/MatchType" } ] }, "matchScore": { "type": "number", "format": "double" }, "legalEntityName": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DuplicatePropertyDto" }, "nullable": true }, "selected": { "type": "boolean" } }, "additionalProperties": false }, "EntityDataBaseExtraction": { "type": "object", "properties": { "dataKey": { "type": "string", "nullable": true }, "explanation": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "documentModelId": { "type": "string", "nullable": true }, "isSensitiveData": { "type": "boolean", "nullable": true }, "fieldAccessLayer": { "allOf": [ { "$ref": "#/components/schemas/AccessLayer" } ], "nullable": true } }, "additionalProperties": false }, "EntityDataCollectionExtraction": { "allOf": [ { "$ref": "#/components/schemas/EntityDataBaseExtraction" }, { "type": "object", "properties": { "dataGroupId": { "type": "string", "nullable": true }, "collections": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDataCollectionExtractionValue" }, "nullable": true } }, "additionalProperties": false } ] }, "EntityDataCollectionExtractionValue": { "type": "object", "properties": { "values": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "explanations": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "pageNumbers": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "nullable": true }, "id": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EntityDataExtraction": { "allOf": [ { "$ref": "#/components/schemas/EntityDataBaseExtraction" }, { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "pageNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false } ] }, "ExtractedRelatedPartyDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "extractedName": { "type": "string", "nullable": true }, "extractedRelationTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ExtractedRelationTypeDto" }, "nullable": true }, "documentSources": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentSourceDto" }, "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyPropertyDto" }, "nullable": true } }, "additionalProperties": false }, "ExtractedRelatedPartyProcessDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "extractedName": { "type": "string", "nullable": true }, "extractedRelationTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ExtractedRelationTypeProcessDto" }, "nullable": true }, "documentSources": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentSourceProcessDto" }, "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyPropertyProcessDto" }, "nullable": true }, "order": { "type": "integer", "format": "int32" }, "isBaseline": { "type": "boolean" } }, "additionalProperties": false }, "ExtractedRelationTypeDto": { "type": "object", "properties": { "targetId": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExtractedRelationTypeProcessDto": { "type": "object", "properties": { "targetId": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExtractedStatus": { "enum": [ "New", "Discrepancy", "Match" ], "type": "string" }, "ExtractionCompletionStatusDto": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "startedAt": { "type": "string", "nullable": true }, "startedBy": { "type": "string", "nullable": true }, "completedAt": { "type": "string", "nullable": true }, "errors": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ExtractionCompletionStatusDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExtractionCompletionStatusDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ExtractionReviewCategory": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/ExtractionReviewField" }, "nullable": true }, "dataGroups": { "type": "array", "items": { "$ref": "#/components/schemas/ExtractionReviewDataGroup" }, "nullable": true } }, "additionalProperties": false }, "ExtractionReviewDataGroup": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "dataGroupId": { "type": "string", "nullable": true }, "primaryDataGroupField": { "type": "string", "nullable": true }, "dataGroupVersionNumber": { "type": "integer", "format": "int32", "nullable": true }, "requirementId": { "type": "string", "nullable": true }, "dataGroupKey": { "type": "string", "nullable": true }, "dataGroupName": { "type": "string", "nullable": true }, "mandatoryType": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "jurisdiction": { "type": "string", "nullable": true }, "isSensitiveData": { "type": "boolean", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/ExtractionReviewDataGroupFieldDefinition" }, "nullable": true }, "currentRecords": { "type": "array", "items": { "$ref": "#/components/schemas/ExtractionReviewDataGroupCurrentRecord" }, "nullable": true }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/ExtractionReviewDataGroupRecord" }, "nullable": true } }, "additionalProperties": false }, "ExtractionReviewDataGroupCurrentRecord": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "fields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "ExtractionReviewDataGroupExtractedValue": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "isSelected": { "type": "boolean" }, "sourceDocuments": { "type": "array", "items": { "$ref": "#/components/schemas/ExtractionReviewDocument" }, "nullable": true }, "values": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "originalValues": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "explanations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "ExtractionReviewDataGroupFieldDefinition": { "type": "object", "properties": { "fieldKey": { "type": "string", "nullable": true }, "fieldName": { "type": "string", "nullable": true }, "order": { "type": "number", "format": "double", "nullable": true }, "propertyType": { "type": "string", "nullable": true }, "propertyTypeId": { "type": "string", "nullable": true }, "mandatoryType": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ExtractionReviewDataGroupRecord": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "isSelected": { "type": "boolean" }, "extractedStatus": { "allOf": [ { "$ref": "#/components/schemas/ExtractedStatus" } ], "nullable": true }, "matchedExistingRecordIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "aiAssessmentSummary": { "type": "string", "nullable": true }, "decisionStatus": { "allOf": [ { "$ref": "#/components/schemas/DecisionStatus" } ], "nullable": true }, "rejectNote": { "type": "string", "nullable": true }, "customValues": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "extractedValues": { "type": "array", "items": { "$ref": "#/components/schemas/ExtractionReviewDataGroupExtractedValue" }, "nullable": true } }, "additionalProperties": false }, "ExtractionReviewDataGroupRecordDecisionUpdateDto": { "type": "object", "properties": { "decisionStatus": { "allOf": [ { "$ref": "#/components/schemas/DecisionStatus" } ] }, "selectedExtractedValueId": { "type": "string", "nullable": true }, "customValues": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "rejectNote": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExtractionReviewDataGroupRecordServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExtractionReviewDataGroupRecord" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ExtractionReviewDocument": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "pages": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "pagesDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExtractionReviewDto": { "type": "object", "properties": { "journeyInstanceId": { "type": "string", "nullable": true }, "taskId": { "type": "string", "nullable": true }, "entityId": { "type": "string", "nullable": true }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/ExtractionReviewCategory" }, "nullable": true } }, "additionalProperties": false }, "ExtractionReviewDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExtractionReviewDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ExtractionReviewExtractedValue": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "fieldKey": { "type": "string", "nullable": true }, "fieldName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "document": { "allOf": [ { "$ref": "#/components/schemas/ExtractionReviewDocument" } ], "nullable": true }, "explanation": { "type": "string", "nullable": true }, "isSelected": { "type": "boolean" }, "overridenValue": { "type": "string", "nullable": true }, "overridenDocument": { "allOf": [ { "$ref": "#/components/schemas/ExtractionReviewDocument" } ], "nullable": true }, "fieldError": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExtractionReviewField": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "fieldKey": { "type": "string", "nullable": true }, "fieldName": { "type": "string", "nullable": true }, "order": { "type": "number", "format": "double", "nullable": true }, "propertyType": { "type": "string", "nullable": true }, "propertyTypeId": { "type": "string", "nullable": true }, "mandatoryType": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "description": { "type": "string", "nullable": true }, "jurisdiction": { "type": "string", "nullable": true }, "isSensitiveData": { "type": "boolean", "nullable": true }, "currentValue": { "type": "string", "nullable": true }, "originalExtractedValue": { "type": "string", "nullable": true }, "extracted": { "type": "array", "items": { "$ref": "#/components/schemas/ExtractionReviewExtractedValue" }, "nullable": true }, "customValue": { "type": "string", "nullable": true }, "extractedStatus": { "allOf": [ { "$ref": "#/components/schemas/ExtractedStatus" } ], "nullable": true }, "decisionStatus": { "allOf": [ { "$ref": "#/components/schemas/DecisionStatus" } ], "nullable": true }, "rejectNote": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExtractionReviewFieldDecisionUpdateDto": { "type": "object", "properties": { "decisionStatus": { "allOf": [ { "$ref": "#/components/schemas/DecisionStatus" } ] }, "selectedExtractedValueId": { "type": "string", "nullable": true }, "selectedExtractedValueIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "customValue": { "type": "string", "nullable": true }, "rejectNote": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExtractionReviewFieldServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExtractionReviewField" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ExtractionReviewStatus": { "enum": [ "Conflicts", "NoConflicts", "Resolved", "Discarded" ], "type": "string" }, "ExtractionState": { "type": "object", "properties": { "singleValues": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FieldState" }, "nullable": true }, "collectionValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionState" } }, "nullable": true } }, "additionalProperties": false }, "ExtractionStateServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExtractionState" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ExtractionStatus": { "type": "object", "properties": { "journeyId": { "type": "string", "nullable": true }, "entityId": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "tenant": { "type": "string", "nullable": true }, "documentIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "error": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExtractionStatusServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExtractionStatus" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "FieldState": { "allOf": [ { "$ref": "#/components/schemas/BaseState" }, { "type": "object", "properties": { "overridenValue": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "GetExtractedRelatedPartiesProcessResponse": { "type": "object", "properties": { "parties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtractedRelatedPartyProcessDto" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetExtractedRelatedPartiesProcessResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetExtractedRelatedPartiesProcessResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetExtractedRelatedPartiesResponse": { "type": "object", "properties": { "parties": { "type": "array", "items": { "$ref": "#/components/schemas/ExtractedRelatedPartyDto" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32", "nullable": true }, "pageSize": { "type": "integer", "format": "int32", "nullable": true }, "totalPages": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "GetExtractedRelatedPartiesResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetExtractedRelatedPartiesResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetPageRagDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GetRagDto" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetPageRagDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetPageRagDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetRagDto": { "allOf": [ { "$ref": "#/components/schemas/RagDto" }, { "type": "object", "additionalProperties": false } ] }, "GetRagDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetRagDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetRelatedPartiesGroupsResponse": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyGroupDto" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32", "nullable": true }, "pageSize": { "type": "integer", "format": "int32", "nullable": true }, "totalPages": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "GetRelatedPartiesGroupsResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetRelatedPartiesGroupsResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetRelatedPartiesProcessGroupsResponse": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyProcessGroupDto" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32", "nullable": true }, "pageSize": { "type": "integer", "format": "int32", "nullable": true }, "totalPages": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "GetRelatedPartiesProcessGroupsResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetRelatedPartiesProcessGroupsResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetRelatedPartyDuplicatesResponse": { "type": "object", "properties": { "duplicates": { "type": "array", "items": { "$ref": "#/components/schemas/DuplicateSearchResultDto" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32", "nullable": true }, "pageSize": { "type": "integer", "format": "int32", "nullable": true }, "totalPages": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "GetRelatedPartyDuplicatesResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetRelatedPartyDuplicatesResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GroupDecisionDto": { "type": "object", "properties": { "outcome": { "allOf": [ { "$ref": "#/components/schemas/ReviewOutcome" } ] }, "partyId": { "type": "string", "nullable": true }, "duplicateId": { "type": "string", "nullable": true }, "rejectionComment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GroupedDocumentDataExtraction": { "type": "object", "properties": { "extractedData": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDataExtraction" } }, "nullable": true }, "extractedCollections": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/EntityDataCollectionExtraction" } }, "nullable": true } }, "additionalProperties": false }, "GroupedDocumentDataExtractionServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GroupedDocumentDataExtraction" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "HttpValidationProblemDetails": { "allOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": { } } ] }, "MatchType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PaginationTokenPagerDto": { "type": "object", "properties": { "pageSize": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" }, "paginationToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "RagDto": { "allOf": [ { "$ref": "#/components/schemas/BaseRagDto" }, { "required": [ "id" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "format": "uuid" }, "version": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false } ] }, "RelatedPartyGroupDto": { "type": "object", "properties": { "groupId": { "type": "string", "format": "uuid" }, "entityType": { "type": "string", "nullable": true }, "groupName": { "type": "string", "nullable": true }, "groupStatus": { "allOf": [ { "$ref": "#/components/schemas/RelatedPartyGroupStatus" } ] }, "groupStatusDescription": { "type": "string", "nullable": true }, "documentSources": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentSourceDto" }, "nullable": true }, "associations": { "type": "array", "items": { "type": "string" }, "nullable": true }, "relationshipDescriptions": { "type": "array", "items": { "$ref": "#/components/schemas/RelationshipDescriptionDto" }, "nullable": true }, "candidateCount": { "type": "integer", "format": "int32" }, "decision": { "allOf": [ { "$ref": "#/components/schemas/GroupDecisionDto" } ], "nullable": true } }, "additionalProperties": false }, "RelatedPartyGroupDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RelatedPartyGroupDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RelatedPartyGroupStatus": { "enum": [ "Unset", "MatchLinked", "MatchUnlinked", "New", "PartialLinked" ], "type": "string" }, "RelatedPartyProcessGroupDto": { "type": "object", "properties": { "groupId": { "type": "string", "format": "uuid" }, "entityType": { "type": "string", "nullable": true }, "groupName": { "type": "string", "nullable": true }, "documentCount": { "type": "integer", "format": "int32" }, "numberOfParties": { "type": "integer", "format": "int32" }, "order": { "type": "integer", "format": "int32" }, "extractionReviewStatus": { "allOf": [ { "$ref": "#/components/schemas/ExtractionReviewStatus" } ] }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyProcessGroupDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedPartyPropertyDto": { "type": "object", "properties": { "explanation": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "propertyName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RelatedPartyPropertyProcessDto": { "type": "object", "properties": { "explanation": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "policyName": { "type": "string", "nullable": true }, "propertyName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "conflicts": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "RelatedPartyReviewStage": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "RelationshipDescriptionDto": { "type": "object", "properties": { "parentGroupId": { "type": "string", "format": "uuid", "nullable": true }, "parentEntityName": { "type": "string", "nullable": true }, "relationshipType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReviewOutcome": { "enum": [ "Unset", "CreateNewEntity", "Discard", "LinkWithPrimaryEntity", "LinkAndUpdateExistingEntity" ], "type": "string" }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SplitPartyToNewGroupResponse": { "type": "object", "properties": { "groupId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "SplitPartyToNewGroupResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SplitPartyToNewGroupResponse" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "StageTransitionDto": { "type": "object", "properties": { "stage": { "allOf": [ { "$ref": "#/components/schemas/RelatedPartyReviewStage" } ] } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UpdateRagDto": { "allOf": [ { "$ref": "#/components/schemas/RagDto" }, { "type": "object", "additionalProperties": false } ] }, "ValidationErrorModel": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "attemptedValue": { "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationErrorModelListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorModel" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false, "example": { "data": [ { "propertyName": "data", "errorMessage": "Data is required", "attemptedValue": "", "errorCode": "NotNullValidator" } ], "messages": [ { "message": "Data is required", "type": "Error", "errorCode": "Error Code" } ] } } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }