openapi: 3.2.0 info: title: Fenergo Providers Configuration API version: '1.0' description: 'Operations tagged Providers Configuration across 2 of this provider''s published API definitions: fenergo-externaldatacommand-v1-0-openapi.json, fenergo-externaldataquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /externaldatacommand - url: /externaldataquery security: - Bearer: [] tags: - name: Providers Configuration paths: /api/providersconfiguration/provider/{providerId}/status: put: tags: - Providers Configuration summary: Save Provider status description: 'This method allows to save external provider status active/inactive It validates if the status can be changed, e.g. if any other provider is active at the same time. Required permissions: Following permissions are required: ExternalDataConfiguratorEdit Required permissions: Following permissions are required: ExternalDataConfiguratorEdit' operationId: SaveProviderStatusV2 parameters: - name: providerId in: path description: ID of External Data 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 requestBody: description: Request with the boolean value of status to set. content: application/json: schema: allOf: - $ref: '#/components/schemas/BooleanServiceRequest' description: Service request data responses: '202': description: Accepted '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /externaldatacommand /api/providersconfiguration/provider/{providerId}/mapping/status: put: tags: - Providers Configuration summary: Save enabled entity type status description: 'This method allows to save mapping status for specific entity type for provider - active/inactive Required permissions: Following permissions are required: ExternalDataConfiguratorEdit Required permissions: Following permissions are required: ExternalDataConfiguratorEdit' operationId: SaveEntityTypeStatus parameters: - name: providerId in: path description: ID of External Data 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 requestBody: description: Request with the entity type and boolean value of status to set. content: application/json: schema: allOf: - $ref: '#/components/schemas/EntityTypeStatusDtoServiceRequest' description: Service request data responses: '202': description: Accepted '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /externaldatacommand /api/providersconfiguration/provider/{providerId}/configuration: put: tags: - Providers Configuration summary: Save External Data Provider Configuration description: 'This method allows to save external provider configuration It includes saving version, ongoing monitoring status It also saves the provider authentication details - Encryption Key, Authentication Key It saves any custom configuration for specific provider on key/value basis Required permissions: Following permissions are required: ExternalDataConfiguratorEdit Required permissions: Following permissions are required: ExternalDataConfiguratorEdit' operationId: SaveProviderConfigurationV2 parameters: - name: providerId in: path description: ID of External Data 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 requestBody: description: The request with provider configuration delivered as key/value collection content: application/json: schema: allOf: - $ref: '#/components/schemas/ProviderConfigurationDtoV2ServiceRequest' description: Service request data responses: '202': description: Success. Provider added content: application/json: schema: $ref: '#/components/schemas/SaveProviderConfigurationResponseDtoV2ServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /externaldatacommand /api/providersconfiguration/customProvider: post: tags: - Providers Configuration summary: Add custom provider description: 'This method allows to add custom provider It includes saving provider name, url, authentication details, ongoing monitoring status Required permissions: Following permissions are required: ExternalDataConfiguratorCreate Required permissions: Following permissions are required: ExternalDataConfiguratorCreate' operationId: AddCustomProviderV2 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: Request with details of custom provider. content: application/json: schema: allOf: - $ref: '#/components/schemas/CustomProviderDtoV2ServiceRequest' description: Service request data responses: '202': description: Success. Provider added content: application/json: schema: $ref: '#/components/schemas/AddCustomProviderResponseDtoV2ServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /externaldatacommand /api/providersconfiguration/customProvider/{providerId}: put: tags: - Providers Configuration summary: Update custom provider description: 'This method allows to update existing custom provider details It includes saving provider name, url, authentication data, ongoing monitoring status Required permissions: Following permissions are required: ExternalDataConfiguratorEdit Required permissions: Following permissions are required: ExternalDataConfiguratorEdit' operationId: UpdateCustomProviderV2 parameters: - name: providerId in: path description: ID of External Data 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 requestBody: description: Request with details of custom provider. content: application/json: schema: allOf: - $ref: '#/components/schemas/CustomProviderDtoV2ServiceRequest' description: Service request data responses: '202': description: Success. Provider updated content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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 delete: tags: - Providers Configuration summary: Delete custom provider description: 'Required permissions: Following permissions are required: ExternalDataConfiguratorDelete Required permissions: Following permissions are required: ExternalDataConfiguratorDelete' operationId: DeleteCustomProviderV2 parameters: - name: providerId in: path description: ID of External Data 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: '202': description: Success. Provider removed content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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 get: tags: - Providers Configuration summary: Get custom provider configuration description: 'This 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 servers: - url: /externaldatacommand /api/providersconfiguration/flowProvider: post: tags: - Providers Configuration summary: Create flow provide description: 'Required permissions: Following permissions are required: ExternalDataConfiguratorEdit Required permissions: Following permissions are required: ExternalDataConfiguratorEdit' operationId: CreateFlowProvider 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: Request with details of flow provider. content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateFlowProviderRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Provider updated content: application/json: schema: $ref: '#/components/schemas/CreateFlowProviderResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /externaldatacommand /api/providersconfiguration/flowProvider/{providerId}: put: tags: - Providers Configuration summary: Update flow provider description: 'This method allows to update existing custom provider details It includes saving provider name, url, authentication data, ongoing monitoring status Required permissions: Following permissions are required: ExternalDataConfiguratorEdit Required permissions: Following permissions are required: ExternalDataConfiguratorEdit' operationId: UpdateFlowProvider parameters: - name: providerId in: path description: ID of External Data 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 requestBody: description: Request with details of custom provider. content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateFlowProviderRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Provider updated content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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 delete: tags: - Providers Configuration summary: Delete flow provider description: 'This method allows to delete existing custom provider details It includes saving provider name, url, authentication data, ongoing monitoring status Required permissions: Following permissions are required: ExternalDataConfiguratorDelete Required permissions: Following permissions are required: ExternalDataConfiguratorDelete' operationId: DeleteFlowProvider parameters: - name: providerId in: path description: ID of External Data 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: '202': description: Success. Provider deleted content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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 get: tags: - Providers Configuration summary: Get flow provider configuration description: 'This 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 servers: - url: /externaldatacommand /api/providersconfiguration: get: tags: - Providers Configuration summary: Get External Data Providers Configuration description: 'Get base configuration details of external data providers. 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 servers: - url: /externaldataquery /api/providersconfiguration/provider/{providerId}: get: tags: - Providers Configuration summary: Get External Data provider configuration description: 'This 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 servers: - url: /externaldataquery /api/providersconfiguration/adapterschema/{providerId}: get: tags: - Providers Configuration summary: Get Adapter Schema for provider description: 'This 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 servers: - url: /externaldataquery components: schemas: SaveProviderConfigurationResponseDtoV2ServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/SaveProviderConfigurationResponseDtoV2' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ProviderConfigurationDtoV2ServiceRequest: required: - data type: object properties: data: allOf: - $ref: '#/components/schemas/ProviderConfigurationDtoV2' description: The service request DTO additionalProperties: false description: Service request data EntityTypeStatusDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EntityTypeStatusDto' description: The service request DTO additionalProperties: false description: Service request data CreateFlowProviderResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateFlowProviderResponseDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data SaveProviderConfigurationResponseDtoV2: type: object properties: status: type: - string - 'null' enabled: type: boolean additionalProperties: false BooleanServiceRequest: type: object properties: data: type: boolean description: The service request DTO additionalProperties: false description: Service request data ServiceResponse: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data EntityTypeStatusDto: type: object properties: entityType: type: - string - 'null' description: Type of entity. example: Company isActive: type: boolean description: Defines if mapping for above entity type is enabled. example: false additionalProperties: false CustomProviderDtoV2: type: object properties: name: type: - string - 'null' description: Name of External Data Provider. example: Mock Provider url: type: - string - 'null' description: Base url of the external data adapter which will be used to make the requests. example: https://api.fenergox.com/externaldatamock authenticationKey: type: - string - 'null' description: Authentication key that allows the external data adapter to authenticate the requests. encryptionKey: type: - string - 'null' description: Encryption key to authenticate the requests. skipPolicyValidation: type: boolean description: Defines if the validations related to policy mapping will run for this External Data Provider. example: false ongoingMonitoringEnabled: type: boolean description: Defines if ongoing monitoring feature is enabled for this External Data Provider. example: true documentSupportEnabled: type: boolean description: Defines if documents feature is enabled for this External Data Provider. example: true additionalProperties: false description: Class to represent a single custom External Data Provider configuration. UpdateFlowProviderRequestDtoServiceRequest: required: - data type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateFlowProviderRequestDto' description: The service request DTO additionalProperties: false description: Service request data AddCustomProviderResponseDtoV2ServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AddCustomProviderResponseDtoV2' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data AddCustomProviderResponseDtoV2: type: object properties: id: type: string format: uuid additionalProperties: false CustomProviderDtoV2ServiceRequest: required: - data type: object properties: data: allOf: - $ref: '#/components/schemas/CustomProviderDtoV2' description: The service request DTO additionalProperties: false description: Service request data CreateFlowProviderResponseDto: type: object properties: id: type: string format: uuid additionalProperties: false ObjectServiceResponse: type: object properties: data: description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data StringServiceResponse: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ProviderConfigurationDtoV2: type: object properties: version: type: integer description: Version of the configuration. format: int32 example: 1 skipPolicyValidation: type: boolean description: Defines if the validations related to policy mapping will run for this External Data Provider. example: false enabledEntityType: type: - array - 'null' items: type: string description: Defines if what type of entity is enabled for configuration mapping. configuration: type: - object - 'null' additionalProperties: {} additionalProperties: false description: Class to represent the configuration of a single External Data Provider. ServiceResponseMessage: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response UpdateFlowProviderRequestDto: type: object properties: name: type: - string - 'null' endpointsConfiguration: type: - array - 'null' items: $ref: '#/components/schemas/FlowProviderEndpointConfigurationDto' ongoingMonitoringEnabled: type: boolean additionalProperties: false FlowProviderEndpointConfigurationDto: type: object properties: requestType: type: - string - 'null' flowId: type: - string - 'null' additionalProperties: false CreateFlowProviderRequestDto: type: object properties: name: type: - string - 'null' endpointsConfiguration: type: - array - 'null' items: $ref: '#/components/schemas/FlowProviderEndpointConfigurationDto' ongoingMonitoringEnabled: type: boolean additionalProperties: false CreateFlowProviderRequestDtoServiceRequest: required: - data type: object properties: data: allOf: - $ref: '#/components/schemas/CreateFlowProviderRequestDto' description: The service request DTO additionalProperties: false description: Service request data GetRequestSchemaDto: type: object properties: requestData: allOf: - $ref: '#/components/schemas/SchemaEntryDto' additionalProperties: false SchemaEntryDto: type: object properties: fields: type: - array - 'null' items: $ref: '#/components/schemas/FieldDto' additionalProperties: false FlowProviderConfigurationDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/FlowProviderConfigurationDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data AdapterSchemaDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AdapterSchemaDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ProviderConfigurationDtoV2ServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ProviderConfigurationDtoV2_2' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data GetResponseSchemaDto: type: object properties: clientData: allOf: - $ref: '#/components/schemas/SchemaEntryDto' associatedEntitiesCompanyData: allOf: - $ref: '#/components/schemas/SchemaEntryDto' associatedEntitiesIndividualData: allOf: - $ref: '#/components/schemas/SchemaEntryDto' associationsData: allOf: - $ref: '#/components/schemas/SchemaEntryDto' additionalProperties: false SecurityKeyDto: type: object properties: key: type: - string - 'null' createdOn: type: string format: date-time additionalProperties: false CustomProviderConfigurationDtoV2ServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CustomProviderConfigurationDtoV2' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data SchemaDto: type: object properties: searchRequest: allOf: - $ref: '#/components/schemas/SearchRequestSchemaDto' searchResponse: allOf: - $ref: '#/components/schemas/SearchResponseSchemaDto' getRequest: allOf: - $ref: '#/components/schemas/GetRequestSchemaDto' getResponse: allOf: - $ref: '#/components/schemas/GetResponseSchemaDto' additionalProperties: false SearchResponseSchemaDto: type: object properties: searchResultsData: allOf: - $ref: '#/components/schemas/SchemaEntryDto' additionalProperties: false Condition: type: object properties: operator: allOf: - $ref: '#/components/schemas/ConditionOperator' value: {} additionalProperties: false ConfigurationDtoV2: type: object properties: providersConfiguration: type: - array - 'null' items: $ref: '#/components/schemas/ProviderConfigurationLiteDtoV2' description: List of External Data Providers base configuration. additionalProperties: false description: Class to represent the configuration of External Data Providers. ConditionOperator: enum: - LT - GT - LE - GE - EQ - NE type: string SearchRequestSchemaDto: type: object properties: searchCriteria: allOf: - $ref: '#/components/schemas/SchemaEntryDto' additionalProperties: false LookupDto: type: object properties: name: type: - string - 'null' values: type: - array - 'null' items: type: string additionalProperties: false ValueTypeV2: enum: - String - Number - Select - Boolean - MultiSelect - NumberFloat type: string ErrorDetailsDto: type: object properties: source: type: - string - 'null' description: Source from where the error comes from example: Invoker errorCode: type: - string - 'null' description: Internal error code example: E231 message: type: - string - 'null' description: Error message example: 'Returned error code 403: Forbidden' additionalProperties: false description: Details of error that might occur ConfigurationDtoV2ServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ConfigurationDtoV2' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data SecurityKey: type: object properties: key: type: - string - 'null' format: byte createdOn: type: string format: date-time additionalProperties: false 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 - 'null' description: Name of the External Data Provider. example: Kompany configurationStatus: enum: - Verified - Verification Failed - Not Verified - Testing type: - string - 'null' description: Status of the External Data Provider. example: Verified mappingStatus: enum: - Present - Invalid - Not Present - Incomplete type: - string - 'null' description: Status of the mapping associated with specific External Data Provider. example: Present schemaStatus: enum: - Valid - Invalid - Not Present type: - string - 'null' description: Status of the adapter schema associated with specific External Data Provider. 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 - 'null' description: Defines the External Data Provider Type. 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 - 'null' items: $ref: '#/components/schemas/ProviderSchemaDto' description: Adapter Schema 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 - 'null' items: type: string description: Defines list of available entity type mapping. In Config for custom ignore/return all enabledEntityType: type: - array - 'null' items: type: string description: Defines list of available entity type mapping. In DB internal: type: boolean description: Defines if the External Data Provider is internal, FenX specific. example: false ongoingMonitoringSchema: type: - array - 'null' items: $ref: '#/components/schemas/SchemaEntryV2' description: Defines the schema for ongoing monitoring support to map the data to the correct fields. url: type: - string - 'null' description: Base url of the external data adapter which will be used to make the requests. 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. encryptionKey: allOf: - $ref: '#/components/schemas/SecurityKeyDto' description: Encryption key to authenticate the requests. errors: allOf: - $ref: '#/components/schemas/ErrorsDto' description: Collection of the errors associated with external data provider. additionalProperties: false description: Class to represent a single custom External Data Provider configuration. RegexValidation: type: object properties: pattern: type: - string - 'null' message: type: - string - 'null' additionalProperties: false FieldDto: type: object properties: name: type: - string - 'null' friendlyName: type: - string - 'null' type: type: - string - 'null' description: type: - string - 'null' isCollection: type: boolean lookup: type: - string - 'null' fields: type: - array - 'null' items: $ref: '#/components/schemas/FieldDto' additionalProperties: false Dependency: type: object properties: dependentOn: type: - string - 'null' condition: allOf: - $ref: '#/components/schemas/Condition' additionalProperties: false SchemaEntryV2: type: object properties: name: type: - string - 'null' friendlyName: type: - string - 'null' description: type: - string - 'null' value: {} defaultValue: {} type: allOf: - $ref: '#/components/schemas/ValueTypeV2' masked: type: boolean mandatory: type: boolean min: type: - integer - 'null' format: int32 max: type: - integer - 'null' format: int32 precision: type: - number - 'null' format: float section: type: - string - 'null' dependency: allOf: - $ref: '#/components/schemas/Dependency' regexValidation: allOf: - $ref: '#/components/schemas/RegexValidation' values: type: - array - 'null' items: $ref: '#/components/schemas/LookupValue' additionalProperties: false 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 - 'null' description: Name of the External Data Provider. example: Kompany configurationStatus: enum: - Verified - Verification Failed - Not Verified - Testing type: - string - 'null' description: Status of the External Data Provider. example: Verified mappingStatus: enum: - Present - Invalid - Not Present - Incomplete type: - string - 'null' description: Status of the mapping associated with specific External Data Provider. example: Present schemaStatus: enum: - Valid - Invalid - Not Present type: - string - 'null' description: Status of the adapter schema associated with specific External Data Provider. 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 - 'null' description: Defines the External Data Provider Type. 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 - 'null' items: $ref: '#/components/schemas/ProviderSchemaDto' description: Adapter Schema 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 - 'null' items: type: string description: Defines list of available entity type mapping. In Config for custom ignore/return all enabledEntityType: type: - array - 'null' items: type: string description: Defines list of available entity type mapping. In DB internal: type: boolean description: Defines if the External Data Provider is internal, FenX specific. example: false ongoingMonitoringSchema: type: - array - 'null' items: $ref: '#/components/schemas/SchemaEntryV2' description: Defines the schema for ongoing monitoring support to map the data to the correct fields. additionalProperties: false description: Class to represent External Data Provider configuration base details. ProviderConfigurationDtoV2_2: 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 - 'null' description: Name of the External Data Provider. example: Kompany configurationStatus: enum: - Verified - Verification Failed - Not Verified - Testing type: - string - 'null' description: Status of the External Data Provider. example: Verified mappingStatus: enum: - Present - Invalid - Not Present - Incomplete type: - string - 'null' description: Status of the mapping associated with specific External Data Provider. example: Present schemaStatus: enum: - Valid - Invalid - Not Present type: - string - 'null' description: Status of the adapter schema associated with specific External Data Provider. 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 - 'null' description: Defines the External Data Provider Type. 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 - 'null' items: $ref: '#/components/schemas/ProviderSchemaDto' description: Adapter Schema 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 - 'null' items: type: string description: Defines list of available entity type mapping. In Config for custom ignore/return all enabledEntityType: type: - array - 'null' items: type: string description: Defines list of available entity type mapping. In DB internal: type: boolean description: Defines if the External Data Provider is internal, FenX specific. example: false ongoingMonitoringSchema: type: - array - 'null' items: $ref: '#/components/schemas/SchemaEntryV2' description: Defines the schema for ongoing monitoring support to map the data to the correct fields. version: type: - integer - 'null' description: Version of the configuration. format: int32 example: 1 localConfiguration: type: - array - 'null' items: $ref: '#/components/schemas/SchemaEntryV2' globalConfigurationDefaultVersion: type: integer format: int32 globalConfiguration: type: - array - 'null' items: $ref: '#/components/schemas/ProviderConfigurationV2' errors: allOf: - $ref: '#/components/schemas/ErrorsDto' additionalProperties: false description: Class to represent the configuration of a single External Data Provider. ProviderSchemaDto: type: object properties: id: type: string description: Id format: uuid example: d146f87e-2f26-41d4-833a-ed57fb897ee6 entityType: enum: - Company - Individual type: - string - 'null' description: Defines Entity Type example: Company status: enum: - Valid - Invalid - Not Present type: - string - 'null' description: Status of the adapter schema associated with specific External Data Provider. example: Valid validationErrors: type: - array - 'null' items: type: string description: Schema Validation Errors. additionalProperties: false description: Class to represent External Data Provider Schema. ErrorsDto: type: object properties: configurationError: allOf: - $ref: '#/components/schemas/ErrorDetailsDto' description: Details of error that might occur mappingValidationErrors: type: - array - 'null' items: type: string schemaValidationErrors: type: - array - 'null' items: type: string additionalProperties: false LookupValue: type: object properties: name: type: - string - 'null' value: {} additionalProperties: false ProviderConfigurationV2: type: object properties: version: type: integer format: int32 authenticationKey: allOf: - $ref: '#/components/schemas/SecurityKey' encryptionKey: allOf: - $ref: '#/components/schemas/SecurityKey' configuration: type: - object - 'null' additionalProperties: {} enabledEntityType: type: - array - 'null' items: type: string 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 - 'null' description: Name of the External Data Provider. example: Kompany configurationStatus: enum: - Verified - Verification Failed - Not Verified - Testing type: - string - 'null' description: Status of the External Data Provider. example: Verified mappingStatus: enum: - Present - Invalid - Not Present - Incomplete type: - string - 'null' description: Status of the mapping associated with specific External Data Provider. example: Present schemaStatus: enum: - Valid - Invalid - Not Present type: - string - 'null' description: Status of the adapter schema associated with specific External Data Provider. 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 - 'null' description: Defines the External Data Provider Type. 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 - 'null' items: $ref: '#/components/schemas/ProviderSchemaDto' description: Adapter Schema 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 - 'null' items: type: string description: Defines list of available entity type mapping. In Config for custom ignore/return all enabledEntityType: type: - array - 'null' items: type: string description: Defines list of available entity type mapping. In DB internal: type: boolean description: Defines if the External Data Provider is internal, FenX specific. example: false ongoingMonitoringSchema: type: - array - 'null' items: $ref: '#/components/schemas/SchemaEntryV2' description: Defines the schema for ongoing monitoring support to map the data to the correct fields. endpointsConfiguration: type: - array - 'null' items: $ref: '#/components/schemas/FlowProviderEndpointConfigurationDto_2' description: Endpoints Configuration of the flow provider. errors: allOf: - $ref: '#/components/schemas/ErrorsDto' description: Collection of the errors associated with external data provider. additionalProperties: false description: Class to represent a flow External Data Provider configuration. AdapterSchemaDto: type: object properties: id: type: string format: uuid lookups: type: - array - 'null' items: $ref: '#/components/schemas/LookupDto' schema: allOf: - $ref: '#/components/schemas/SchemaDto' additionalProperties: false FlowProviderEndpointConfigurationDto_2: type: object properties: requestType: type: - string - 'null' description: Request Type. flowId: type: - string - 'null' description: Flow Id or Flow Key. additionalProperties: false description: Class to represent a flow External Data Provider endpoint configuration. securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-externaldatacommand-v1-0-openapi.json - fenergo-externaldataquery-v1-0-openapi.json