{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula External Data BFF", "description": "**External Data BFF API**:\n\n
External Data BFF API allows to search, retrieve and import information about clients, their associated parties, documents from external providers. Use External Data BFF API to perform the import action. \n\n", "version": "1.0" }, "servers": [ { "url": "/externaldatabff" } ], "paths": { "/api/processes/{contextType}/search": { "post": { "tags": [ "Process" ], "summary": "Create new search request", "description": "\nThis method will create a search request that will trigger asynchronous requests to different external data providers.

Required permissions:
Following permissions are required: ExternalDataAccess

Required permissions:
Following permissions are required: ExternalDataAccess", "operationId": "RequestSearch", "parameters": [ { "name": "contextType", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "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 process search request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewRequestSearchRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "202": { "description": "Success. Search request created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRequestSearchResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/processes/newRequest/{contextId}/search": { "post": { "tags": [ "Process" ], "summary": "Create new search request for existing context", "description": "\nThis method will create a search request that will trigger asynchronous requests to different external data providers.

Required permissions:
Following permissions are required: ExternalDataAccess

Required permissions:
Following permissions are required: ExternalDataAccess", "operationId": "RequestNewRequestSearch", "parameters": [ { "name": "contextId", "in": "path", "description": "", "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 process search request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewRequestSearchRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "202": { "description": "Success. Search request created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRequestSearchResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/processes/newRequest/{contextId}": { "get": { "tags": [ "Process" ], "summary": "Get process data by context type and id", "description": "\nThis method will return process data for given context type and id

Required permissions:
Following permissions are required: ExternalDataAccess

Required permissions:
Following permissions are required: ExternalDataAccess", "operationId": "GetNewRequest", "parameters": [ { "name": "contextId", "in": "path", "description": "Id from which the request originated from", "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/ExternalDataNewRequestDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/processes/{contextType}/{contextId}/search": { "post": { "tags": [ "Process" ], "summary": "Create new search request", "description": "\nThis method will create a search request that will trigger asynchronous requests to different external data providers.

Required permissions:
Following permissions are required: ExternalDataAccess

Required permissions:
Following permissions are required: ExternalDataAccess", "operationId": "RequestProcessSearch", "parameters": [ { "name": "contextType", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "contextId", "in": "path", "description": "", "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 process search request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessSearchRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "202": { "description": "Success. Search request created" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/processes/{contextType}/{contextId}/get": { "post": { "tags": [ "Process" ], "summary": "Create new get request", "description": "\nThis method will create a get request that will trigger asynchronous requests to different external data providers.

Required permissions:
Following permissions are required: ExternalDataAccess

Required permissions:
Following permissions are required: ExternalDataAccess", "operationId": "RequestProcessGet", "parameters": [ { "name": "contextType", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "contextId", "in": "path", "description": "", "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 process get request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessGetRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "202": { "description": "Success. Get request created" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/processes/{contextType}/{contextId}/ubo": { "post": { "tags": [ "Process" ], "summary": "Create Ultimate Beneficial Owner discovery request", "description": "\nThis method will create a ultimate beneficial owner discovery request that will trigger asynchronous requests to different external data providers.

Required permissions:
Following permissions are required: ExternalDataAccess

Required permissions:
Following permissions are required: ExternalDataAccess", "operationId": "RequestProcessUbo", "parameters": [ { "name": "contextType", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "contextId", "in": "path", "description": "", "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 process ubo request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessUboRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "202": { "description": "Success. Ultimate beneficial owner discovery request created" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/processes/newRequest/{contextId}/gets": { "post": { "tags": [ "Process" ], "summary": "Create new get request", "description": "\nThis method will create a get request that will trigger asynchronous requests to different external data providers.

Required permissions:
Following permissions are required: ExternalDataAccess

Required permissions:
Following permissions are required: ExternalDataAccess", "operationId": "RequestNewRequestGet", "parameters": [ { "name": "contextId", "in": "path", "description": "", "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 process get request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewRequestGetRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "202": { "description": "Success. Get request created" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/processes/newRequest/{contextId}/import": { "post": { "tags": [ "Process" ], "summary": "Create new import request", "description": "\nThis method will create an import request that will create an entity from external data.

Required permissions:
Following permissions are required: ExternalDataApprove

Required permissions:
Following permissions are required: ExternalDataApprove", "operationId": "RequestNewRequestImport", "parameters": [ { "name": "contextId", "in": "path", "description": "", "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 process import request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewRequestImportRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "202": { "description": "Success. Import request created" }, "400": { "description": "Bad request. The import has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/processes/{contextType}/{contextId}/import": { "post": { "tags": [ "Process" ], "summary": "Create new import request", "description": "\nThis method will create an import request that will trigger asynchronous import to FenX.

Required permissions:
Following permissions are required: ExternalDataApprove

Required permissions:
Following permissions are required: ExternalDataApprove", "operationId": "RequestProcessImport", "parameters": [ { "name": "contextType", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "contextId", "in": "path", "description": "", "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 process import request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessImportRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "202": { "description": "Success. Import request created" }, "400": { "description": "Bad request. The import has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/processes/{contextType}/{contextId}/gets/{getId}/document": { "post": { "tags": [ "Process" ], "summary": "Create new document retrieval request", "description": "\nThis method will create a document retrieval request that will trigger asynchronous requests to different external data providers.

Required permissions:
Following permissions are required: ExternalDataAccess

Required permissions:
Following permissions are required: ExternalDataAccess", "operationId": "RequestProcessGetDocument", "parameters": [ { "name": "contextType", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "contextId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "getId", "in": "path", "description": "", "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 process import request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentsRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "202": { "description": "Success. Document request created" }, "400": { "description": "Bad request. The document has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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" } ] } } } } } }, "patch": { "tags": [ "Process" ], "summary": "Create new Reject/Reset documents status request", "description": "\nThis method allow to reject document or reset the document rejection

Required permissions:
Following permissions are required: ExternalDataAccess

Required permissions:
Following permissions are required: ExternalDataAccess", "operationId": "UpdateDocuments", "parameters": [ { "name": "contextType", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "contextId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "getId", "in": "path", "description": "", "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 document reject/reset status", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentsStatusRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "202": { "description": "Success. Document status rejected/reseted" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/processes/{contextType}/{contextId}": { "get": { "tags": [ "Process" ], "summary": "Get process data by context type and id", "description": "\nThis method will return process data for given context type and id

Required permissions:
Following permissions are required: ExternalDataAccess

Required permissions:
Following permissions are required: ExternalDataAccess", "operationId": "GetProcess", "parameters": [ { "name": "contextType", "in": "path", "description": "type of the context from which the request originated from", "required": true, "schema": { "type": "string" } }, { "name": "contextId", "in": "path", "description": "Id from which the request originated from", "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/ExternalDataProcessDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/processes/{contextType}/{contextId}/gets/{getId}": { "get": { "tags": [ "Process" ], "summary": "Get process get data by id", "description": "\nThis method will return process get data for given id

Required permissions:
Following permissions are required: ExternalDataAccess

Required permissions:
Following permissions are required: ExternalDataAccess", "operationId": "GetProcessGet", "parameters": [ { "name": "contextType", "in": "path", "description": "type of the context from which the request originated from", "required": true, "schema": { "type": "string" } }, { "name": "contextId", "in": "path", "description": "Id from which the request originated from", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "getId", "in": "path", "description": "Id of the get", "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/ExternalDataProcessGetDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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": { "AccessLayerDto": { "type": "object", "properties": { "geographic": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "nullable": true }, "businessRelated": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ContextType": { "enum": [ "Empty", "Journey", "NewRequest" ], "type": "string" }, "DocumentInitiationFailReason": { "enum": [ "None", "ProviderNotEnabled", "InternalError" ], "type": "string" }, "DocumentRecordDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "externalId": { "type": "string", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/DocumentStatus" } ] }, "failReason": { "allOf": [ { "$ref": "#/components/schemas/DocumentInitiationFailReason" } ] }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "DocumentRecordsDto": { "type": "object", "properties": { "externalId": { "type": "string", "nullable": true }, "recentRecordId": { "type": "string", "format": "uuid" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentRecordDto" }, "nullable": true } }, "additionalProperties": false }, "DocumentRequestDataDto": { "required": [ "name", "type" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "type": { "minLength": 1, "type": "string" }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "nullable": true } }, "additionalProperties": false }, "DocumentRequestDto": { "required": [ "data", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentRequestDataDto" } ] } }, "additionalProperties": false }, "DocumentStatus": { "enum": [ "Available", "Initiated", "Requested", "Completed", "Rejected", "FailedInitiation", "FailedRequest" ], "type": "string" }, "DocumentStatusRequestDto": { "required": [ "documentId", "status" ], "type": "object", "properties": { "documentId": { "type": "string", "format": "uuid" }, "status": { "allOf": [ { "$ref": "#/components/schemas/DocumentStatus" } ] } }, "additionalProperties": false }, "DocumentsRequestDto": { "required": [ "documents" ], "type": "object", "properties": { "documents": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentRequestDto" } } }, "additionalProperties": false }, "DocumentsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentsRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "DocumentsStatusRequestDto": { "required": [ "documents" ], "type": "object", "properties": { "documents": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentStatusRequestDto" } } }, "additionalProperties": false }, "DocumentsStatusRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentsStatusRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "EntityType": { "enum": [ "Unknown", "Company", "Individual" ], "type": "string" }, "EntityValidationDetails": { "type": "object", "properties": { "entityName": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "type": "string" }, "nullable": true }, "targetEntity": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExternalDataNewRequestDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "context": { "allOf": [ { "$ref": "#/components/schemas/ExternalDataProcessContextDto" } ], "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/ProcessStatus" } ] }, "searches": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderNewRequestSearchRecordsDto" }, "nullable": true }, "imports": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderNewRequestImportRecordsDto" }, "nullable": true }, "gets": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderNewRequestGetRecordsDto" }, "nullable": true }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ExternalDataNewRequestDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExternalDataNewRequestDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ExternalDataProcessContextDto": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/ContextType" } ] }, "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ExternalDataProcessDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "context": { "allOf": [ { "$ref": "#/components/schemas/ExternalDataProcessContextDto" } ], "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/ProcessStatus" } ] }, "searches": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderSearchRecordsDto" }, "nullable": true }, "gets": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderGetRecordsDto" }, "nullable": true }, "ubos": { "type": "array", "items": { "$ref": "#/components/schemas/UboRecordsDto" }, "nullable": true }, "imports": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderImportRecordsDto" }, "nullable": true }, "monitorings": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderMonitoringRecordsDto" }, "nullable": true }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ExternalDataProcessDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExternalDataProcessDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ExternalDataProcessGetDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "isLargePayload": { "type": "boolean" }, "s3FileLocation": { "type": "string", "nullable": true }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentRecordsDto" }, "nullable": true } }, "additionalProperties": false }, "ExternalDataProcessGetDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ExternalDataProcessGetDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "GetInitiationFailReason": { "enum": [ "None", "ProviderNotEnabled", "InternalError" ], "type": "string" }, "GetRecordDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "externalId": { "type": "string", "nullable": true }, "searchId": { "type": "string", "format": "uuid" }, "status": { "allOf": [ { "$ref": "#/components/schemas/GetStatus" } ] }, "failReason": { "allOf": [ { "$ref": "#/components/schemas/GetInitiationFailReason" } ] }, "created": { "type": "string", "format": "date-time" }, "taskId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "GetRecordsDto": { "type": "object", "properties": { "externalId": { "type": "string", "nullable": true }, "recentRecordId": { "type": "string", "format": "uuid" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/GetRecordDto" }, "nullable": true } }, "additionalProperties": false }, "GetStatus": { "enum": [ "Initiated", "Requested", "Completed", "FailedInitiation", "FailedRequest" ], "type": "string" }, "ImportFailReason": { "enum": [ "None", "ProviderNotEnabled", "InternalError" ], "type": "string" }, "ImportRecordDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "getId": { "type": "string", "format": "uuid" }, "status": { "allOf": [ { "$ref": "#/components/schemas/ImportStatus" } ] }, "failReason": { "allOf": [ { "$ref": "#/components/schemas/ImportFailReason" } ] }, "created": { "type": "string", "format": "date-time" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "array", "items": { "$ref": "#/components/schemas/EntityValidationDetails" }, "nullable": true } }, "additionalProperties": false }, "ImportRecordsDto": { "type": "object", "properties": { "getId": { "type": "string", "format": "uuid" }, "recentRecordId": { "type": "string", "format": "uuid" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/ImportRecordDto" }, "nullable": true } }, "additionalProperties": false }, "ImportStatus": { "enum": [ "None", "Initiated", "Completed", "CompletedWithWarnings", "Failed" ], "type": "string" }, "JourneyTypeDto": { "required": [ "type" ], "type": "object", "properties": { "type": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "MonitoringDeletionInitiationFailReason": { "enum": [ "None", "ProviderNotEnabled", "InternalError" ], "type": "string" }, "MonitoringInitiationFailReason": { "enum": [ "None", "ProviderNotEnabled", "InternalError" ], "type": "string" }, "MonitoringRecordDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "importId": { "type": "string", "format": "uuid" }, "externalId": { "type": "string", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/MonitoringStatus" } ] }, "failReason": { "allOf": [ { "$ref": "#/components/schemas/MonitoringInitiationFailReason" } ] }, "deletionFailReason": { "allOf": [ { "$ref": "#/components/schemas/MonitoringDeletionInitiationFailReason" } ] }, "errorMessage": { "type": "string", "nullable": true }, "deletionErrorMessage": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "MonitoringStatus": { "enum": [ "None", "Initiated", "Requested", "Active", "SkippedAlreadyActive", "DeletionInitiated", "DeletionRequested", "Deleted", "FailedInitiation", "FailedRequest", "FailedDeletionInitiation", "FailedDeletionRequest" ], "type": "string" }, "NewRequestGetRecordDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "externalId": { "type": "string", "nullable": true }, "searchId": { "type": "string", "format": "uuid" }, "status": { "allOf": [ { "$ref": "#/components/schemas/GetStatus" } ] }, "failReason": { "allOf": [ { "$ref": "#/components/schemas/GetInitiationFailReason" } ] }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "NewRequestGetRecordsDto": { "type": "object", "properties": { "externalId": { "type": "string", "nullable": true }, "recentRecordId": { "type": "string", "format": "uuid" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/NewRequestGetRecordDto" }, "nullable": true } }, "additionalProperties": false }, "NewRequestGetRequestDto": { "required": [ "externalId", "providerId", "searchId" ], "type": "object", "properties": { "searchId": { "type": "string", "format": "uuid" }, "providerId": { "type": "string", "format": "uuid" }, "externalId": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "NewRequestGetRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/NewRequestGetRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "NewRequestImportContextDataDto": { "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid" }, "journeysIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "NewRequestImportRecordDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "searchId": { "type": "string", "format": "uuid" }, "externalId": { "type": "string", "nullable": true }, "overwrittenData": { "nullable": true }, "journeyTypes": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyTypeDto" }, "nullable": true }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "nullable": true }, "contextData": { "allOf": [ { "$ref": "#/components/schemas/NewRequestImportContextDataDto" } ], "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/ImportStatus" } ] }, "failReason": { "allOf": [ { "$ref": "#/components/schemas/ImportFailReason" } ] }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "NewRequestImportRequestDto": { "required": [ "accessLayers", "externalId", "journeyTypes", "overwrittenData", "searchId" ], "type": "object", "properties": { "searchId": { "type": "string", "format": "uuid" }, "externalId": { "minLength": 1, "type": "string" }, "overwrittenData": { }, "journeyTypes": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyTypeDto" } }, "accessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ] } }, "additionalProperties": false }, "NewRequestImportRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/NewRequestImportRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "NewRequestSearchRecordDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "allOf": [ { "$ref": "#/components/schemas/SearchStatus" } ] }, "criteria": { "nullable": true }, "entityType": { "allOf": [ { "$ref": "#/components/schemas/EntityType" } ] }, "failReason": { "allOf": [ { "$ref": "#/components/schemas/SearchInitiationFailReason" } ] }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "NewRequestSearchRequestDto": { "required": [ "entityType", "providersIds", "searchCriteria" ], "type": "object", "properties": { "providersIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "searchCriteria": { }, "entityType": { "allOf": [ { "$ref": "#/components/schemas/EntityType" } ] } }, "additionalProperties": false }, "NewRequestSearchRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/NewRequestSearchRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "NewRequestSearchResponseDto": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "NewRequestSearchResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/NewRequestSearchResponseDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ProcessGetRequestDto": { "required": [ "externalId", "providerId", "searchId" ], "type": "object", "properties": { "searchId": { "type": "string", "format": "uuid" }, "providerId": { "type": "string", "format": "uuid" }, "externalId": { "minLength": 1, "type": "string" }, "documentCollectionProviderIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "taskId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "ProcessGetRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProcessGetRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "ProcessImportRequestDto": { "required": [ "getId" ], "type": "object", "properties": { "getId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ProcessImportRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProcessImportRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "ProcessSearchRequestDto": { "required": [ "providersIds" ], "type": "object", "properties": { "providersIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "taskId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "ProcessSearchRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProcessSearchRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "ProcessStatus": { "enum": [ "Unknown", "Active", "Invalid" ], "type": "string" }, "ProcessUboRequestDto": { "required": [ "getId" ], "type": "object", "properties": { "getId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ProcessUboRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProcessUboRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "ProviderGetRecordsDto": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid" }, "recentRecordId": { "type": "string", "nullable": true }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/GetRecordsDto" }, "nullable": true } }, "additionalProperties": false }, "ProviderImportRecordsDto": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid" }, "recentRecordId": { "type": "string", "format": "uuid" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/ImportRecordsDto" }, "nullable": true } }, "additionalProperties": false }, "ProviderMonitoringRecordsDto": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid" }, "recentRecordId": { "type": "string", "format": "uuid" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoringRecordDto" }, "nullable": true } }, "additionalProperties": false }, "ProviderNewRequestGetRecordsDto": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid" }, "recentRecordId": { "type": "string", "nullable": true }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/NewRequestGetRecordsDto" }, "nullable": true } }, "additionalProperties": false }, "ProviderNewRequestImportRecordsDto": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid" }, "recentRecordId": { "type": "string", "format": "uuid" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/NewRequestImportRecordDto" }, "nullable": true } }, "additionalProperties": false }, "ProviderNewRequestSearchRecordsDto": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid" }, "recentRecordId": { "type": "string", "format": "uuid" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/NewRequestSearchRecordDto" }, "nullable": true } }, "additionalProperties": false }, "ProviderSearchRecordsDto": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid" }, "recentRecordId": { "type": "string", "format": "uuid" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/SearchRecordDto" }, "nullable": true } }, "additionalProperties": false }, "SearchInitiationFailReason": { "enum": [ "None", "ProviderNotEnabled", "DraftNotFound", "InternalError", "EntityTypeUnsupported" ], "type": "string" }, "SearchRecordDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "allOf": [ { "$ref": "#/components/schemas/SearchStatus" } ] }, "failReason": { "allOf": [ { "$ref": "#/components/schemas/SearchInitiationFailReason" } ] }, "created": { "type": "string", "format": "date-time" }, "taskId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "SearchStatus": { "enum": [ "Initiated", "Requested", "Completed", "FailedInitiation", "FailedRequest" ], "type": "string" }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "description": "The message", "nullable": true, "example": "Success" }, "type": { "type": "string", "description": "Type of the message\nOne of Info, Warning, Error, Forbidden", "nullable": true, "example": "Info" }, "errorCode": { "type": "string", "description": "Error Code", "nullable": true, "example": "INTERNAL_SERVER_ERROR" } }, "additionalProperties": false, "description": "The message associated to the service response" }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "UboInitiationFailReason": { "enum": [ "None", "ProviderNotEnabled", "InternalError" ], "type": "string" }, "UboRecordDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "getId": { "type": "string", "format": "uuid" }, "status": { "allOf": [ { "$ref": "#/components/schemas/UboStatus" } ] }, "failReason": { "allOf": [ { "$ref": "#/components/schemas/UboInitiationFailReason" } ] }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "UboRecordsDto": { "type": "object", "properties": { "getId": { "type": "string", "format": "uuid" }, "recentRecordId": { "type": "string", "format": "uuid" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/UboRecordDto" }, "nullable": true } }, "additionalProperties": false }, "UboStatus": { "enum": [ "Initiated", "Requested", "Completed", "FailedInitiation", "FailedRequest" ], "type": "string" } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }