openapi: 3.2.0
info:
  title: Fenergo Related Data API
  version: '1.0'
  description: 'Operations tagged RelatedData across 3 of this provider''s published API definitions: fenergo-externaloutreachcommand-v1-0-openapi.json, fenergo-externaloutreachcommand-v2-0-openapi.json, fenergo-externaloutreachquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /externaloutreachcommand
- url: /externaloutreachquery
security:
- Bearer: []
tags:
- name: Related Data
paths:
  /api/related-data/{id}/journey/{journeyId}:
    delete:
      tags:
      - Related Data
      summary: Delete related outreach data
      description: 'Deleted an existing outreach related data.


        Required permissions:

        At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit'
      operationId: DeleteRelatedOutreachData
      parameters:
      - name: id
        in: path
        description: Related data id
        required: true
        schema:
          type: string
          format: uuid
      - name: journeyId
        in: path
        description: Journey id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '202':
          description: Success. Outreach related data updated
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Outreach related data with given id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    put:
      tags:
      - Related Data
      summary: Update related outreach data
      description: 'Updates an existing outreach related data.


        Required permissions:

        At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit'
      operationId: UpdateRelatedOutreachData
      parameters:
      - name: id
        in: path
        description: Related data id
        required: true
        schema:
          type: string
          format: uuid
      - name: journeyId
        in: path
        description: Journey id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Update outreach related data request. Must contain Policy jurisdiction(s) and entity draft properties
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityDraftRequestDtoServiceRequest'
      responses:
        '202':
          description: Success. Outreach related data updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutreachDataCommandResponseDtoServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Outreach related data with given id does not exist
                  type: Error
                  errorCode: Error Code
        '409':
          description: Conflict saving changes in expected version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes
                  type: Error
                  errorCode: CONFLICT
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /externaloutreachcommand
  /api/related-data/{journeyId}:
    post:
      tags:
      - Related Data
      summary: Create related outreach data
      description: 'Creates related outreach data.


        Required permissions:

        At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit'
      operationId: CreateRelatedOutreachData
      parameters:
      - name: journeyId
        in: path
        description: Journey id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Create related outreach data request. Must contain Policy jurisdiction(s) and entity draft properties
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityDraftRequestDtoServiceRequest'
      responses:
        '202':
          description: Success. Outreach related data updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutreachDataCommandResponseDtoServiceResponse'
        '409':
          description: Conflict saving changes in expected version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes
                  type: Error
                  errorCode: CONFLICT
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /externaloutreachcommand
  /api/related-data/clear/journey/{journeyId}:
    delete:
      tags:
      - Related Data
      summary: Permanently deletes existing outreach related data
      description: 'This method will delete all existing outreach related data.


        Required permissions:

        At least one of the following permissions is required: AssociationEdit, EntityGroupManagementEdit, AssociationEdit, EntityGroupManagementEdit'
      operationId: ClearOutreachRelatedData
      parameters:
      - name: journeyId
        in: path
        description: Journey Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '202':
          description: Association model deleted successfully
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /externaloutreachcommand
  /api/v2/related-data/{id}/journey/{journeyId}:
    put:
      tags:
      - Related Data
      summary: Update related outreach data
      description: 'Updates an existing outreach related data


        Required permissions:

        At least one of the following permissions is required: EntityGroupManagementEdit, EntityDataEdit'
      operationId: UpdateRelatedOutreachDataV2
      parameters:
      - name: id
        in: path
        description: Related data id.
        required: true
        schema:
          type: string
          format: uuid
      - name: journeyId
        in: path
        description: Journey id.
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Update outreach related data request. Must contain Policy jurisdiction(s) and entity draft properties.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityDraftRequestDtoServiceRequest'
      responses:
        '400':
          description: Bad request. The request has missing/invalid values.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Outreach related data with given id does not exist.
                  type: Error
                  errorCode: Error Code
        '202':
          description: Success. Outreach related data updated. Validation errors will be returned for invalid properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutreachDataCommandResponseDtoServiceResponse'
        '409':
          description: Conflict saving changes in expected version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes
                  type: Error
                  errorCode: CONFLICT
        '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:
      - Related Data
      summary: Delete related outreach data
      description: 'Deleted an existing outreach related data.


        Required permissions:

        At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit'
      operationId: deleteApiV2RelatedDataByIdJourneyByJourneyId
      parameters:
      - name: id
        in: path
        description: Related data id
        required: true
        schema:
          type: string
          format: uuid
      - name: journeyId
        in: path
        description: Journey id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '202':
          description: Success. Outreach related data updated
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Outreach related data with given id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
      x-operation-id-source: normalized
      x-operation-id-original: DeleteRelatedOutreachData
    servers:
    - url: /externaloutreachcommand
  /api/v2/related-data/{journeyId}:
    post:
      tags:
      - Related Data
      summary: Create related outreach data
      description: 'Creates related outreach data.


        Required permissions:

        At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit'
      operationId: postApiV2RelatedDataByJourneyId
      parameters:
      - name: journeyId
        in: path
        description: Journey id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Create related outreach data request. Must contain Policy jurisdiction(s) and entity draft properties
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityDraftRequestDtoServiceRequest'
      responses:
        '202':
          description: Success. Outreach related data updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutreachDataCommandResponseDtoServiceResponse'
        '409':
          description: Conflict saving changes in expected version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes
                  type: Error
                  errorCode: CONFLICT
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
      x-operation-id-source: normalized
      x-operation-id-original: CreateRelatedOutreachData
    servers:
    - url: /externaloutreachcommand
  /api/v2/related-data/clear/journey/{journeyId}:
    delete:
      tags:
      - Related Data
      summary: Permanently deletes existing outreach related data
      description: 'This method will delete all existing outreach related data.


        Required permissions:

        At least one of the following permissions is required: AssociationEdit, EntityGroupManagementEdit, AssociationEdit, EntityGroupManagementEdit'
      operationId: deleteApiV2RelatedDataClearJourneyByJourneyId
      parameters:
      - name: journeyId
        in: path
        description: Journey Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '202':
          description: Association model deleted successfully
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
      x-operation-id-source: normalized
      x-operation-id-original: ClearOutreachRelatedData
    servers:
    - url: /externaloutreachcommand
  /api/related-data/getlist:
    post:
      tags:
      - Related Data
      summary: Get list of outreach related Data
      description: 'Returns the list of related data.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: GetRelatedDataList
      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: Query related data request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/RelatedDataListQueryDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. The list of related data is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataDtoListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_2'
        '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_2'
              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_2'
              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_2'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /externaloutreachquery
