{
"openapi": "3.0.4",
"info": {
"title": "Fenergo Nebula External Data Query",
"description": "**External Data Query API**:\n\n
External Data Query API allows to retrieve information of external data providers and their configuration.\n\n
**External Data Query API provides**:
- The ability to get provider configuration.
- The ability to get signed url for documents.
- The ability to get imported data.
- The ability to get mapping configuration of the provider.
- The ability to get subscriptions for ongoing monitoring.
- The ability to get external data search results.",
"version": "1.0"
},
"servers": [
{
"url": "/externaldataquery"
}
],
"paths": {
"/api/aggregation/{taskId}": {
"get": {
"tags": [
"Aggregation"
],
"summary": "Get aggregated company data by import request id",
"description": "\nThis method will return aggregated company data for given import request id
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "GetAggregatedDataByTaskId",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The ID of journey task",
"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"
}
],
"responses": {
"200": {
"description": "Instance of Fenergo.Nebula.ExternalData.Query.Application.Dto.DataAggregationResultDto class containing company data of aggregated entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataAggregationResultDtoServiceResponse"
}
}
}
},
"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 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"
}
]
}
}
}
}
}
}
},
"/api/providersconfiguration": {
"get": {
"tags": [
"Providers Configuration"
],
"summary": "Get External Data Providers Configuration",
"description": "\nGet base configuration details of external data providers.\n It returns configuration for global providers and custom providers.
Required permissions:
At least one of the following permissions is required: ExternalDataConfiguratorAccess, ExternalDataAccess
Required permissions:
At least one of the following permissions is required: ExternalDataConfiguratorAccess, ExternalDataAccess",
"operationId": "GetConfigurationV2",
"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": "Instance of Fenergo.Nebula.ExternalData.Query.Application.Dto.Configuration.v2.ConfigurationDtoV2 class containing configuration information.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ConfigurationDtoV2ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationDtoV2ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationDtoV2ServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/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/providersconfiguration/provider/{providerId}": {
"get": {
"tags": [
"Providers Configuration"
],
"summary": "Get External Data provider configuration",
"description": "\nThis method returns specific External Data provider details.
Required permissions:
At least one of the following permissions is required: ExternalDataConfiguratorAccess, ExternalDataAccess
Required permissions:
At least one of the following permissions is required: ExternalDataConfiguratorAccess, ExternalDataAccess",
"operationId": "GetProviderConfigurationV2",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "The ID of provider",
"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.Configuration.v2.ProviderConfigurationDtoV2 class containing provider configuration information.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProviderConfigurationDtoV2ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderConfigurationDtoV2ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProviderConfigurationDtoV2ServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "There is no provider with given id",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/providersconfiguration/customProvider/{providerId}": {
"get": {
"tags": [
"Providers Configuration"
],
"summary": "Get custom provider configuration",
"description": "\nThis method returns specific custom External Data provider
Required permissions:
Following permissions are required: ExternalDataConfiguratorAccess
Required permissions:
Following permissions are required: ExternalDataConfiguratorAccess",
"operationId": "GetCustomProviderConfigurationV2",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "The ID of provider",
"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.Configuration.v2.CustomProviderConfigurationDtoV2 class containing custom provider configuration information.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CustomProviderConfigurationDtoV2ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomProviderConfigurationDtoV2ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CustomProviderConfigurationDtoV2ServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "There is no provider with given id",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/providersconfiguration/flowProvider/{providerId}": {
"get": {
"tags": [
"Providers Configuration"
],
"summary": "Get flow provider configuration",
"description": "\nThis method returns specific flow External Data provider
Required permissions:
Following permissions are required: ExternalDataConfiguratorAccess
Required permissions:
Following permissions are required: ExternalDataConfiguratorAccess",
"operationId": "GetFlowProvider",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "The ID of provider",
"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.FlowProviderConfigurationDto class containing custom provider configuration information.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/FlowProviderConfigurationDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowProviderConfigurationDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FlowProviderConfigurationDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "There is no provider with given id",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/providersconfiguration/adapterschema/{providerId}": {
"get": {
"tags": [
"Providers Configuration"
],
"summary": "Get Adapter Schema for provider",
"description": "\nThis method returns Adapter Schema for given External Data provider
Required permissions:
Following permissions are required: ExternalDataConfiguratorAccess
Required permissions:
Following permissions are required: ExternalDataConfiguratorAccess",
"operationId": "GetAdapterSchema",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "The ID of provider",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "entityType",
"in": "query",
"description": "Entity type for schema",
"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"
}
],
"responses": {
"200": {
"description": "Instance of Fenergo.Nebula.ExternalData.Query.Application.Dto.Configuration.v2.AdapterSchemaDto class containing Adapter Schema for provider.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "There is no schema id defined for given provider",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/datadocs/getAggregateResults/{journeyId}/{taskId}": {
"get": {
"tags": [
"Data & Docs Collection"
],
"summary": "Get aggregated company data by task id",
"description": "\nThis 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"
}
]
}
}
}
}
}
}
},
"/api/datadocs/DataDocs/{journeyId}/{taskId}": {
"get": {
"tags": [
"Data & Docs Collection"
],
"summary": "Get Data&Doc collection Task State by task id",
"description": "\nThis 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"
}
]
}
}
}
}
}
}
},
"/api/datadocs/relatedParties/{journeyId}/{taskId}": {
"get": {
"tags": [
"Data & Docs Collection"
],
"summary": "Get Related Parties Details by Task Id",
"description": "\nThis 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"
}
]
}
}
}
}
}
}
},
"/api/datadocs/aggregatedDocuments/{journeyId}/{taskId}": {
"get": {
"tags": [
"Data & Docs Collection"
],
"summary": "Get Documents by Task Id and Journey Id",
"description": "\nThis 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"
}
]
}
}
}
}
}
}
},
"/api/datadocs/Insights/{journeyId}/{taskId}": {
"get": {
"tags": [
"Data & Docs Collection"
],
"summary": "Get Data&Doc Collection Summary Insights",
"description": "\nThis 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"
}
]
}
}
}
}
}
}
},
"/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"
}
]
}
}
}
}
}
}
},
"/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"
}
]
}
}
}
}
}
}
},
"/api/datadocs/hierarchyDifferences": {
"post": {
"tags": [
"Data & Docs Collection"
],
"summary": "Returns a paged list of hierarchy comparison differences for a given journey and task,\noptionally filtered by difference type",
"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"
}
]
}
}
}
}
}
}
},
"/api/datadocs/Summarisation/{journeyId}/{taskId}": {
"get": {
"tags": [
"Data & Docs Collection"
],
"summary": "Get Data Docs Summarisation by Task Id",
"description": "\nThis method returns the current Data Docs summarisation state for the given task.\n\nThe 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"
}
]
}
}
}
}
}
}
},
"/api/document/signedurl/{fileName}": {
"get": {
"tags": [
"Document"
],
"summary": "Method to get a signed URL from S3",
"description": "\nThis method will generate a URL that will allow the user to open the document in the browser.\n\nThe URL is signed by the AWS S3 service and the token will expire in a short time.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"parameters": [
{
"name": "fileName",
"in": "path",
"description": "Name of document",
"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"
}
],
"responses": {
"200": {
"description": "An url to access the file uploaded for the document with the specified \n fileName, if found; otherwise, `null`.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
}
}
}
},
"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. If no signed url is found",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/import/{id}": {
"get": {
"tags": [
"Import"
],
"summary": "Get imported company data by import request id",
"description": "\nThis method will return imported company data for given import request id
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "GetImportedDataById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of import request",
"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"
}
],
"responses": {
"200": {
"description": "Instance of Fenergo.Nebula.ExternalData.Query.Application.Dto.ImportedDataDto class containing company data of imported entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportedDataDtoServiceResponse"
}
}
}
},
"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 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"
}
]
}
}
}
}
}
}
},
"/api/import/journey/{journeyId}/externalId/{externalId}": {
"get": {
"tags": [
"Import"
],
"summary": "Get imported company data by journey id and external id",
"description": "\nThis method will return imported company data for given Journey ID and External ID
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "GetImportedDataByJourneyIdAndExternalId",
"parameters": [
{
"name": "journeyId",
"in": "path",
"description": "Journey ID from which the request originated from",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "externalId",
"in": "path",
"description": "ID of entity in External Data system",
"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"
}
],
"responses": {
"200": {
"description": "Instance of Fenergo.Nebula.ExternalData.Query.Application.Dto.ImportedDataDto class containing company data of imported entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportedDataDtoServiceResponse"
}
}
}
},
"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"
}
]
}
}
}
}
}
}
},
"/api/import/journey/{journeyId}/latestImport": {
"get": {
"tags": [
"Import"
],
"summary": "Get external id of last saved import by journey id",
"description": "\nThis method will return External ID of last saved import for given Journey ID
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "GetImportIdentifierOfLastSavedImportByJourneyId",
"parameters": [
{
"name": "journeyId",
"in": "path",
"description": "Journey ID from which the request originated from",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fromInternalProviders",
"in": "query",
"description": "If true, then returns data from internal providers only. If false, returns data from external providers only.",
"schema": {
"type": "boolean"
}
},
{
"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.ImportIdentifierDto class containing External ID of last saved import",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportIdentifierDtoServiceResponse"
}
}
}
},
"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": "External Id of last saved import for given Journey 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"
}
]
}
}
}
}
}
}
},
"/api/mapping/provider/{providerId}": {
"get": {
"tags": [
"Mapping"
],
"summary": "Get provider mapping",
"description": "\nThis method will return provider mappings for specific tenant
Required permissions:
At least one of the following permissions is required: ExternalDataMapperAccess, ExternalDataAccess
Required permissions:
At least one of the following permissions is required: ExternalDataMapperAccess, ExternalDataAccess",
"operationId": "GetProviderMapping",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "The ID of provider",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "entityType",
"in": "query",
"description": "Entity type for schema",
"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"
}
],
"responses": {
"200": {
"description": "Instance of Fenergo.Nebula.ExternalData.Query.Application.Dto.Mapping.ProviderMappingDto class containing mapping for provider",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderMappingDtoServiceResponse"
}
}
}
},
"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": "Mapping for given tenant 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"
}
]
}
}
}
}
}
}
},
"/api/mapping/configuration": {
"get": {
"tags": [
"Mapping"
],
"summary": "Get mapping configuration",
"description": "\nThis method will return mapping configuration
Required permissions:
Following permissions are required: ExternalDataMapperAccess
Required permissions:
Following permissions are required: ExternalDataMapperAccess",
"operationId": "GetMappingConfiguration",
"parameters": [
{
"name": "entityType",
"in": "query",
"description": "Entity type for schema",
"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"
}
],
"responses": {
"200": {
"description": "Instance of Fenergo.Nebula.ExternalData.Query.Application.Dto.Mapping.MappingConfigurationDto class containing mapping configuration",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MappingConfigurationDtoServiceResponse"
}
}
}
},
"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/ongoingmonitoring/subscriptions/entity/{entityId}": {
"get": {
"tags": [
"OngoingMonitoring"
],
"summary": "Get all ongoing monitoring subscriptions for an entity",
"description": "\nThis method returns all ongoing monitoring subscriptions for given entity.
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "GetSubscriptionsByEntityId",
"parameters": [
{
"name": "entityId",
"in": "path",
"description": "The entity id to get the subscriptions for",
"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"
}
],
"responses": {
"200": {
"description": "Success. Subscriptions retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OngoingMonitoringSubscriptionDtoICollectionServiceResponse"
}
}
}
},
"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/search/{id}": {
"get": {
"tags": [
"Search"
],
"summary": "Get search results by search request id",
"description": "\nThis method will return search results by given search request ID
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "GetSearchResultsById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of search request",
"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"
}
],
"responses": {
"200": {
"description": "Fenergo.Nebula.ExternalData.Query.Application.Dto.SearchResultsDto class containing search results",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResultsDtoServiceResponse"
}
}
}
},
"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": "Search Results for given Search Request 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"
}
]
}
}
}
}
}
}
},
"/api/search/journey/{journeyId}": {
"get": {
"tags": [
"Search"
],
"summary": "Get search results by journey id",
"description": "\nThis method will return last search results by given Journey Id
Required permissions:
Following permissions are required: ExternalDataAccess
Required permissions:
Following permissions are required: ExternalDataAccess",
"operationId": "GetSearchResultsByJourneyId",
"parameters": [
{
"name": "journeyId",
"in": "path",
"description": "Journey ID from which the request originated from",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fromInternalProviders",
"in": "query",
"description": "If true, then returns data from internal providers only. If false, returns data from external providers only.",
"schema": {
"type": "boolean"
}
},
{
"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.SearchResultsDto class containing search results",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResultsDtoServiceResponse"
}
}
}
},
"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": "Search Results for given Journey 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"
}
]
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AccessLayerDto": {
"type": "object",
"properties": {
"geographic": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Geographic Access Layers",
"nullable": true
},
"businessRelated": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Business Related Access Layers",
"nullable": true
}
},
"additionalProperties": false
},
"AdapterResponseErrorDetails": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "Source of the error.",
"nullable": true
},
"errorCode": {
"type": "string",
"description": "Error code specifying type of the error.",
"nullable": true
},
"message": {
"type": "string",
"description": "Error message",
"nullable": true
}
},
"additionalProperties": false,
"description": "This class contains the error details if ther was an error with adapter request."
},
"AdapterSchemaDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"lookups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupDto"
},
"nullable": true
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"AdapterSchemaDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/AdapterSchemaDto"
}
],
"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"
},
"AggregatedDocumentDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Document Id",
"nullable": true
},
"name": {
"type": "string",
"description": "Document Name",
"nullable": true
},
"date": {
"type": "string",
"description": "Document Date",
"format": "date-time",
"nullable": true
},
"providerId": {
"type": "string",
"description": "Provider Id",
"nullable": true
},
"recordId": {
"type": "string",
"description": "Record id of the document containing document information this value is used for ordering of the document.",
"nullable": true
},
"providerData": {
"description": "Provider Specific data",
"nullable": true
},
"documentType": {
"type": "string",
"description": "Document Type",
"nullable": true,
"example": "Account Opening Form"
},
"documentStatus": {
"type": "string",
"description": "Document Status",
"nullable": true,
"example": "Requested"
},
"fileLocation": {
"type": "string",
"description": "File Location in the Doc Storage",
"nullable": true,
"example": "//path/file"
},
"linkExpirationDate": {
"type": "string",
"description": "Link expiration date",
"format": "date-time",
"nullable": true,
"example": "2021-01-01T14:48:00.000Z"
},
"accessLayers": {
"allOf": [
{
"$ref": "#/components/schemas/AccessLayerDto"
}
],
"description": "Access Layer information for the document",
"nullable": true
},
"errorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AdapterResponseErrorDetails"
}
],
"description": "Detailed error message",
"nullable": true
}
},
"additionalProperties": false
},
"AggregatedDocumentsDto": {
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AggregatedDocumentDto"
},
"description": "List of available and downloaded documents from the External Data Provider",
"nullable": true
}
},
"additionalProperties": false
},
"AggregatedDocumentsDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/AggregatedDocumentsDto"
}
],
"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"
},
"AiSummaryDto": {
"type": "object",
"properties": {
"totalGroups": {
"type": "integer",
"format": "int32"
},
"duplicateGroups": {
"type": "integer",
"format": "int32"
},
"uniqueGroups": {
"type": "integer",
"format": "int32"
},
"overview": {
"type": "string",
"nullable": true
},
"assistanceDateTime": {
"type": "string",
"format": "date-time"
},
"keyIdentifier": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"reasoning": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"AssociatedPartyDeduplicationDto": {
"type": "object",
"properties": {
"providerId": {
"type": "string",
"description": "ID of the added External Data Provider",
"nullable": true,
"example": "f47b539d-ffb8-4cf2-bf68-1af79e3b0040"
},
"externalId": {
"type": "string",
"description": "Id of the entity in External Data system",
"nullable": true,
"example": "PL610188202"
},
"deduplicationState": {
"enum": [
"Rejected",
"NewEntity",
"ReviewMatches",
"DismissAllMatches",
"LinkedToExisting"
],
"type": "string",
"description": "Deduplication state of Association.",
"nullable": true,
"example": "LinkedToExisting"
},
"linkedLegalEntityId": {
"type": "string",
"description": "Id of Entity, to which Association is linked",
"nullable": true,
"example": "dc443c9f-55f3-4c7e-aa11-3d7ef472c49a"
},
"deduplicationRejectMethod": {
"enum": [
"Manual",
"Auto",
"InvalidAssociation"
],
"type": "string",
"description": "Information, how Association was rejected.",
"nullable": true,
"example": "Auto"
},
"duplicateSearchResults": {
"type": "array",
"items": { },
"description": "Search result values",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent deduplication state of Association"
},
"ComparisonDifferenceDto": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"groupId": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"entityName": {
"type": "string",
"nullable": true
},
"sourcePercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"targetPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"level": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"ComparisonDifferenceDtoPagedListDto": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComparisonDifferenceDto"
},
"description": "List of items returned by the query",
"nullable": true
},
"total": {
"type": "integer",
"description": "Number of total items matched by the query",
"format": "int64"
}
},
"additionalProperties": false
},
"ComparisonDifferenceDtoPagedListDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ComparisonDifferenceDtoPagedListDto"
}
],
"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"
},
"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
},
"Condition": {
"type": "object",
"properties": {
"operator": {
"allOf": [
{
"$ref": "#/components/schemas/ConditionOperator"
}
]
},
"value": {
"nullable": true
}
},
"additionalProperties": false
},
"ConditionOperator": {
"enum": [
"LT",
"GT",
"LE",
"GE",
"EQ",
"NE"
],
"type": "string"
},
"ConfigurationDtoV2": {
"type": "object",
"properties": {
"providersConfiguration": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderConfigurationLiteDtoV2"
},
"description": "List of External Data Providers base configuration.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent the configuration of External Data Providers."
},
"ConfigurationDtoV2ServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigurationDtoV2"
}
],
"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"
},
"CustomProviderConfigurationDtoV2": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the External Data Provider.",
"format": "uuid",
"example": "d046f87e-2f26-41d4-833a-ed57fb897ee6"
},
"configurationVersion": {
"type": "integer",
"description": "Configuration Version.",
"format": "int32",
"example": 1
},
"name": {
"type": "string",
"description": "Name of the External Data Provider.",
"nullable": true,
"example": "Kompany"
},
"configurationStatus": {
"enum": [
"Verified",
"Verification Failed",
"Not Verified",
"Testing"
],
"type": "string",
"description": "Status of the External Data Provider.",
"nullable": true,
"example": "Verified"
},
"mappingStatus": {
"enum": [
"Present",
"Invalid",
"Not Present",
"Incomplete"
],
"type": "string",
"description": "Status of the mapping associated with specific External Data Provider.",
"nullable": true,
"example": "Present"
},
"schemaStatus": {
"enum": [
"Valid",
"Invalid",
"Not Present"
],
"type": "string",
"description": "Status of the adapter schema associated with specific External Data Provider.",
"nullable": true,
"example": "Valid"
},
"enabled": {
"type": "boolean",
"description": "Defines if the External Data Provider is enabled or not.",
"example": true
},
"isCustom": {
"type": "boolean",
"description": "Defines if the External Data Provider is built-in and created by Fenergo, or if it's custom provider.",
"example": true
},
"providerType": {
"type": "string",
"description": "Defines the External Data Provider Type.",
"nullable": true,
"example": "true"
},
"schemaId": {
"type": "string",
"description": "Id of Adapter Schema associated with specific External Data Provider.",
"format": "uuid",
"example": "d046f87e-2f26-41d4-833a-ed57fb897ee6"
},
"schemaIndividualId": {
"type": "string",
"description": "Id of Adapter Schema associated with specific External Data Provider, for Individual entity type.",
"format": "uuid",
"example": "d046f87e-2f26-41d4-833a-ed57fb897ee6"
},
"schemas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderSchemaDto"
},
"description": "Adapter Schema",
"nullable": true
},
"skipPolicyValidation": {
"type": "boolean",
"description": "Defines if the validations related to policy mapping will run for this External Data Provider.",
"example": false
},
"documentSupport": {
"type": "boolean",
"description": "Defines if specific External Data Provider is configured to allow requesting and getting documents.",
"example": false
},
"ongoingMonitoringSupport": {
"type": "boolean",
"description": "Defines if specific External Data Provider is configured to allow ongoing monitoring of the entities.",
"example": false
},
"supportedEntityType": {
"type": "array",
"items": {
"type": "string"
},
"description": "Defines list of available entity type mapping. In Config for custom ignore/return all",
"nullable": true
},
"enabledEntityType": {
"type": "array",
"items": {
"type": "string"
},
"description": "Defines list of available entity type mapping. In DB",
"nullable": true
},
"internal": {
"type": "boolean",
"description": "Defines if the External Data Provider is internal, FenX specific.",
"example": false
},
"ongoingMonitoringSchema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SchemaEntryV2"
},
"description": "Defines the schema for ongoing monitoring support to map the data to the correct fields.",
"nullable": true
},
"url": {
"type": "string",
"description": "Base url of the external data adapter which will be used to make the requests.",
"nullable": true,
"example": "https://api.fenergox.com/externaldatamock"
},
"authenticationKey": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityKeyDto"
}
],
"description": "Authentication key that allows the external data adapter to authenticate the requests.",
"nullable": true
},
"encryptionKey": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityKeyDto"
}
],
"description": "Encryption key to authenticate the requests.",
"nullable": true
},
"errors": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorsDto"
}
],
"description": "Collection of the errors associated with external data provider.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent a single custom External Data Provider configuration."
},
"CustomProviderConfigurationDtoV2ServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CustomProviderConfigurationDtoV2"
}
],
"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"
},
"DataAggregationFieldValueWithSource": {
"type": "object",
"properties": {
"value": {
"type": "string",
"nullable": true
},
"sourceProviderId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DataAggregationResultDto": {
"type": "object",
"properties": {
"profilesIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "List of profiles ids for aggregation import",
"nullable": true
},
"aggregatedFields": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/DataAggregationFieldValueWithSource"
},
"description": "List of fields",
"nullable": true
},
"aggregatedDataGroups": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/DataAggregationFieldValueWithSource"
}
},
"nullable": true
},
"description": "List of data groups",
"nullable": true
}
},
"additionalProperties": false
},
"DataAggregationResultDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DataAggregationResultDto"
}
],
"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"
},
"DataDocsCollectorStageBaseDto": {
"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",
"additionalProperties": {
"$ref": "#/components/schemas/DataDocsStepStatusDto"
},
"description": "Additional breakdown of items\nEach key represents a specific item group, and the value is its associated status details.",
"nullable": true
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsStageStatus"
}
],
"description": "Status of the state.\nPossible values: See Fenergo.Nebula.ExternalData.ExternalDataCommon.Enums.DataDocs.DataDocsStageStatus."
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsCurrentStageType"
}
],
"description": "State type.\nPossible values: See Fenergo.Nebula.ExternalData.ExternalDataCommon.Enums.DataDocs.DataDocsCurrentStageType."
}
},
"additionalProperties": false
},
"DataDocsCollectorStateDto": {
"type": "object",
"properties": {
"baseStagesInit": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataDocsCollectorStageBaseDto"
},
"description": "State of the DataDocs task",
"nullable": true
},
"currentStageType": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsCurrentStageType"
}
],
"description": "Current stage of the DataDocs task"
},
"importStatuses": {
"type": "object",
"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.",
"nullable": true
},
"documentsEnabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DataDocsCollectorStateDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsCollectorStateDto"
}
],
"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"
},
"DataDocsCollectorSummaryInsightsDto": {
"type": "object",
"properties": {
"dataDocsDecisionPath": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsSummaryDecisionPathDto"
}
],
"description": "Represents the progression statistics for the Data & Docs Collector Task.",
"nullable": true
},
"dataDocsEnhancedStats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataDocsSummaryEnhancedStatsDto"
},
"description": "Contains enhanced statistical metrics and insights for the Data & Docs Collector Task.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Provides summary insights for the Data & Docs Collector Task."
},
"DataDocsCollectorSummaryInsightsDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsCollectorSummaryInsightsDto"
}
],
"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"
},
"DataDocsCurrentStageType": {
"enum": [
1,
2,
3,
4,
5
],
"type": "integer",
"description": "Represents the stage type in the data docs .",
"format": "int32"
},
"DataDocsEntityDetailFieldsDto": {
"type": "object",
"properties": {
"singleDataFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SingleDataFieldDto"
},
"description": "List of single data fields",
"nullable": true
},
"dataGroupFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataGroupFieldDto"
},
"description": "List of datagroups fields",
"nullable": true
}
},
"additionalProperties": false
},
"DataDocsEntityDetailFieldsDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsEntityDetailFieldsDto"
}
],
"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"
},
"DataDocsImportStatus": {
"enum": [
1,
2,
3,
4
],
"type": "integer",
"description": "Represents the status of an import operation in the data documentation process.",
"format": "int32"
},
"DataDocsRelatedPartiesDetailsDto": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartyGroupDto"
},
"description": "A collection of related party groups.",
"nullable": true
}
},
"additionalProperties": false
},
"DataDocsRelatedPartiesDetailsDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsRelatedPartiesDetailsDto"
}
],
"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"
},
"DataDocsStageStatus": {
"enum": [
1,
2,
3,
4
],
"type": "integer",
"description": "Represents the processing status of a data document stage.",
"format": "int32"
},
"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",
"additionalProperties": {
"$ref": "#/components/schemas/DataDocsStepStatusDto"
},
"description": "Additional breakdown of items\nEach key represents a specific item group, and the value is its associated status details.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents the status breakdown of data documentation process."
},
"DataDocsSummarisationDto": {
"type": "object",
"properties": {
"GlobalSummary": {
"type": "string",
"nullable": true
},
"CompletionDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"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
},
"DataDocsSummaryDto": {
"type": "object",
"properties": {
"aiEnabled": {
"type": "boolean",
"description": "Indicates whether AI is enabled in the current agent configuration.\nWhen `false`, no agent summary will be generated for the task."
},
"status": {
"type": "string",
"description": "The current summarisation progress stage for the task.\nExpected values include `CollectingData`, `RunningLLM`, and `Completed`.",
"nullable": true
},
"summary": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsSummarisationDto"
}
],
"description": "The AI-generated summary content.\nOnly populated when Fenergo.Nebula.ExternalData.Query.Application.Dto.DataSourcingAgent.Summarisation.DataDocsSummaryDto.Status is `Completed`; otherwise this value is `null`.",
"nullable": true
},
"failureMessage": {
"type": "string",
"description": "A user-facing failure reason for failed summarisation runs.\nOnly populated when Fenergo.Nebula.ExternalData.Query.Application.Dto.DataSourcingAgent.Summarisation.DataDocsSummaryDto.Status is `Failed`.",
"nullable": true
}
},
"additionalProperties": false
},
"DataDocsSummaryDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DataDocsSummaryDto"
}
],
"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"
},
"DataDocsSummaryEnhancedStatsDto": {
"type": "object",
"properties": {
"enhancedStatType": {
"type": "string",
"description": "The type of the enhanced statistic (e.g., FieldsUpdated, DocumentsSourced).",
"nullable": true
},
"value": {
"type": "string",
"description": "The value or count associated with the statistic.",
"nullable": true
},
"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",
"items": {
"type": "string"
},
"description": "List of provider IDs associated with the statistic.",
"nullable": true
}
},
"additionalProperties": false
},
"DataGroupFieldDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"dataGroupId": {
"type": "string",
"nullable": true
},
"reviewRequired": {
"type": "boolean"
},
"isOverridden": {
"type": "boolean"
},
"isAiAssisted": {
"type": "boolean"
},
"isAiResolved": {
"type": "boolean"
},
"aiSummary": {
"allOf": [
{
"$ref": "#/components/schemas/AiSummaryDto"
}
],
"nullable": true
},
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"nullable": true
}
},
"additionalProperties": false
},
"Dependency": {
"type": "object",
"properties": {
"dependentOn": {
"type": "string",
"nullable": true
},
"condition": {
"allOf": [
{
"$ref": "#/components/schemas/Condition"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"DocumentResultsDto": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"description": "Document Id",
"nullable": true,
"example": "d046f87e-2f26-41d4-833a-ed57fb897ee6"
},
"documentName": {
"type": "string",
"description": "Document Name",
"nullable": true,
"example": "Register Report"
},
"documentType": {
"type": "string",
"description": "Document Type",
"nullable": true,
"example": "Account Opening Form"
},
"accessLayers": {
"allOf": [
{
"$ref": "#/components/schemas/AccessLayerDto"
}
],
"description": "Document Access Layers",
"nullable": true
},
"documentStatus": {
"type": "string",
"description": "Document Status",
"nullable": true,
"example": "Requested"
},
"fileLocation": {
"type": "string",
"description": "File Location in the Doc Storage",
"nullable": true,
"example": "//path/file"
},
"linkExpirationDate": {
"type": "string",
"description": "Link expiration date",
"format": "date-time",
"nullable": true,
"example": "2021-01-01T14:48:00.000Z"
},
"errorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AdapterResponseErrorDetails"
}
],
"description": "Detailed error message",
"nullable": true
}
},
"additionalProperties": false
},
"EntityProfileDataDto": {
"type": "object",
"properties": {
"rootEntity": {
"allOf": [
{
"$ref": "#/components/schemas/RootEntityDto"
}
],
"description": "Root Legal Entity details returned by the External Data Provider",
"nullable": true
},
"relatedEntities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedEntityDto"
},
"description": "List of Associated Parties returned by the External Data Provider.\nNull when Fenergo.Nebula.ExternalData.Query.Application.Dto.EntityProfileDataDto.RelatedEntitiesUrl is set (payload too large to inline).",
"nullable": true
},
"relatedEntitiesUrl": {
"type": "string",
"description": "Pre-signed S3 URL to download the full related entities list when the payload exceeds\nthe inline size limit. The URL is valid for 1 hour. Null when\nFenergo.Nebula.ExternalData.Query.Application.Dto.EntityProfileDataDto.RelatedEntities is populated.",
"nullable": true
},
"associations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedEntityAssociationDto"
},
"description": "List of Associations returned by the External Data Provider",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedDocumentsDto"
},
"description": "List of Documents returned by the External Data Provider",
"nullable": true
}
},
"additionalProperties": false
},
"ErrorDetailsDto": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "Source from where the error comes from",
"nullable": true,
"example": "Invoker"
},
"errorCode": {
"type": "string",
"description": "Internal error code",
"nullable": true,
"example": "E231"
},
"message": {
"type": "string",
"description": "Error message",
"nullable": true,
"example": "Returned error code 403: Forbidden"
}
},
"additionalProperties": false,
"description": "Details of error that might occur"
},
"ErrorsDto": {
"type": "object",
"properties": {
"configurationError": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorDetailsDto"
}
],
"description": "Details of error that might occur",
"nullable": true
},
"mappingValidationErrors": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"schemaValidationErrors": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"FieldDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"friendlyName": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"isCollection": {
"type": "boolean"
},
"lookup": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"FieldSource": {
"type": "object",
"properties": {
"value": {
"type": "string",
"nullable": true
},
"provider": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"FlowProviderConfigurationDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the External Data Provider.",
"format": "uuid",
"example": "d046f87e-2f26-41d4-833a-ed57fb897ee6"
},
"configurationVersion": {
"type": "integer",
"description": "Configuration Version.",
"format": "int32",
"example": 1
},
"name": {
"type": "string",
"description": "Name of the External Data Provider.",
"nullable": true,
"example": "Kompany"
},
"configurationStatus": {
"enum": [
"Verified",
"Verification Failed",
"Not Verified",
"Testing"
],
"type": "string",
"description": "Status of the External Data Provider.",
"nullable": true,
"example": "Verified"
},
"mappingStatus": {
"enum": [
"Present",
"Invalid",
"Not Present",
"Incomplete"
],
"type": "string",
"description": "Status of the mapping associated with specific External Data Provider.",
"nullable": true,
"example": "Present"
},
"schemaStatus": {
"enum": [
"Valid",
"Invalid",
"Not Present"
],
"type": "string",
"description": "Status of the adapter schema associated with specific External Data Provider.",
"nullable": true,
"example": "Valid"
},
"enabled": {
"type": "boolean",
"description": "Defines if the External Data Provider is enabled or not.",
"example": true
},
"isCustom": {
"type": "boolean",
"description": "Defines if the External Data Provider is built-in and created by Fenergo, or if it's custom provider.",
"example": true
},
"providerType": {
"type": "string",
"description": "Defines the External Data Provider Type.",
"nullable": true,
"example": "true"
},
"schemaId": {
"type": "string",
"description": "Id of Adapter Schema associated with specific External Data Provider.",
"format": "uuid",
"example": "d046f87e-2f26-41d4-833a-ed57fb897ee6"
},
"schemaIndividualId": {
"type": "string",
"description": "Id of Adapter Schema associated with specific External Data Provider, for Individual entity type.",
"format": "uuid",
"example": "d046f87e-2f26-41d4-833a-ed57fb897ee6"
},
"schemas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderSchemaDto"
},
"description": "Adapter Schema",
"nullable": true
},
"skipPolicyValidation": {
"type": "boolean",
"description": "Defines if the validations related to policy mapping will run for this External Data Provider.",
"example": false
},
"documentSupport": {
"type": "boolean",
"description": "Defines if specific External Data Provider is configured to allow requesting and getting documents.",
"example": false
},
"ongoingMonitoringSupport": {
"type": "boolean",
"description": "Defines if specific External Data Provider is configured to allow ongoing monitoring of the entities.",
"example": false
},
"supportedEntityType": {
"type": "array",
"items": {
"type": "string"
},
"description": "Defines list of available entity type mapping. In Config for custom ignore/return all",
"nullable": true
},
"enabledEntityType": {
"type": "array",
"items": {
"type": "string"
},
"description": "Defines list of available entity type mapping. In DB",
"nullable": true
},
"internal": {
"type": "boolean",
"description": "Defines if the External Data Provider is internal, FenX specific.",
"example": false
},
"ongoingMonitoringSchema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SchemaEntryV2"
},
"description": "Defines the schema for ongoing monitoring support to map the data to the correct fields.",
"nullable": true
},
"endpointsConfiguration": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowProviderEndpointConfigurationDto"
},
"description": "Endpoints Configuration of the flow provider.",
"nullable": true
},
"errors": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorsDto"
}
],
"description": "Collection of the errors associated with external data provider.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent a flow External Data Provider configuration."
},
"FlowProviderConfigurationDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/FlowProviderConfigurationDto"
}
],
"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"
},
"FlowProviderEndpointConfigurationDto": {
"type": "object",
"properties": {
"requestType": {
"type": "string",
"description": "Request Type.",
"nullable": true
},
"flowId": {
"type": "string",
"description": "Flow Id or Flow Key.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent a flow External Data Provider endpoint configuration."
},
"GetRequestSchemaDto": {
"type": "object",
"properties": {
"requestData": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaEntryDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"GetResponseSchemaDto": {
"type": "object",
"properties": {
"clientData": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaEntryDto"
}
],
"nullable": true
},
"associatedEntitiesCompanyData": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaEntryDto"
}
],
"nullable": true
},
"associatedEntitiesIndividualData": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaEntryDto"
}
],
"nullable": true
},
"associationsData": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaEntryDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"GroupKeyDto": {
"type": "object",
"properties": {
"entityType": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"legalEntityName": {
"type": "string",
"nullable": true
},
"countryOfIncorporation": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "DTO representing the structured group key used for grouping related parties."
},
"HierarchyInsightsDto": {
"type": "object",
"properties": {
"summary": {
"type": "string",
"nullable": true
},
"sourceProvider": {
"type": "string",
"nullable": true
},
"targetProvider": {
"type": "string",
"nullable": true
},
"comparisonSummary": {
"allOf": [
{
"$ref": "#/components/schemas/ComparisonSummaryDto"
}
],
"nullable": true
},
"providerStatistics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InsightInfoDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"HierarchyInsightsDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/HierarchyInsightsDto"
}
],
"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"
},
"ImportDataDto": {
"type": "object",
"properties": {
"getId": {
"type": "string",
"description": "The unique identifier of file source provider data",
"format": "uuid"
},
"sourceProviderId": {
"type": "string",
"description": "The source provider of the related party record (e.g., \"c87ba96a-0c3f-4c3c-8ae9-0154ec4161b0\").",
"nullable": true
},
"selectedForImportId": {
"type": "string",
"description": "Id of related party selected for import from PotentialDuplicates or Parties",
"nullable": true
},
"isDuplicated": {
"type": "boolean",
"description": "think if this flag is needed - used to indicate if record is selected from 'Potential Duplicates' list"
}
},
"additionalProperties": false
},
"ImportIdentifierDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"description": "Id of the entity in External Data system",
"nullable": true,
"example": "f47b539d-ffb8-4cf2-bf68-1af79e3b0040"
},
"providerId": {
"type": "string",
"description": "ID of the added External Data Provider",
"nullable": true,
"example": "PL610188202"
}
},
"additionalProperties": false,
"description": "Class to represent information about Imported Entity"
},
"ImportIdentifierDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ImportIdentifierDto"
}
],
"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"
},
"ImportedDataDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Import Id",
"nullable": true,
"example": "d046f87e-2f26-41d4-833a-ed57fb897ee6"
},
"journeyId": {
"type": "string",
"description": "JourneyId of the Root Legal Entity",
"nullable": true,
"example": "c0c7b87d-1fc3-4127-b87d-c5b76a13d159"
},
"taskId": {
"type": "string",
"description": "TaskId of the Root Legal Entity",
"nullable": true,
"example": "2c4e5dce-0ac1-4f24-8e21-9b0a4b8070f5"
},
"providerId": {
"type": "string",
"description": "External Data provider Id",
"nullable": true,
"example": "f47b539d-ffb8-4cf2-bf68-1af79e3b0040"
},
"externalId": {
"type": "string",
"description": "ExternalId of the root Legal Entity",
"nullable": true,
"example": "PL610188202"
},
"status": {
"enum": [
"NotStarted",
"InProgress",
"DataReceived",
"DataSaved"
],
"type": "string",
"description": "Status of external data import",
"nullable": true,
"example": "InProgress"
},
"errorMessage": {
"type": "string",
"description": "Message providing details of an unsuccessful request",
"nullable": true,
"example": "response.client property is mandatory but was found null"
},
"validationErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"description": "Validation errors collection",
"nullable": true
},
"documentsSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResultsDto"
},
"description": "List of Requested/Retrieved documents with import status and path",
"nullable": true
},
"ultimateBeneficialOwner": {
"allOf": [
{
"$ref": "#/components/schemas/UltimateBeneficialOwnerResultsDto"
}
],
"description": "UBO Discovery results",
"nullable": true
},
"associatedPartyDeduplicationList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssociatedPartyDeduplicationDto"
},
"description": "List of Deduplication results.\nNull when Fenergo.Nebula.ExternalData.Query.Application.Dto.ImportedDataDto.DeduplicationResultsUrl is set (payload too large to inline).",
"nullable": true
},
"deduplicationResultsUrl": {
"type": "string",
"description": "Pre-signed S3 URL to download the full deduplication results when the payload exceeds\nthe inline size limit. The URL is valid for 1 hour. Null when\nFenergo.Nebula.ExternalData.Query.Application.Dto.ImportedDataDto.AssociatedPartyDeduplicationList is populated.",
"nullable": true
},
"entityProfileData": {
"allOf": [
{
"$ref": "#/components/schemas/EntityProfileDataDto"
}
],
"description": "Entity Profile Data",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent imported data"
},
"ImportedDataDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ImportedDataDto"
}
],
"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"
},
"InsightInfoDto": {
"type": "object",
"properties": {
"providerId": {
"type": "string",
"nullable": true
},
"entitiesCount": {
"type": "integer",
"format": "int32"
},
"associationsCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"LoVArrayMap": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"map": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"LoVMap": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"map": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"LookupDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"LookupValue": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"value": {
"nullable": true
}
},
"additionalProperties": false
},
"Map": {
"type": "object",
"properties": {
"mappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Mapping"
},
"nullable": true
},
"loVMaps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LoVMap"
},
"nullable": true
},
"loVArrayMaps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LoVArrayMap"
},
"nullable": true
}
},
"additionalProperties": false
},
"MapDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Map Name",
"nullable": true,
"example": "Example map"
},
"map": {
"allOf": [
{
"$ref": "#/components/schemas/Map"
}
],
"description": "Map defining source to target fields transformations",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent Source - Target Map"
},
"Mapping": {
"type": "object",
"properties": {
"source": {
"type": "string",
"nullable": true
},
"target": {
"type": "string",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/MappingType"
}
]
},
"loVMapName": {
"type": "string",
"nullable": true
},
"toArray": {
"type": "boolean"
},
"displaySource": {
"type": "boolean"
},
"constantValue": {
"type": "string",
"nullable": true
},
"objectToTextProperties": {
"allOf": [
{
"$ref": "#/components/schemas/ObjectToTextProperties"
}
],
"nullable": true
},
"mappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Mapping"
},
"nullable": true
}
},
"additionalProperties": false
},
"MappingConfigurationDto": {
"type": "object",
"properties": {
"operations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OperationDto"
},
"nullable": true
},
"mappingToolConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/MappingToolConfigurationDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"MappingConfigurationDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/MappingConfigurationDto"
}
],
"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"
},
"MappingIdentifierDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"category": {
"type": "string",
"nullable": true
},
"entityType": {
"type": "string",
"nullable": true
},
"targetEntity": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MappingToolAllowedMappingTypesDto": {
"type": "object",
"properties": {
"sourcePropertyType": {
"type": "string",
"nullable": true
},
"targetPropertyType": {
"type": "string",
"nullable": true
},
"mappingTypes": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"MappingToolConfigurationDto": {
"type": "object",
"properties": {
"types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MappingToolTypesDto"
},
"nullable": true
},
"allowedMappingTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MappingToolAllowedMappingTypesDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"MappingToolTypesDto": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"caption": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MappingType": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"type": "integer",
"format": "int32"
},
"ObjectAssociatedPartyDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"entityType": {
"type": "string",
"nullable": true
},
"fullName": {
"type": "string",
"nullable": true
},
"uboType": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean",
"nullable": true
},
"data": {
"nullable": true
}
},
"additionalProperties": false
},
"ObjectAssociationDto": {
"type": "object",
"properties": {
"parentId": {
"type": "string",
"nullable": true
},
"childId": {
"type": "string",
"nullable": true
},
"ownershipPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"associationType": {
"type": "string",
"nullable": true
},
"data": {
"nullable": true
}
},
"additionalProperties": false
},
"ObjectField": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32"
},
"isLoV": {
"type": "boolean"
},
"loVMapName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ObjectObjectHierarchyDto": {
"type": "object",
"properties": {
"associatedEntities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectAssociatedPartyDto"
},
"nullable": true
},
"associations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectAssociationDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ObjectSelector": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"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"
},
"ObjectToTextProperties": {
"type": "object",
"properties": {
"separator": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectField"
},
"nullable": true
},
"selector": {
"allOf": [
{
"$ref": "#/components/schemas/ObjectSelector"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"OngoingMonitoringSubscriptionDto": {
"type": "object",
"properties": {
"subscriptionId": {
"type": "string",
"description": "Ongoing Monitoring Subscription Id",
"nullable": true,
"example": "Requested"
},
"status": {
"type": "string",
"description": "Ongoing Monitoring Subscription Status",
"nullable": true,
"example": "Requested"
},
"entityId": {
"type": "string",
"description": "Entity Id",
"nullable": true,
"example": "Requested"
},
"providerId": {
"type": "string",
"description": "Provider Id",
"nullable": true,
"example": "Requested"
}
},
"additionalProperties": false,
"description": "Contains information about the ongoing monitoring subscription"
},
"OngoingMonitoringSubscriptionDtoICollectionServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OngoingMonitoringSubscriptionDto"
},
"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"
},
"OperationDto": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"nullable": true
},
"operationType": {
"type": "string",
"nullable": true
},
"mappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MappingIdentifierDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"OperationMappingDto": {
"type": "object",
"properties": {
"operation": {
"enum": [
"Search",
"Get"
],
"type": "string",
"description": "Operation for which mapping is defined.",
"nullable": true,
"example": "Search"
},
"operationType": {
"enum": [
"Request",
"Response"
],
"type": "string",
"description": "Operation Type where mapping will be applied.",
"nullable": true,
"example": "Request"
},
"maps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MapDto"
},
"description": "Set of Maps",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent mapping for single operation"
},
"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",
"description": "Column to sort by",
"nullable": true,
"example": "created"
},
"sortOrder": {
"allOf": [
{
"$ref": "#/components/schemas/SortOrder"
}
],
"description": "Sort Order (Ascending or Descending)"
}
},
"additionalProperties": false,
"description": "Specification of search result page"
},
"PotentialDuplicateDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the potential duplicate record.",
"nullable": true
},
"type": {
"type": "string",
"description": "Type of entity",
"nullable": true
},
"matchScore": {
"type": "number",
"format": "double"
},
"matchType": {
"type": "string",
"nullable": true
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"description": "Deduplication Search result values",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a potential duplicate record."
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"PropertyDto": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Value of the property",
"nullable": true,
"example": "Example value"
},
"type": {
"type": "string",
"description": "Type of property",
"nullable": true,
"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",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"description": "Dictionary of properties",
"nullable": true
}
},
"additionalProperties": false,
"description": "Abstraction that represents properties"
},
"ProviderConfigurationDtoV2": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the External Data Provider.",
"format": "uuid",
"example": "d046f87e-2f26-41d4-833a-ed57fb897ee6"
},
"configurationVersion": {
"type": "integer",
"description": "Configuration Version.",
"format": "int32",
"example": 1
},
"name": {
"type": "string",
"description": "Name of the External Data Provider.",
"nullable": true,
"example": "Kompany"
},
"configurationStatus": {
"enum": [
"Verified",
"Verification Failed",
"Not Verified",
"Testing"
],
"type": "string",
"description": "Status of the External Data Provider.",
"nullable": true,
"example": "Verified"
},
"mappingStatus": {
"enum": [
"Present",
"Invalid",
"Not Present",
"Incomplete"
],
"type": "string",
"description": "Status of the mapping associated with specific External Data Provider.",
"nullable": true,
"example": "Present"
},
"schemaStatus": {
"enum": [
"Valid",
"Invalid",
"Not Present"
],
"type": "string",
"description": "Status of the adapter schema associated with specific External Data Provider.",
"nullable": true,
"example": "Valid"
},
"enabled": {
"type": "boolean",
"description": "Defines if the External Data Provider is enabled or not.",
"example": true
},
"isCustom": {
"type": "boolean",
"description": "Defines if the External Data Provider is built-in and created by Fenergo, or if it's custom provider.",
"example": true
},
"providerType": {
"type": "string",
"description": "Defines the External Data Provider Type.",
"nullable": true,
"example": "true"
},
"schemaId": {
"type": "string",
"description": "Id of Adapter Schema associated with specific External Data Provider.",
"format": "uuid",
"example": "d046f87e-2f26-41d4-833a-ed57fb897ee6"
},
"schemaIndividualId": {
"type": "string",
"description": "Id of Adapter Schema associated with specific External Data Provider, for Individual entity type.",
"format": "uuid",
"example": "d046f87e-2f26-41d4-833a-ed57fb897ee6"
},
"schemas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderSchemaDto"
},
"description": "Adapter Schema",
"nullable": true
},
"skipPolicyValidation": {
"type": "boolean",
"description": "Defines if the validations related to policy mapping will run for this External Data Provider.",
"example": false
},
"documentSupport": {
"type": "boolean",
"description": "Defines if specific External Data Provider is configured to allow requesting and getting documents.",
"example": false
},
"ongoingMonitoringSupport": {
"type": "boolean",
"description": "Defines if specific External Data Provider is configured to allow ongoing monitoring of the entities.",
"example": false
},
"supportedEntityType": {
"type": "array",
"items": {
"type": "string"
},
"description": "Defines list of available entity type mapping. In Config for custom ignore/return all",
"nullable": true
},
"enabledEntityType": {
"type": "array",
"items": {
"type": "string"
},
"description": "Defines list of available entity type mapping. In DB",
"nullable": true
},
"internal": {
"type": "boolean",
"description": "Defines if the External Data Provider is internal, FenX specific.",
"example": false
},
"ongoingMonitoringSchema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SchemaEntryV2"
},
"description": "Defines the schema for ongoing monitoring support to map the data to the correct fields.",
"nullable": true
},
"version": {
"type": "integer",
"description": "Version of the configuration.",
"format": "int32",
"nullable": true,
"example": 1
},
"localConfiguration": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SchemaEntryV2"
},
"nullable": true
},
"globalConfigurationDefaultVersion": {
"type": "integer",
"format": "int32"
},
"globalConfiguration": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderConfigurationV2"
},
"nullable": true
},
"errors": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorsDto"
}
],
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent the configuration of a single External Data Provider."
},
"ProviderConfigurationDtoV2ServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ProviderConfigurationDtoV2"
}
],
"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"
},
"ProviderConfigurationLiteDtoV2": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the External Data Provider.",
"format": "uuid",
"example": "d046f87e-2f26-41d4-833a-ed57fb897ee6"
},
"configurationVersion": {
"type": "integer",
"description": "Configuration Version.",
"format": "int32",
"example": 1
},
"name": {
"type": "string",
"description": "Name of the External Data Provider.",
"nullable": true,
"example": "Kompany"
},
"configurationStatus": {
"enum": [
"Verified",
"Verification Failed",
"Not Verified",
"Testing"
],
"type": "string",
"description": "Status of the External Data Provider.",
"nullable": true,
"example": "Verified"
},
"mappingStatus": {
"enum": [
"Present",
"Invalid",
"Not Present",
"Incomplete"
],
"type": "string",
"description": "Status of the mapping associated with specific External Data Provider.",
"nullable": true,
"example": "Present"
},
"schemaStatus": {
"enum": [
"Valid",
"Invalid",
"Not Present"
],
"type": "string",
"description": "Status of the adapter schema associated with specific External Data Provider.",
"nullable": true,
"example": "Valid"
},
"enabled": {
"type": "boolean",
"description": "Defines if the External Data Provider is enabled or not.",
"example": true
},
"isCustom": {
"type": "boolean",
"description": "Defines if the External Data Provider is built-in and created by Fenergo, or if it's custom provider.",
"example": true
},
"providerType": {
"type": "string",
"description": "Defines the External Data Provider Type.",
"nullable": true,
"example": "true"
},
"schemaId": {
"type": "string",
"description": "Id of Adapter Schema associated with specific External Data Provider.",
"format": "uuid",
"example": "d046f87e-2f26-41d4-833a-ed57fb897ee6"
},
"schemaIndividualId": {
"type": "string",
"description": "Id of Adapter Schema associated with specific External Data Provider, for Individual entity type.",
"format": "uuid",
"example": "d046f87e-2f26-41d4-833a-ed57fb897ee6"
},
"schemas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderSchemaDto"
},
"description": "Adapter Schema",
"nullable": true
},
"skipPolicyValidation": {
"type": "boolean",
"description": "Defines if the validations related to policy mapping will run for this External Data Provider.",
"example": false
},
"documentSupport": {
"type": "boolean",
"description": "Defines if specific External Data Provider is configured to allow requesting and getting documents.",
"example": false
},
"ongoingMonitoringSupport": {
"type": "boolean",
"description": "Defines if specific External Data Provider is configured to allow ongoing monitoring of the entities.",
"example": false
},
"supportedEntityType": {
"type": "array",
"items": {
"type": "string"
},
"description": "Defines list of available entity type mapping. In Config for custom ignore/return all",
"nullable": true
},
"enabledEntityType": {
"type": "array",
"items": {
"type": "string"
},
"description": "Defines list of available entity type mapping. In DB",
"nullable": true
},
"internal": {
"type": "boolean",
"description": "Defines if the External Data Provider is internal, FenX specific.",
"example": false
},
"ongoingMonitoringSchema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SchemaEntryV2"
},
"description": "Defines the schema for ongoing monitoring support to map the data to the correct fields.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent External Data Provider configuration base details."
},
"ProviderConfigurationV2": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"format": "int32"
},
"authenticationKey": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityKey"
}
],
"nullable": true
},
"encryptionKey": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityKey"
}
],
"nullable": true
},
"configuration": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"nullable": true
},
"enabledEntityType": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"ProviderMappingDto": {
"type": "object",
"properties": {
"providerId": {
"type": "string",
"description": "The UiD of the Provider",
"nullable": true,
"example": "f47b539d-ffb8-4cf2-bf68-1af79e3b0040"
},
"operationsMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OperationMappingDto"
},
"description": "Set of Operation Mappings (Search Request, Search Response, Get Request, Get Response)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent mappings set for Provider"
},
"ProviderMappingDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ProviderMappingDto"
}
],
"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"
},
"ProviderSchemaDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id",
"format": "uuid",
"example": "d146f87e-2f26-41d4-833a-ed57fb897ee6"
},
"entityType": {
"enum": [
"Company",
"Individual"
],
"type": "string",
"description": "Defines Entity Type",
"nullable": true,
"example": "Company"
},
"status": {
"enum": [
"Valid",
"Invalid",
"Not Present"
],
"type": "string",
"description": "Status of the adapter schema associated with specific External Data Provider.",
"nullable": true,
"example": "Valid"
},
"validationErrors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Schema Validation Errors.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent External Data Provider Schema."
},
"RegexValidation": {
"type": "object",
"properties": {
"pattern": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RelatedDocumentsDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"data": {
"nullable": true
}
},
"additionalProperties": false
},
"RelatedEntityAssociationDto": {
"type": "object",
"properties": {
"parentId": {
"type": "string",
"nullable": true
},
"childId": {
"type": "string",
"nullable": true
},
"ownershipPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"associationType": {
"type": "string",
"nullable": true
},
"data": {
"nullable": true
}
},
"additionalProperties": false
},
"RelatedEntityDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"entityType": {
"type": "string",
"nullable": true
},
"fullName": {
"type": "string",
"nullable": true
},
"uboType": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean",
"nullable": true
},
"data": {
"nullable": true
}
},
"additionalProperties": false
},
"RelatedPartyAssociationDto": {
"type": "object",
"properties": {
"parentId": {
"type": "string",
"description": "The unique identifier of the parent related party.",
"nullable": true
},
"childId": {
"type": "string",
"description": "The unique identifier of the child related party.",
"nullable": true
},
"ownershipPercentage": {
"type": "number",
"description": "The ownership percentage of the child related party.",
"format": "double",
"nullable": true
},
"associationType": {
"type": "string",
"description": "The type of association (e.g., \"Individual\", \"Company\").",
"nullable": true
},
"data": {
"description": "Additional data associated with the relationship.",
"nullable": true
}
},
"additionalProperties": false
},
"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",
"nullable": true
},
"associations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartyAssociationDto"
},
"description": "Collection of associations with other related parties.",
"nullable": true
},
"providerData": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"description": "A dynamic object containing additional data specific to the record type (e.g., \"FirstName\", \"LastName\" for individuals).",
"nullable": true
},
"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",
"items": {
"type": "string"
},
"description": "Source list",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents an individual related party record."
},
"RelatedPartyGroupDto": {
"type": "object",
"properties": {
"groupId": {
"type": "string",
"description": "The unique identifier of the related party group.",
"format": "uuid"
},
"type": {
"type": "string",
"description": "The type of the related party group (e.g., \"Individual\" or \"Company\").",
"nullable": true
},
"key": {
"type": "string",
"description": "A key representing the group (e.g., a combination of name and additional attributes).",
"nullable": true
},
"status": {
"type": "string",
"description": "The status of the related party record (e.g., \"ReviewRequired\").",
"nullable": true
},
"description": {
"type": "string",
"description": "A brief description providing additional information about the record.",
"nullable": true
},
"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",
"description": "Id of entity for which association was linked",
"nullable": true
},
"defaultProviderId": {
"type": "string",
"description": "The unique identifier of the default provider for the related party records in this group.",
"nullable": true
},
"importData": {
"allOf": [
{
"$ref": "#/components/schemas/ImportDataDto"
}
],
"description": "Data needed for future import to FenX",
"nullable": true
},
"potentialDuplicates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PotentialDuplicateDto"
},
"description": "A collection of potential duplicate records found in the system.",
"nullable": true
},
"parties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelatedPartyDto"
},
"description": "A collection of individual related party records within the group.",
"nullable": true
},
"aiAssistanceDate": {
"type": "string",
"description": "Gets or sets the date and time when AI assistance was provided.",
"format": "date-time"
},
"keyIdentifier": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets an array of key identifiers associated with the entity.",
"nullable": true
},
"aiSummary": {
"type": "string",
"description": "Gets or sets a summary generated by the AI.",
"nullable": true
},
"aiReasoning": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets the reasoning steps or explanations generated by the AI.",
"nullable": true
},
"groupKey": {
"allOf": [
{
"$ref": "#/components/schemas/GroupKeyDto"
}
],
"description": "Gets or sets the structured group key used for grouping related parties.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a single related party group."
},
"RootEntityDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"entityType": {
"type": "string",
"nullable": true
},
"fullName": {
"type": "string",
"nullable": true
},
"data": {
"nullable": true
}
},
"additionalProperties": false
},
"SchemaDto": {
"type": "object",
"properties": {
"searchRequest": {
"allOf": [
{
"$ref": "#/components/schemas/SearchRequestSchemaDto"
}
],
"nullable": true
},
"searchResponse": {
"allOf": [
{
"$ref": "#/components/schemas/SearchResponseSchemaDto"
}
],
"nullable": true
},
"getRequest": {
"allOf": [
{
"$ref": "#/components/schemas/GetRequestSchemaDto"
}
],
"nullable": true
},
"getResponse": {
"allOf": [
{
"$ref": "#/components/schemas/GetResponseSchemaDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"SchemaEntryDto": {
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"SchemaEntryV2": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"friendlyName": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"value": {
"nullable": true
},
"defaultValue": {
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/ValueTypeV2"
}
]
},
"masked": {
"type": "boolean"
},
"mandatory": {
"type": "boolean"
},
"min": {
"type": "integer",
"format": "int32",
"nullable": true
},
"max": {
"type": "integer",
"format": "int32",
"nullable": true
},
"precision": {
"type": "number",
"format": "float",
"nullable": true
},
"section": {
"type": "string",
"nullable": true
},
"dependency": {
"allOf": [
{
"$ref": "#/components/schemas/Dependency"
}
],
"nullable": true
},
"regexValidation": {
"allOf": [
{
"$ref": "#/components/schemas/RegexValidation"
}
],
"nullable": true
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupValue"
},
"nullable": true
}
},
"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",
"items": {
"type": "string"
},
"nullable": true
},
"pager": {
"allOf": [
{
"$ref": "#/components/schemas/PagerDto"
}
],
"description": "Specification of search result page",
"nullable": true
}
},
"additionalProperties": false
},
"SearchForDifferencesDtoServiceRequest": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/SearchForDifferencesDto"
}
],
"description": "The service request DTO"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"SearchRequestSchemaDto": {
"type": "object",
"properties": {
"searchCriteria": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaEntryDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"SearchResponseDto": {
"type": "object",
"properties": {
"providerId": {
"type": "string",
"description": "Id of the Provider from which Search response is from",
"nullable": true,
"example": "f47b539d-ffb8-4cf2-bf68-1af79e3b0040"
},
"status": {
"type": "string",
"description": "Status of the Search response",
"nullable": true,
"example": "PublishInProgress"
},
"errorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorDetailsDto"
}
],
"description": "Error Details",
"nullable": true
},
"results": {
"type": "array",
"items": { },
"description": "List of results from this Search operation",
"nullable": true,
"deprecated": true
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchResponseResultDto"
},
"description": "List of records from this Search operation",
"nullable": true
},
"mappedSearchCriteria": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of search criteria which were mapped",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent Search response from specific Provider"
},
"SearchResponseResultDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"entityType": {
"type": "string",
"nullable": true
},
"fullName": {
"type": "string",
"nullable": true
},
"matchHint": {
"type": "string",
"nullable": true
},
"matchScore": {
"type": "number",
"format": "double",
"nullable": true
},
"data": {
"nullable": true
}
},
"additionalProperties": false
},
"SearchResponseSchemaDto": {
"type": "object",
"properties": {
"searchResultsData": {
"allOf": [
{
"$ref": "#/components/schemas/SchemaEntryDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"SearchResultsDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the Search results",
"format": "uuid",
"nullable": true,
"example": "63717ef9-9601-4218-be6d-6fc843cb4644"
},
"journeyId": {
"type": "string",
"description": "Id of the Journey from which the request originated from",
"nullable": true,
"example": "c0c7b87d-1fc3-4127-b87d-c5b76a13d159"
},
"status": {
"type": "string",
"description": "Status of Search results",
"nullable": true,
"example": "PublishInProgress"
},
"providerIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of Provider Ids that were called",
"nullable": true
},
"searchCriteria": {
"description": "Search Criteria on which the search was based on",
"nullable": true
},
"ongoingMonitoring": {
"type": "boolean",
"description": "If subscribed to ongoing monitoring",
"example": true
},
"ongoingMonitoringStatus": {
"type": "string",
"description": "Ongoing Monitoring Subscription Status",
"nullable": true
},
"ongoingMonitoringData": {
"description": "Ongoing Monitoring Subscription Data",
"nullable": true
},
"searchResponses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchResponseDto"
},
"description": "List of each Search response returned from each provider",
"nullable": true
},
"entityType": {
"enum": [
"Company",
"Individual"
],
"type": "string",
"description": "Entity Type for which search has been executed",
"nullable": true,
"example": "Company"
}
},
"additionalProperties": false,
"description": "Class to represent Search results"
},
"SearchResultsDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/SearchResultsDto"
}
],
"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"
},
"SecurityKey": {
"type": "object",
"properties": {
"key": {
"type": "string",
"format": "byte",
"nullable": true
},
"createdOn": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"SecurityKeyDto": {
"type": "object",
"properties": {
"key": {
"type": "string",
"nullable": true
},
"createdOn": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"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"
},
"SingleDataFieldDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"providers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldSource"
},
"nullable": true
},
"reviewRequired": {
"type": "boolean"
},
"isOverridden": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
},
"propertyType": {
"type": "string",
"nullable": true
},
"propertyTypeId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SortOrder": {
"enum": [
0,
1
],
"type": "integer",
"description": "Sort Order (Ascending or Descending)",
"format": "int32"
},
"StringListServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"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"
},
"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"
},
"UltimateBeneficialOwnerResultsDto": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Ultimate Business Owner Discovery Status",
"nullable": true,
"example": "Requested"
},
"fileLocation": {
"type": "string",
"description": "Ultimate Business Owner Discovery Report",
"nullable": true,
"example": "Requested"
},
"errorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/AdapterResponseErrorDetails"
}
],
"description": "Detailed error message",
"nullable": true
},
"entityId": {
"type": "string",
"description": "EntityId",
"nullable": true,
"example": "d046f87e-2f26-41d4-833a-ed57fb897ee6"
},
"hierarchy": {
"allOf": [
{
"$ref": "#/components/schemas/ObjectObjectHierarchyDto"
}
],
"description": "Result of Ultimate Beneficial Owner Discovery",
"nullable": true
},
"purchasedDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentResultsDto"
},
"description": "Document purchased with UBO Discovery process",
"nullable": true
}
},
"additionalProperties": false
},
"ValidationError": {
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/ValidationErrorType"
}
]
}
},
"additionalProperties": false
},
"ValidationErrorType": {
"enum": [
0,
1
],
"type": "integer",
"format": "int32"
},
"ValueTypeV2": {
"enum": [
"String",
"Number",
"Select",
"Boolean",
"MultiSelect",
"NumberFloat"
],
"type": "string"
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Please insert JWT with Bearer into field",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}