openapi: 3.2.0 info: title: Fenergo Data & Docs Collection API version: '1.0' description: 'Operations tagged Data & Docs Collection across 2 of this provider''s published API definitions: fenergo-externaldatacommand-v1-0-openapi.json, fenergo-externaldataquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /externaldatacommand - url: /externaldataquery security: - Bearer: [] tags: - name: Data & Docs Collection paths: /api/datadocs/saveDataDocsResult: post: tags: - Data & Docs Collection summary: Save Data&Doc collection description: 'This method will save Data&Doc collection. The method will return the status. Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: SaveDataDocsResult 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: Save Data&Doc collection content: application/json: schema: allOf: - $ref: '#/components/schemas/DataDocsHeaderDtoServiceRequest' description: Service request data responses: '202': description: Success. Save Data & Docs request created '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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 servers: - url: /externaldatacommand /api/datadocs/saveDataDocsTaskStatusResult: post: tags: - Data & Docs Collection summary: Save Data&Doc collection Task State description: 'This method will save Data&Doc collection task state. The method will return the task state. Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: SaveDataDocsTaskStatusResult 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: Save Data&Doc collection task status content: application/json: schema: allOf: - $ref: '#/components/schemas/DataDocsTaskStatusDtoServiceRequest' description: Service request data responses: '202': description: Success. Save Data & Docs task state request created '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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 servers: - url: /externaldatacommand /api/datadocs/processDataDocsSummarisation: post: tags: - Data & Docs Collection summary: Process Data&Doc summarisation description: 'This method processes the Data&Doc global summary for the supplied task. The request starts or retries summarisation processing. Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: ProcessDataDocsSummarisation 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: Process Data&Doc summarisation request content: application/json: schema: allOf: - $ref: '#/components/schemas/ProcessDataDocsSummarisationDtoServiceRequest' description: Service request data responses: '200': description: Success. Summarisation processing completed. '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 servers: - url: /externaldatacommand /api/datadocs/import: post: tags: - Data & Docs Collection summary: Starts Import process for Data&Doc documents. description: 'This method will import data. Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: importDataDocs 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: Import Data&Doc documents content: application/json: schema: allOf: - $ref: '#/components/schemas/DataDocsImportDtoServiceRequest' description: Service request data responses: '202': description: Success. Import request received '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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 servers: - url: /externaldatacommand /api/datadocs/getAggregateResults/{journeyId}/{taskId}: get: tags: - Data & Docs Collection summary: Get aggregated company data by task id description: 'This method will return aggregated company data for given task id Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: GetDataDocsByTaskId parameters: - name: taskId in: path description: Id from which the task originated from required: true schema: type: string format: uuid - name: journeyId in: path description: Id from which the journey 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: Instance of Fenergo.Nebula.ExternalData.Query.Application.Dto.DataDocsResultDto class containing company data of aggregated entity content: application/json: schema: $ref: '#/components/schemas/DataDocsEntityDetailFieldsDtoServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Import request with given TaskId does not exist 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 servers: - url: /externaldataquery /api/datadocs/DataDocs/{journeyId}/{taskId}: get: tags: - Data & Docs Collection summary: Get Data&Doc collection Task State by task id description: 'This method will return stages data for given Data&Doc by task id Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: GetDataDocsStatesByTaskId parameters: - name: taskId in: path description: Id from which the task originated from required: true schema: type: string format: uuid - name: journeyId in: path description: Id from which the journey 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: Instance of Fenergo.Nebula.ExternalData.Query.Application.Dto.DataSourcingAgent.DataDocsCollectorStateDto class containing company data of aggregated entity content: application/json: schema: $ref: '#/components/schemas/DataDocsCollectorStateDtoServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Import request with given TaskId does not exist 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 servers: - url: /externaldataquery /api/datadocs/relatedParties/{journeyId}/{taskId}: get: tags: - Data & Docs Collection summary: Get Related Parties Details by Task Id description: This method will return related parties data for a given task Id. operationId: GetRelatedPartiesDetails parameters: - name: taskId in: path description: The unique identifier of the related party group required: true schema: type: string format: uuid - name: journeyId in: path description: Id from which the journey 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: Instance of Fenergo.Nebula.ExternalData.Query.Application.Dto.DataDocsRelatedPartiesDetailsDto containing related party details content: application/json: schema: $ref: '#/components/schemas/DataDocsRelatedPartiesDetailsDtoServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Related party group with the given Id does not exist 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 servers: - url: /externaldataquery /api/datadocs/aggregatedDocuments/{journeyId}/{taskId}: get: tags: - Data & Docs Collection summary: Get Documents by Task Id and Journey Id description: This method will return document information for a given task Id. operationId: GetAggregatedEntityDocuments parameters: - name: taskId in: path description: Task Id required: true schema: type: string format: uuid - name: journeyId in: path description: Id from which the journey 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: Instance of Fenergo.Nebula.ExternalData.Query.Application.Dto.DataSourcingAgent.Documents.AggregatedDocumentsDto containing documents details content: application/json: schema: $ref: '#/components/schemas/AggregatedDocumentsDtoServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Documents with the given Id does not exist 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 servers: - url: /externaldataquery /api/datadocs/Insights/{journeyId}/{taskId}: get: tags: - Data & Docs Collection summary: Get Data&Doc Collection Summary Insights description: 'This method returns data for the specified Data&Doc collection insights by task id. Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: GetDataDocsInsights parameters: - name: taskId in: path description: Id from which the task originated from required: true schema: type: string format: uuid - name: journeyId in: path description: Id from which the journey 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: Instance of Fenergo.Nebula.ExternalData.Query.Application.Dto.DataSourcingAgent.DataDocsCollectorSummaryInsightsDto class containing insights data of the aggregated entity content: application/json: schema: $ref: '#/components/schemas/DataDocsCollectorSummaryInsightsDtoServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Import request with given TaskId does not exist 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 servers: - url: /externaldataquery /api/datadocs/hierarchyInsights/{journeyId}/{taskId}: get: tags: - Data & Docs Collection summary: Returns hierarchy comparison insights for a given journey and task description: 'Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: GetHierarchyInsights parameters: - name: journeyId in: path description: Id of the journey required: true schema: type: string format: uuid - name: taskId in: path description: Id of the task 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: Instance of Fenergo.Nebula.ExternalData.Query.Application.Dto.DataSourcingAgent.HierarchyInsights.HierarchyInsightsDto class containing hierarchy insights content: application/json: schema: $ref: '#/components/schemas/HierarchyInsightsDtoServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Hierarchy insights not found for the given journey and task 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 servers: - url: /externaldataquery /api/datadocs/hierarchyDifferences/types: get: tags: - Data & Docs Collection summary: Returns the supported hierarchy insights difference types description: 'Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: GetHierarchyInsightsDifferencesTypes 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 responses: '200': description: List of available difference type names content: application/json: schema: $ref: '#/components/schemas/StringListServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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 servers: - url: /externaldataquery /api/datadocs/hierarchyDifferences: post: tags: - Data & Docs Collection summary: Returns a paged list of hierarchy comparison differences for a given journey… description: 'Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: GetHierarchyInsightsDifferences 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: Search request containing journey/task identifiers, type filters and paging content: application/json: schema: allOf: - $ref: '#/components/schemas/SearchForDifferencesDtoServiceRequest' description: Service request data responses: '200': description: Paged list of Fenergo.Nebula.ExternalData.Query.Application.Dto.DataSourcingAgent.HierarchyInsights.ComparisonDifferenceDto content: application/json: schema: $ref: '#/components/schemas/ComparisonDifferenceDtoPagedListDtoServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Hierarchy insights not found for the given journey and task 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 servers: - url: /externaldataquery /api/datadocs/Summarisation/{journeyId}/{taskId}: get: tags: - Data & Docs Collection summary: Get Data Docs Summarisation by Task Id description: 'This method returns the current Data Docs summarisation state for the given task. The generated `Summary` payload is returned only when the status is `Completed`. Required permissions: Following permissions are required: ExternalDataAccess Required permissions: Following permissions are required: ExternalDataAccess' operationId: GetDataDocsSummarisation parameters: - name: taskId in: path description: Id from which the task originated from required: true schema: type: string format: uuid - name: journeyId in: path description: Id from which the journey 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: Instance of Fenergo.Nebula.ExternalData.Query.Application.Dto.DataSourcingAgent.Summarisation.DataDocsSummaryDto containing the summarisation status and, when completed, the generated summary content content: application/json: schema: $ref: '#/components/schemas/DataDocsSummaryDtoServiceResponse' '400': description: Invalid request 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 servers: - url: /externaldataquery components: schemas: ServiceResponse: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data DataDocsHeaderDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/DataDocsHeaderDto' description: The service request DTO additionalProperties: false description: Service request data DataDocsCollectorStateDto: type: object properties: baseStagesInit: type: - array - 'null' items: $ref: '#/components/schemas/DataDocsCollectorStageBaseDto' currentStageType: allOf: - $ref: '#/components/schemas/DataDocsCurrentStageType' description: Represents the stage type in the data docs . documentsEnabled: type: boolean additionalProperties: false DataDocsCollectorStageBaseDto: type: object properties: status: allOf: - $ref: '#/components/schemas/DataDocsStageStatus' description: Represents the processing status of a data document stage. type: allOf: - $ref: '#/components/schemas/DataDocsCurrentStageType' description: Represents the stage type in the data docs . additionalProperties: false ProcessDataDocsSummarisationDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ProcessDataDocsSummarisationDto' description: The service request DTO additionalProperties: false description: Service request data DataDocsTaskStatusDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/DataDocsTaskStatusDto' description: The service request DTO additionalProperties: false description: Service request data DataDocsResultDto: type: object properties: aggregatedFields: type: - object - 'null' additionalProperties: type: - array - 'null' items: $ref: '#/components/schemas/FieldSource' description: List of fields additionalProperties: false ProcessDataDocsSummarisationDto: required: - journeyId - taskId type: object properties: taskId: minLength: 1 type: string description: ID of the journey task format: uuid example: 300e2046-f78c-49d2-b326-afba28dc301c journeyId: minLength: 1 type: string description: ID of the journey format: uuid example: 400e3046-f78c-49d2-b326-afba28dc301d currentStageType: allOf: - $ref: '#/components/schemas/DataDocsCurrentStageType' description: Current stage type - optional for manual retry requests and defaults to Summary when omitted additionalProperties: false description: DTO representing Process Data Docs Summarisation Request DataDocsCurrentStageType: enum: - 1 - 2 - 3 - 4 - 5 type: integer description: Represents the stage type in the data docs . format: int32 FieldSource: type: object properties: value: type: - string - 'null' provider: type: - string - 'null' additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response ObjectServiceResponse: type: object properties: data: description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data DataDocsImportDto: required: - journeyId - taskId type: object properties: taskId: minLength: 1 type: string description: ID of the journey task format: uuid example: 300e2046-f78c-49d2-b326-afba28dc301c journeyId: minLength: 1 type: string description: ID of the journey format: uuid example: 300e2046-f78c-49d2-b326-afba28dc301c additionalProperties: false description: DTO representing Data Docs Entity Details Request DataDocsHeaderDto: required: - journeyId - taskId type: object properties: taskId: minLength: 1 type: string description: ID of the journey task example: 300e2046-f78c-49d2-b326-afba28dc301c fields: allOf: - $ref: '#/components/schemas/DataDocsResultDto' description: List of Fields, currently only aggregated fields supported journeyId: minLength: 1 type: string description: ID of the journey format: uuid example: 300e2046-f78c-49d2-b326-afba28dc301c additionalProperties: false description: Class to represent deduplication statuses for all Associations DataDocsStageStatus: enum: - 1 - 2 - 3 - 4 type: integer description: Represents the processing status of a data document stage. format: int32 DataDocsTaskStatusDto: required: - dataDocsCollectorState - journeyId - taskId type: object properties: journeyId: minLength: 1 type: string description: ID of the journey format: uuid example: 300e2046-f78c-49d2-b326-afba28dc301c taskId: minLength: 1 type: string description: ID of the journey task format: uuid example: 300e2046-f78c-49d2-b326-afba28dc301c dataDocsCollectorState: allOf: - $ref: '#/components/schemas/DataDocsCollectorStateDto' description: Current status for the data&docs states additionalProperties: false description: Class to represent data&docs states DataDocsImportDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/DataDocsImportDto' description: The service request DTO additionalProperties: false description: Service request data StringServiceResponse: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data DataDocsSummaryDto: type: object properties: aiEnabled: type: boolean description: 'Indicates whether AI is enabled in the current agent configuration. When `false`, no agent summary will be generated for the task.' status: type: - string - 'null' description: 'The current summarisation progress stage for the task. Expected values include `CollectingData`, `RunningLLM`, and `Completed`.' summary: allOf: - $ref: '#/components/schemas/DataDocsSummarisationDto' description: 'The AI-generated summary content. Only populated when Fenergo.Nebula.ExternalData.Query.Application.Dto.DataSourcingAgent.Summarisation.DataDocsSummaryDto.Status is `Completed`; otherwise this value is `null`.' failureMessage: type: - string - 'null' description: 'A user-facing failure reason for failed summarisation runs. Only populated when Fenergo.Nebula.ExternalData.Query.Application.Dto.DataSourcingAgent.Summarisation.DataDocsSummaryDto.Status is `Failed`.' additionalProperties: false ComparisonDifferenceDtoPagedListDto: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/ComparisonDifferenceDto' description: List of items returned by the query total: type: integer description: Number of total items matched by the query format: int64 additionalProperties: false AggregatedDocumentDto: type: object properties: id: type: - string - 'null' description: Document Id name: type: - string - 'null' description: Document Name date: type: - string - 'null' description: Document Date format: date-time providerId: type: - string - 'null' description: Provider Id recordId: type: - string - 'null' description: Record id of the document containing document information this value is used for ordering of the document. providerData: description: Provider Specific data documentType: type: - string - 'null' description: Document Type example: Account Opening Form documentStatus: type: - string - 'null' description: Document Status example: Requested fileLocation: type: - string - 'null' description: File Location in the Doc Storage example: //path/file linkExpirationDate: type: - string - 'null' description: Link expiration date format: date-time example: '2021-01-01T14:48:00.000Z' accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Access Layer information for the document errorDetails: allOf: - $ref: '#/components/schemas/AdapterResponseErrorDetails' description: Detailed error message additionalProperties: false SingleDataFieldDto: type: object properties: id: type: - string - 'null' providers: type: - array - 'null' items: $ref: '#/components/schemas/FieldSource' reviewRequired: type: boolean isOverridden: type: boolean description: type: - string - 'null' propertyType: type: - string - 'null' propertyTypeId: type: - string - 'null' additionalProperties: false DataDocsRelatedPartiesDetailsDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DataDocsRelatedPartiesDetailsDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data AccessLayerDto: type: object properties: geographic: uniqueItems: true type: - array - 'null' items: type: string description: Geographic Access Layers businessRelated: uniqueItems: true type: - array - 'null' items: type: string description: Business Related Access Layers additionalProperties: false PropertyDto: type: object properties: value: type: - string - 'null' description: Value of the property example: Example value type: type: - string - 'null' description: Type of property example: Single customTypeId: type: string description: Id of custom type format: uuid example: bf8488ac-dcc9-42ba-97f1-471f4f735572 isValid: type: boolean description: The is valid flag example: true properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' description: Dictionary of properties additionalProperties: false description: Abstraction that represents properties DataDocsCollectorSummaryInsightsDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DataDocsCollectorSummaryInsightsDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data DataDocsSummaryEnhancedStatsDto: type: object properties: enhancedStatType: type: - string - 'null' description: The type of the enhanced statistic (e.g., FieldsUpdated, DocumentsSourced). value: type: - string - 'null' description: The value or count associated with the statistic. autoResolved: type: integer description: Number of items resolved automatically. format: int32 manuallyResolved: type: integer description: Number of items resolved manually by users. format: int32 needsReview: type: integer description: Number of items that require review. format: int32 providerIds: type: - array - 'null' items: type: string description: List of provider IDs associated with the statistic. additionalProperties: false HierarchyInsightsDto: type: object properties: summary: type: - string - 'null' sourceProvider: type: - string - 'null' targetProvider: type: - string - 'null' comparisonSummary: allOf: - $ref: '#/components/schemas/ComparisonSummaryDto' providerStatistics: type: - array - 'null' items: $ref: '#/components/schemas/InsightInfoDto' additionalProperties: false AggregatedDocumentsDto: type: object properties: documents: type: - array - 'null' items: $ref: '#/components/schemas/AggregatedDocumentDto' description: List of available and downloaded documents from the External Data Provider additionalProperties: false SearchForDifferencesDto: required: - journeyId - taskId type: object properties: journeyId: minLength: 1 type: string format: uuid taskId: minLength: 1 type: string format: uuid types: type: - array - 'null' items: type: string pager: allOf: - $ref: '#/components/schemas/PagerDto' description: Specification of search result page additionalProperties: false DataDocsCollectorStateDto_2: type: object properties: baseStagesInit: type: - array - 'null' items: $ref: '#/components/schemas/DataDocsCollectorStageBaseDto_2' description: State of the DataDocs task currentStageType: allOf: - $ref: '#/components/schemas/DataDocsCurrentStageType' description: Current stage of the DataDocs task importStatuses: type: - object - 'null' properties: SelectDataProfiles: $ref: '#/components/schemas/DataDocsImportStatus' EntityDetails: $ref: '#/components/schemas/DataDocsImportStatus' RelatedParties: $ref: '#/components/schemas/DataDocsImportStatus' Documents: $ref: '#/components/schemas/DataDocsImportStatus' Summary: $ref: '#/components/schemas/DataDocsImportStatus' additionalProperties: false description: "Gets or sets the mapping of each Fenergo.Nebula.ExternalData.ExternalDataCommon.Enums.DataDocs.DataDocsCurrentStageType to its corresponding \nFenergo.Nebula.ExternalData.ExternalDataCommon.Enums.DataDocs.DataDocsImportStatus. This dictionary provides the import status for each stage (if aplicable)\nin the data documentation process." documentsEnabled: type: boolean additionalProperties: false DataDocsCollectorStageBaseDto_2: type: object properties: autoResolved: type: integer description: The number of items resolved automatically. format: int32 manuallyResolved: type: integer description: The number of items resolved manually by a user. format: int32 inError: type: integer description: The number of items that encountered errors. format: int32 total: type: integer description: The total number of items processed. format: int32 detailStatus: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/DataDocsStepStatusDto' description: 'Additional breakdown of items Each key represents a specific item group, and the value is its associated status details.' status: allOf: - $ref: '#/components/schemas/DataDocsStageStatus' description: 'Status of the state. Possible values: See Fenergo.Nebula.ExternalData.ExternalDataCommon.Enums.DataDocs.DataDocsStageStatus.' type: allOf: - $ref: '#/components/schemas/DataDocsCurrentStageType' description: 'State type. Possible values: See Fenergo.Nebula.ExternalData.ExternalDataCommon.Enums.DataDocs.DataDocsCurrentStageType.' additionalProperties: false ComparisonSummaryDto: type: object properties: totalEntitiesMissingInTarget: type: integer format: int32 totalEntitiesMissingInSource: type: integer format: int32 totalEdgesMissingInTarget: type: integer format: int32 totalEdgesMissingInSource: type: integer format: int32 totalAssociationsModified: type: integer format: int32 totalOwnershipDifferences: type: integer format: int32 additionalProperties: false DataDocsSummaryDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DataDocsSummaryDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data RelatedPartyDto: type: object properties: id: type: string description: The unique identifier of the related party. format: uuid providerId: type: string description: The unique identifier of the provider. format: uuid getId: type: string description: The unique identifier of file source provider data format: uuid rootEntity: allOf: - $ref: '#/components/schemas/RootEntityDto' description: Root Legal Entity details returned by the External Data Provider associations: type: - array - 'null' items: $ref: '#/components/schemas/RelatedPartyAssociationDto' description: Collection of associations with other related parties. providerData: type: - object - 'null' additionalProperties: {} description: A dynamic object containing additional data specific to the record type (e.g., "FirstName", "LastName" for individuals). isAiMerged: type: boolean description: Identifies if the related party was merged using AI capabilities isAiMergeSource: type: boolean description: Identifies if the related party was a source for an AI merge operation (i.e. it was merged into another related party) aiMergedSourceList: type: - array - 'null' items: type: string description: Source list additionalProperties: false description: Represents an individual related party record. AdapterResponseErrorDetails: type: object properties: source: type: - string - 'null' description: Source of the error. errorCode: type: - string - 'null' description: Error code specifying type of the error. message: type: - string - 'null' description: Error message additionalProperties: false description: This class contains the error details if ther was an error with adapter request. SearchForDifferencesDtoServiceRequest: required: - data type: object properties: data: allOf: - $ref: '#/components/schemas/SearchForDifferencesDto' description: The service request DTO additionalProperties: false description: Service request data RelatedPartyAssociationDto: type: object properties: parentId: type: - string - 'null' description: The unique identifier of the parent related party. childId: type: - string - 'null' description: The unique identifier of the child related party. ownershipPercentage: type: - number - 'null' description: The ownership percentage of the child related party. format: double associationType: type: - string - 'null' description: The type of association (e.g., "Individual", "Company"). data: description: Additional data associated with the relationship. additionalProperties: false DataDocsSummaryDecisionPathDto: type: object properties: autoResolved: type: integer description: The number of items resolved automatically. format: int32 manuallyResolved: type: integer description: The number of items resolved manually by users. format: int32 needsReview: type: integer description: The number of items needs reviewed. format: int32 additionalProperties: false DataDocsCollectorSummaryInsightsDto: type: object properties: dataDocsDecisionPath: allOf: - $ref: '#/components/schemas/DataDocsSummaryDecisionPathDto' description: Represents the progression statistics for the Data & Docs Collector Task. dataDocsEnhancedStats: type: - array - 'null' items: $ref: '#/components/schemas/DataDocsSummaryEnhancedStatsDto' description: Contains enhanced statistical metrics and insights for the Data & Docs Collector Task. additionalProperties: false description: Provides summary insights for the Data & Docs Collector Task. RootEntityDto: type: object properties: id: type: - string - 'null' entityType: type: - string - 'null' fullName: type: - string - 'null' data: {} additionalProperties: false PagerDto: type: object properties: size: type: integer description: Size of the page (result set) format: int32 example: 5 from: type: integer description: Position for the search results to start format: int32 example: 0 sortBy: type: - string - 'null' description: Column to sort by example: created sortOrder: allOf: - $ref: '#/components/schemas/SortOrder' description: Sort Order (Ascending or Descending) additionalProperties: false description: Specification of search result page DataDocsImportStatus: enum: - 1 - 2 - 3 - 4 type: integer description: Represents the status of an import operation in the data documentation process. format: int32 DataGroupFieldDto: type: object properties: id: type: - string - 'null' dataGroupId: type: - string - 'null' reviewRequired: type: boolean isOverridden: type: boolean isAiAssisted: type: boolean isAiResolved: type: boolean aiSummary: allOf: - $ref: '#/components/schemas/AiSummaryDto' data: type: - array - 'null' items: type: object additionalProperties: type: string additionalProperties: false SortOrder: enum: - 0 - 1 type: integer description: Sort Order (Ascending or Descending) format: int32 HierarchyInsightsDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/HierarchyInsightsDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data InsightInfoDto: type: object properties: providerId: type: - string - 'null' entitiesCount: type: integer format: int32 associationsCount: type: integer format: int32 additionalProperties: false AggregatedDocumentsDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AggregatedDocumentsDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data DataDocsCollectorStateDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DataDocsCollectorStateDto_2' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data RelatedPartyGroupDto: type: object properties: groupId: type: string description: The unique identifier of the related party group. format: uuid type: type: - string - 'null' description: The type of the related party group (e.g., "Individual" or "Company"). key: type: - string - 'null' description: A key representing the group (e.g., a combination of name and additional attributes). status: type: - string - 'null' description: The status of the related party record (e.g., "ReviewRequired"). description: type: - string - 'null' description: A brief description providing additional information about the record. aiAssisted: type: boolean description: Indicates whether this record was created or modified with AI assistance. aiMerged: type: boolean description: Indicates if this group contains Ai Merged related party needsReview: type: boolean description: Indicates whether this record needs further review. isOverridden: type: boolean description: Indicates whether this record is changed by user. selectedForImport: type: boolean description: Indicates whether this record is selected for import or rejected linkedLegalEntityId: type: - string - 'null' description: Id of entity for which association was linked defaultProviderId: type: - string - 'null' description: The unique identifier of the default provider for the related party records in this group. importData: allOf: - $ref: '#/components/schemas/ImportDataDto' description: Data needed for future import to FenX potentialDuplicates: type: - array - 'null' items: $ref: '#/components/schemas/PotentialDuplicateDto' description: A collection of potential duplicate records found in the system. parties: type: - array - 'null' items: $ref: '#/components/schemas/RelatedPartyDto' description: A collection of individual related party records within the group. aiAssistanceDate: type: string description: Gets or sets the date and time when AI assistance was provided. format: date-time keyIdentifier: type: - array - 'null' items: type: string description: Gets or sets an array of key identifiers associated with the entity. aiSummary: type: - string - 'null' description: Gets or sets a summary generated by the AI. aiReasoning: type: - array - 'null' items: type: string description: Gets or sets the reasoning steps or explanations generated by the AI. groupKey: allOf: - $ref: '#/components/schemas/GroupKeyDto' description: Gets or sets the structured group key used for grouping related parties. additionalProperties: false description: Represents a single related party group. DataDocsStepStatusDto: type: object properties: autoResolved: type: integer description: The number of items resolved automatically. format: int32 manuallyResolved: type: integer description: The number of items resolved manually by a user. format: int32 inError: type: integer description: The number of items that encountered errors. format: int32 total: type: integer description: The total number of items processed. format: int32 detailStatus: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/DataDocsStepStatusDto' description: 'Additional breakdown of items Each key represents a specific item group, and the value is its associated status details.' additionalProperties: false description: Represents the status breakdown of data documentation process. PotentialDuplicateDto: type: object properties: id: type: - string - 'null' description: The unique identifier of the potential duplicate record. type: type: - string - 'null' description: Type of entity matchScore: type: number format: double matchType: type: - string - 'null' properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' description: Deduplication Search result values additionalProperties: false description: Represents a potential duplicate record. DataDocsEntityDetailFieldsDto: type: object properties: singleDataFields: type: - array - 'null' items: $ref: '#/components/schemas/SingleDataFieldDto' description: List of single data fields dataGroupFields: type: - array - 'null' items: $ref: '#/components/schemas/DataGroupFieldDto' description: List of datagroups fields additionalProperties: false DataDocsSummarisationDto: type: object properties: GlobalSummary: type: - string - 'null' CompletionDateTime: type: - string - 'null' format: date-time additionalProperties: false ComparisonDifferenceDto: type: object properties: type: type: - string - 'null' groupId: type: - string - 'null' description: type: - string - 'null' entityName: type: - string - 'null' sourcePercentage: type: - number - 'null' format: double targetPercentage: type: - number - 'null' format: double level: type: - integer - 'null' format: int32 additionalProperties: false ComparisonDifferenceDtoPagedListDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ComparisonDifferenceDtoPagedListDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data DataDocsEntityDetailFieldsDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/DataDocsEntityDetailFieldsDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data GroupKeyDto: type: object properties: entityType: type: - string - 'null' firstName: type: - string - 'null' lastName: type: - string - 'null' legalEntityName: type: - string - 'null' countryOfIncorporation: type: - string - 'null' additionalProperties: false description: DTO representing the structured group key used for grouping related parties. AiSummaryDto: type: object properties: totalGroups: type: integer format: int32 duplicateGroups: type: integer format: int32 uniqueGroups: type: integer format: int32 overview: type: - string - 'null' assistanceDateTime: type: string format: date-time keyIdentifier: type: - array - 'null' items: type: string reasoning: type: - array - 'null' items: type: string additionalProperties: false DataDocsRelatedPartiesDetailsDto: type: object properties: groups: type: - array - 'null' items: $ref: '#/components/schemas/RelatedPartyGroupDto' description: A collection of related party groups. additionalProperties: false ImportDataDto: type: object properties: getId: type: string description: The unique identifier of file source provider data format: uuid sourceProviderId: type: - string - 'null' description: The source provider of the related party record (e.g., "c87ba96a-0c3f-4c3c-8ae9-0154ec4161b0"). selectedForImportId: type: - string - 'null' description: Id of related party selected for import from PotentialDuplicates or Parties isDuplicated: type: boolean description: think if this flag is needed - used to indicate if record is selected from 'Potential Duplicates' list additionalProperties: false StringListServiceResponse: type: object properties: data: type: - array - 'null' items: type: string description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-externaldatacommand-v1-0-openapi.json - fenergo-externaldataquery-v1-0-openapi.json