components:
  schemas:
    PropertiesDto:
      type: object
      properties:
        singleProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto2'
        collectionProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CollectionPropertyDto2'
        customProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CustomPropertyDto2'
      additionalProperties: false
    InvestmentAccountFundDataSource:
      required:
      - properties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    DataSourcesDto:
      type: object
      properties:
        entityDataMetadata:
          allOf:
          - $ref: '#/components/schemas/EntityDataMetadataDataSource'
        eventIngress:
          allOf:
          - $ref: '#/components/schemas/EventIngressDataSource'
        changedFields:
          allOf:
          - $ref: '#/components/schemas/ChangedFieldsDataSource'
        relatedClient:
          allOf:
          - $ref: '#/components/schemas/RelatedClientDataSource'
        relatedProducts:
          allOf:
          - $ref: '#/components/schemas/RelatedProductsDataSource'
        currentDataGroupItem:
          allOf:
          - $ref: '#/components/schemas/CurrentDataGroupItemDataSource'
        externalDataAdapter:
          allOf:
          - $ref: '#/components/schemas/ExternalDataAdapterDataSource'
        entityAssociation:
          allOf:
          - $ref: '#/components/schemas/EntityAssociationDataSource'
        manualCreditAssessment:
          allOf:
          - $ref: '#/components/schemas/ManualCreditAssessmentV2DataSource'
        reviewAndApproval:
          allOf:
          - $ref: '#/components/schemas/ReviewAndApprovalDataSource'
        autoCreditAssessment:
          allOf:
          - $ref: '#/components/schemas/AutoCreditAssessmentDataSource'
        manualCreditScreening:
          allOf:
          - $ref: '#/components/schemas/ManualCreditScreeningDataSource'
        collateral:
          allOf:
          - $ref: '#/components/schemas/CollateralDataSource'
        currentJourneys:
          allOf:
          - $ref: '#/components/schemas/CurrentJourneysDataSource'
        autoCreditScreening:
          allOf:
          - $ref: '#/components/schemas/AutoCreditScreeningDataSource'
        currentProduct:
          allOf:
          - $ref: '#/components/schemas/CurrentProductDataSource'
        relatedDeals:
          allOf:
          - $ref: '#/components/schemas/RelatedDealsDataSource'
        mainEntity:
          allOf:
          - $ref: '#/components/schemas/MainEntityDataSource'
        relatedAssets:
          allOf:
          - $ref: '#/components/schemas/RelatedAssetsDataSource'
        relatedAssociations:
          allOf:
          - $ref: '#/components/schemas/RelatedAssociationsDataSource'
        accountRelatedFunds:
          allOf:
          - $ref: '#/components/schemas/AccountRelatedFundsDataSource'
        investmentAccountFund:
          allOf:
          - $ref: '#/components/schemas/InvestmentAccountFundDataSource'
        journeyLevelData:
          allOf:
          - $ref: '#/components/schemas/JourneyLevelDataDataSource'
        relatedParties:
          allOf:
          - $ref: '#/components/schemas/RelatedPartiesDataSource'
        currentField:
          allOf:
          - $ref: '#/components/schemas/CurrentFieldDataSource'
        significanceEngine:
          allOf:
          - $ref: '#/components/schemas/SignificanceEngineDataSource'
        alert:
          allOf:
          - $ref: '#/components/schemas/AlertDataSource'
        relatedFCRs:
          allOf:
          - $ref: '#/components/schemas/RelatedFCRsDataSource'
        relatedInvestmentManager:
          allOf:
          - $ref: '#/components/schemas/RelatedInvestmentManagerDataSource'
        relatedUnderlyingPrincipalOwner:
          allOf:
          - $ref: '#/components/schemas/RelatedUnderlyingPrincipalOwnerDataSource'
        alertAssessment:
          allOf:
          - $ref: '#/components/schemas/AlertAssessmentDataSource'
        currentProductMetadata:
          allOf:
          - $ref: '#/components/schemas/CurrentProductMetadataDataSource'
        currentUser:
          allOf:
          - $ref: '#/components/schemas/CurrentUserDataSource'
        relatedDocuments:
          allOf:
          - $ref: '#/components/schemas/RelatedDocumentsDataSource'
        screeningMateriality:
          allOf:
          - $ref: '#/components/schemas/ScreeningMaterialityDataSource'
      additionalProperties: false
    CurrentJourneysDataSource:
      required:
      - inProgressJourneyTypes
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        inProgressJourneyTypes:
          type: array
          items:
            type: string
      additionalProperties: false
    EntityAssociationDataSource:
      required:
      - associationToClient
      - associationType
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        associationType:
          minLength: 1
          type: string
        ownershipPercentage:
          type:
          - number
          - 'null'
          format: double
        associationToClient:
          minLength: 1
          type: string
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    CurrentFieldDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        currentField:
          type:
          - string
          - 'null'
      additionalProperties: false
    SignificanceEngineDto:
      type: object
      properties:
        singleFields:
          type:
          - array
          - 'null'
          items:
            type: string
        collections:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - object
            - 'null'
            additionalProperties:
              type: array
              items:
                type: string
      additionalProperties: false
    CurrentDataGroupItemDataSource:
      required:
      - properties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          type: object
          additionalProperties:
            type:
            - string
            - 'null'
      additionalProperties: false
    SignificanceEngineDataSource:
      required:
      - significanceEngine
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        significanceEngine:
          allOf:
          - $ref: '#/components/schemas/SignificanceEngineDto'
      additionalProperties: false
    AutoCreditScreeningDataSource:
      required:
      - creditScreenings
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        creditScreenings:
          type: array
          items:
            $ref: '#/components/schemas/AutoCreditScreeningDto'
        relatedPartyCreditScreenings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AutoCreditScreeningDto'
      additionalProperties: false
    RelatedInvestmentManagerDataSource:
      required:
      - properties
      type: object
      properties:
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
      additionalProperties: false
    AlertDataSource:
      required:
      - attribute
      - source
      - type
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        source:
          type: string
        type:
          type: string
        attribute:
          type: string
      additionalProperties: false
    RelatedProductDto:
      required:
      - properties
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          example:
            firstName:
              type: Single
              value: Peter
            dateOfBirth:
              type: Single
              value: '1989-04-10'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Poland
                    city: Warszawa
                    street: Nowogrodzka
        lifecycleStatus:
          type:
          - string
          - 'null'
        relationshipTypes:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    JourneyLevelDataDataSource:
      required:
      - properties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    OutreachDataCommandResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/OutreachDataCommandResponseDto'
          description: Response DTO representing updated outreach data
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    PropertyDto:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          readOnly: true
        discriminator:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          readOnly: true
        isValid:
          type:
          - boolean
          - 'null'
      additionalProperties: false
    AutoCreditScreeningDto:
      required:
      - properties
      type: object
      properties:
        entityId:
          type: string
          format: uuid
        creditScreeningOutcome:
          type:
          - string
          - 'null'
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          example:
            firstName:
              type: Single
              value: Peter
            dateOfBirth:
              type: Single
              value: '1989-04-10'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Poland
                    city: Warszawa
                    street: Nowogrodzka
        providerInternalIdentifier:
          type:
          - string
          - 'null'
      additionalProperties: false
    AutoCreditAssessmentDataSource:
      required:
      - autoCreditAssessments
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        autoCreditAssessments:
          type: array
          items:
            $ref: '#/components/schemas/AutoCreditAssessmentDto'
      additionalProperties: false
    OutreachDataCommandResponseDto:
      type: object
      properties:
        version:
          type: integer
          description: Version of outreach data after update
          format: int32
          example: 4
        id:
          type: string
          description: Id of updated/created data
          format: uuid
        hasValidationErrors:
          type: boolean
          description: Flag indicating occurrence of validation errors for invalid properties
          example: false
      additionalProperties: false
      description: Response DTO representing updated outreach data
    RelatedAssociationsDataSource:
      required:
      - relatedAssociations
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        relatedAssociations:
          type: array
          items:
            $ref: '#/components/schemas/RelatedAssociationDto'
      additionalProperties: false
    EntityDataMetadataDataSource:
      required:
      - entityType
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        entityType:
          minLength: 1
          type: string
      additionalProperties: false
    RelatedDocumentVersionedDto:
      type: object
      properties:
        documentKey:
          type:
          - string
          - 'null'
        documentType:
          type:
          - string
          - 'null'
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          example:
            firstName:
              type: Single
              value: Peter
            dateOfBirth:
              type: Single
              value: '1989-04-10'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Poland
                    city: Warszawa
                    street: Nowogrodzka
      additionalProperties: false
    ManualCreditScreeningDto:
      required:
      - properties
      type: object
      properties:
        taskDataKey:
          type:
          - string
          - 'null'
        taskId:
          type: string
          format: uuid
        entityId:
          type: string
          format: uuid
        creditScreeningOutcome:
          type:
          - string
          - 'null'
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          example:
            firstName:
              type: Single
              value: Peter
            dateOfBirth:
              type: Single
              value: '1989-04-10'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Poland
                    city: Warszawa
                    street: Nowogrodzka
      additionalProperties: false
    RelatedUnderlyingPrincipalOwnerDataSource:
      required:
      - properties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    ManualCreditAssessmentV2DataSource:
      required:
      - creditAssessments
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        creditAssessments:
          type: array
          items:
            $ref: '#/components/schemas/CreditAssessmentDto'
      additionalProperties: false
    RelatedClientDataSource:
      required:
      - properties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          example:
            firstName:
              type: Single
              value: Peter
            dateOfBirth:
              type: Single
              value: '1989-04-10'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Poland
                    city: Warszawa
                    street: Nowogrodzka
      additionalProperties: false
    RelatedPartyDto:
      required:
      - properties
      type: object
      properties:
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
      additionalProperties: false
    ReviewAndApprovalDto:
      required:
      - approvalOutcome
      type: object
      properties:
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          example:
            firstName:
              type: Single
              value: Peter
            dateOfBirth:
              type: Single
              value: '1989-04-10'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Poland
                    city: Warszawa
                    street: Nowogrodzka
        approvalOutcome:
          type: string
        approvalReason:
          type:
          - string
          - 'null'
        taskId:
          type:
          - string
          - 'null'
        taskDataKey:
          type:
          - string
          - 'null'
      additionalProperties: false
    RelatedFCRsDataSource:
      required:
      - fcRs
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        fcRs:
          type: array
          items:
            $ref: '#/components/schemas/RelatedFCRDto'
      additionalProperties: false
    EntityDraftRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityDraftRequestDto'
          description: Request DTO to entity draft
      additionalProperties: false
    EntityDraftDto:
      type: object
      properties:
        id:
          type: string
          description: Source entity draft id
          format: uuid
          example: bb88430f-48ec-46de-92dc-905876e0e8eb
        sourceEntityId:
          type: string
          description: Source entity id
          format: uuid
          example: bb88430f-48ec-46de-92dc-905876e0e8eb
        sourceEntityVersion:
          type: integer
          description: Source entity version
          format: int32
          example: 1
        jurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto'
          description: Collection of policy jurisdictions
        type:
          type:
          - string
          - 'null'
          description: The type of the entity
          example: Individual
        category:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of requirement category e.g. ["Basic Details", "Enrich Details"]
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: Entity draft properties
          example:
            firstName:
              type: Single
              value: Peter
            dateOfBirth:
              type: Single
              value: '1989-04-10'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Poland
                    city: Warszawa
                    street: Nowogrodzka
        version:
          type: integer
          description: "Current version of the Draft where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking"
          format: int32
          default: -1
      additionalProperties: false
      description: Request DTO to update entity draft
    CurrentUserDataSource:
      required:
      - teamIds
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        teamIds:
          type: array
          items:
            minLength: 1
            type: string
            format: uuid
        isSystemUser:
          type: boolean
      additionalProperties: false
    ChangedFieldsDataSource:
      required:
      - changedFields
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        changedFields:
          type: array
          items:
            $ref: '#/components/schemas/ChangedFieldDto'
      additionalProperties: false
    CollateralDto:
      required:
      - properties
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          example:
            firstName:
              type: Single
              value: Peter
            dateOfBirth:
              type: Single
              value: '1989-04-10'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Poland
                    city: Warszawa
                    street: Nowogrodzka
      additionalProperties: false
    AlertAssessmentDto:
      required:
      - category
      type: object
      properties:
        category:
          type: string
      additionalProperties: false
    AccountRelatedFundDto:
      required:
      - properties
      type: object
      properties:
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    ReviewAndApprovalDataSource:
      required:
      - reviewAndApprovals
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        reviewAndApprovals:
          type: array
          items:
            $ref: '#/components/schemas/ReviewAndApprovalDto'
      additionalProperties: false
    CreditAssessmentDto:
      required:
      - properties
      - taskId
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          example:
            firstName:
              type: Single
              value: Peter
            dateOfBirth:
              type: Single
              value: '1989-04-10'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Poland
                    city: Warszawa
                    street: Nowogrodzka
        assessmentOutcome:
          type:
          - string
          - 'null'
        assessmentComment:
          type:
          - string
          - 'null'
        taskId:
          type: string
        taskDataKey:
          type:
          - string
          - 'null'
      additionalProperties: false
    CollectionItemDto:
      type: object
      properties:
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto2'
      additionalProperties: false
    CollectionPropertyDto2:
      type: object
      properties:
        items:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CollectionItemDto'
        collectionId:
          type:
          - string
          - 'null'
          format: uuid
      additionalProperties: false
    RelatedDocumentDto:
      required:
      - document
      type: object
      properties:
        document:
          allOf:
          - $ref: '#/components/schemas/RelatedDocumentVersionedDto'
      additionalProperties: false
    RelatedDealsDataSource:
      required:
      - relatedDeals
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        relatedDeals:
          type: array
          items:
            $ref: '#/components/schemas/RelatedDealDto'
      additionalProperties: false
    RelatedDealDto:
      required:
      - properties
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          example:
            firstName:
              type: Single
              value: Peter
            dateOfBirth:
              type: Single
              value: '1989-04-10'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Poland
                    city: Warszawa
                    street: Nowogrodzka
      additionalProperties: false
    CollateralDataSource:
      required:
      - collaterals
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        collaterals:
          type: array
          items:
            $ref: '#/components/schemas/CollateralDto'
      additionalProperties: false
    RelatedAssociationDto:
      required:
      - properties
      type: object
      properties:
        associationType:
          type:
          - string
          - 'null'
        ownershipPercentage:
          type:
          - number
          - 'null'
          format: double
        associationToClient:
          type:
          - string
          - 'null'
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    RelatedAssetDto:
      required:
      - properties
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          example:
            firstName:
              type: Single
              value: Peter
            dateOfBirth:
              type: Single
              value: '1989-04-10'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Poland
                    city: Warszawa
                    street: Nowogrodzka
      additionalProperties: false
    AutoCreditAssessmentDto:
      required:
      - properties
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          example:
            firstName:
              type: Single
              value: Peter
            dateOfBirth:
              type: Single
              value: '1989-04-10'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Poland
                    city: Warszawa
                    street: Nowogrodzka
        assessmentOutcome:
          type:
          - string
          - 'null'
        providerInternalIdentifier:
          type:
          - string
          - 'null'
      additionalProperties: false
    RelatedProductsDataSource:
      required:
      - products
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        products:
          type: array
          items:
            $ref: '#/components/schemas/RelatedProductDto'
      additionalProperties: false
    AccountRelatedFundsDataSource:
      required:
      - accountRelatedFunds
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        accountRelatedFunds:
          type: array
          items:
            $ref: '#/components/schemas/AccountRelatedFundDto'
      additionalProperties: false
    MainEntityDataSource:
      required:
      - properties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    CurrentProductDataSource:
      required:
      - properties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          example:
            firstName:
              type: Single
              value: Peter
            dateOfBirth:
              type: Single
              value: '1989-04-10'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Poland
                    city: Warszawa
                    street: Nowogrodzka
        lifecycleStatus:
          type:
          - string
          - 'null'
      additionalProperties: false
    EntityDraftRequestDto:
      allOf:
      - $ref: '#/components/schemas/EntityDraftDto'
      - type: object
        properties:
          dataSources:
            allOf:
            - $ref: '#/components/schemas/DataSourcesDto'
            description: Additional data sources used for evaluation
        additionalProperties: false
      description: Request DTO to entity draft
    VersionedJurisdictionDto:
      required:
      - jurisdiction
      - versionId
      type: object
      properties:
        jurisdiction:
          minLength: 1
          type: string
          description: Jurisdiction Name
          example: Global
        versionId:
          minLength: 1
          type: string
          description: Jurisdiction Version Id
          format: uuid
          example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65
      additionalProperties: false
    CurrentProductMetadataDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        isAgency:
          type:
          - string
          - 'null'
        lifecycleStatus:
          type:
          - string
          - 'null'
      additionalProperties: false
    ManualCreditScreeningDataSource:
      required:
      - creditScreenings
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        creditScreenings:
          type: array
          items:
            $ref: '#/components/schemas/ManualCreditScreeningDto'
        relatedPartyCreditScreenings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ManualCreditScreeningDto'
      additionalProperties: false
    RelatedFCRDto:
      required:
      - status
      type: object
      properties:
        status:
          type: string
        createdDate:
          type: string
          format: date-time
        submittedDate:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
    SinglePropertyDto2:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
        valueId:
          type:
          - string
          - 'null'
      additionalProperties: false
    ValidationErrorModelListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorModel'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
      example:
        data:
        - propertyName: data
          errorMessage: Data is required
          attemptedValue: ''
          errorCode: NotNullValidator
        messages:
        - message: Data is required
          type: Error
          errorCode: Error Code
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ScreeningMaterialityAssessmentDto:
      required:
      - adverseMediaJurisdictions
      - enforcementsJurisdictions
      - otherJurisdictions
      - pepJurisdictions
      - sanctionsJurisdictions
      type: object
      properties:
        mainEntity:
          type: boolean
        materialityOutcome:
          type:
          - string
          - 'null'
        pepMaterialityStatus:
          type:
          - string
          - 'null'
        sanctionsMaterialityStatus:
          type:
          - string
          - 'null'
        adverseMediaMaterialityStatus:
          type:
          - string
          - 'null'
        enforcementsMaterialityStatus:
          type:
          - string
          - 'null'
        otherMaterialityStatus:
          type:
          - string
          - 'null'
        pepJurisdictions:
          type: array
          items:
            type: string
        sanctionsJurisdictions:
          type: array
          items:
            type: string
        adverseMediaJurisdictions:
          type: array
          items:
            type: string
        enforcementsJurisdictions:
          type: array
          items:
            type: string
        otherJurisdictions:
          type: array
          items:
            type: string
        sanctionsProceedDecision:
          type:
          - string
          - 'null'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    EventIngressDataSource:
      required:
      - eventSubtype
      - eventType
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        eventType:
          minLength: 1
          type: string
        eventSubtype:
          minLength: 1
          type: string
      additionalProperties: false
    PropertyType:
      enum:
      - Single
      - Custom
      - Collection
      type: string
    CustomPropertyDto2:
      type: object
      properties:
        singleProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto2'
        customProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CustomPropertyDto2'
      additionalProperties: false
    RelatedDocumentsDataSource:
      required:
      - documents
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        documents:
          type: array
          items:
            $ref: '#/components/schemas/RelatedDocumentDto'
      additionalProperties: false
    ChangedFieldDto:
      type: object
      properties:
        key:
          type:
          - string
          - 'null'
      additionalProperties: false
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        attemptedValue: {}
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    RelatedPartiesDataSource:
      required:
      - relatedParties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        relatedParties:
          type: array
          items:
            $ref: '#/components/schemas/RelatedPartyDto'
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    ExternalDataAdapterDataSource:
      required:
      - eventSubtype
      - eventType
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        eventType:
          minLength: 1
          type: string
        eventSubtype:
          minLength: 1
          type: string
      additionalProperties: false
    RelatedAssetsDataSource:
      required:
      - assets
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        assets:
          type: array
          items:
            $ref: '#/components/schemas/RelatedAssetDto'
      additionalProperties: false
    AlertAssessmentDataSource:
      required:
      - assessments
      - lastAssessment
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        assessments:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/AlertAssessmentDto'
        lastAssessment:
          allOf:
          - $ref: '#/components/schemas/AlertAssessmentDto'
        lastAssessmentOutcome:
          type:
          - string
          - 'null'
      additionalProperties: false
    ScreeningMaterialityDataSource:
      required:
      - assessments
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        assessments:
          type: array
          items:
            $ref: '#/components/schemas/ScreeningMaterialityAssessmentDto'
      additionalProperties: false
    DataDtoListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DataDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    ValidationErrorModelListServiceResponse_2:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorModel_2'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
      example:
        data:
        - propertyName: data
          errorMessage: Data is required
          attemptedValue: ''
          errorCode: NotNullValidator
        messages:
        - message: Data is required
          type: Error
          errorCode: Error Code
    ValidationErrorModel_2:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
          description: Name of the property
          example: data
        errorMessage:
          type:
          - string
          - 'null'
          description: User friendly error message
          example: Data is required
        attemptedValue:
          description: Invalid value
        errorCode:
          type:
          - string
          - 'null'
          description: Internal error code
          example: NotNullValidator
      additionalProperties: false
      description: Represents the details of validation error
    DataDto:
      type: object
      properties:
        sourceEntityId:
          type: string
          description: Source entity id
          format: uuid
          example: bb88430f-48ec-46de-92dc-905876e0e8eb
        sourceEntityVersion:
          type: integer
          description: Source entity version
          format: int32
          example: 1
        id:
          type: string
          description: Entity draft id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        journeyId:
          type: string
          description: Journey id
          format: uuid
          example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65
        type:
          type:
          - string
          - 'null'
          description: Entity draft type
          example: Individual
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto_2'
          description: Entity draft properties
        status:
          type:
          - string
          - 'null'
          description: Status
          example: InProgress
        created:
          type:
          - string
          - 'null'
          description: Created date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        jurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto_2'
          description: List of Jurisdictions associated with EntityDraft
        version:
          type: integer
          description: Version number for given EntityDraft
          format: int32
          example: 1
        markedForDeletion:
          type: boolean
          description: 'When true, a portal user has requested removal of this related party.

            The related party is not hard-deleted; back-office reviews and approves the request.

            Only ever set for related-party records; always false for the main journey entity.'
        removalComment:
          type:
          - string
          - 'null'
          description: Optional free-text comment supplied by the portal user when requesting removal of this related party.
        createdBySnapshot:
          type: boolean
          description: 'When true, this related party was copied into the outreach store by the snapshot

            taken at the start of the outreach stage, rather than added during outreach.

            Only ever set for related-party records; always false for the main journey entity.'
      additionalProperties: false
      description: Response DTO representing entity draft data
    VersionedJurisdictionDto_2:
      type: object
      properties:
        jurisdiction:
          type:
          - string
          - 'null'
          description: Jurisdiction Name
          example: Global
        versionId:
          type: string
          description: Jurisdiction Version Id
          format: uuid
          example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65
      additionalProperties: false
    ServiceResponseMessage_2:
      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
    RelatedDataListQueryDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/RelatedDataListQueryDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    PropertyDto_2:
      required:
      - discriminator
      type: object
      properties:
        discriminator:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          readOnly: true
        type:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          readOnly: true
        isValid:
          type:
          - boolean
          - 'null'
      additionalProperties: false
      discriminator:
        propertyName: discriminator
        mapping:
          Collection: '#/components/schemas/CollectionPropertyDto'
          Custom: '#/components/schemas/CustomPropertyDto'
          Single: '#/components/schemas/SinglePropertyDto'
    RelatedDataListQueryDto:
      type: object
      properties:
        ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of entity ids to fetch
        journeyId:
          type:
          - string
          - 'null'
          description: 'Journey to also search the journey-scoped (V2) related-party data for, in addition to the

            legacy tenant-scoped records. Optional - omit to only look up legacy records.'
          format: uuid
      additionalProperties: false
      description: Request DTO to query for a list of entities
    ObjectServiceResponse_2:
      type: object
      properties:
        data:
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    StringServiceResponse_2:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-externaloutreachcommand-v1-0-openapi.json
- fenergo-externaloutreachcommand-v2-0-openapi.json
- fenergo-externaloutreachquery-v1-0-openapi.json