openapi: 3.2.0
info:
  title: Fenergo Scoped Entity API
  version: '1.0'
  description: 'Operations tagged ScopedEntity across 7 of this provider''s published API definitions: fenergo-screeningcommand-v1-0-openapi.json, fenergo-screeningcommand-v2-0-openapi.json, fenergo-screeningcommand-v3-0-openapi.json, fenergo-screeningquery-v1-0-openapi.json, fenergo-screeningquery-v2-0-openapi.json, fenergo-screeningquery-v3-0-openapi.json, fenergo-screeningquery-v4-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /screeningcommand
- url: /screeningquery
security:
- Bearer: []
tags:
- name: ScopedEntity
paths:
  /api/scoped-entity:
    post:
      tags:
      - ScopedEntity
      summary: Adds new scoped entities to a given Journey and Process
      description: 'This method is used to add new scoped entities to a given Journey and Process and set whether or not they are in scope for Screening.


        Required permissions:

        Following permissions are required: ScreeningEdit, ScreeningAccess'
      operationId: AddScopedEntities
      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: The request with the list of scoped entities to be added
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AddScopedEntitiesToJourneyProcessDtoServiceRequest'
      responses:
        '202':
          description: Accepted. The request has been accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddScopedEntityResponseDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '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
        '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:
      - ScopedEntity
      summary: Updates the entities that are in scope for Screening
      description: 'This method is used to update the entities that are in scope for Screening.


        Required permissions:

        Following permissions are required: ScreeningEdit, ScreeningAccess'
      operationId: UpdateScopedEntities
      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: The list of scoped entities to be updated
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateScopedEntityDtoListServiceRequest'
      responses:
        '202':
          description: Accepted. The request has been accepted
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '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
        '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: /screeningcommand
  /api/v2/scoped-entity:
    post:
      tags:
      - ScopedEntity
      summary: Adds new scoped entities to a given Journey and Process
      description: 'This method is used to add new scoped entities to a given Journey and Process and set whether or not they are in scope for Screening.


        Required permissions:

        Following permissions are required: ScreeningEdit, ScreeningAccess'
      operationId: postApiV2ScopedEntity
      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: The request with the list of scoped entities to be added
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AddScopedEntitiesToJourneyProcessDtoServiceRequest'
      responses:
        '202':
          description: Accepted. The request has been accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddScopedEntityResponseDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '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
        '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: AddScopedEntities
    put:
      tags:
      - ScopedEntity
      summary: Updates the entities that are in scope for Screening
      description: 'This method is used to update the entities that are in scope for Screening.


        Required permissions:

        Following permissions are required: ScreeningEdit, ScreeningAccess'
      operationId: putApiV2ScopedEntity
      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: The list of scoped entities to be updated
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateScopedEntityDtoListServiceRequest'
      responses:
        '202':
          description: Accepted. The request has been accepted
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '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
        '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: UpdateScopedEntities
    servers:
    - url: /screeningcommand
  /api/v3/scoped-entity:
    post:
      tags:
      - ScopedEntity
      summary: Adds new scoped entities to a given Journey and Process
      description: 'This method is used to add new scoped entities to a given Journey and Process and set whether or not they are in scope for Screening.


        Required permissions:

        Following permissions are required: ScreeningEdit, ScreeningAccess'
      operationId: postApiV3ScopedEntity
      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: The request with the list of scoped entities to be added
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AddScopedEntitiesToJourneyProcessDtoServiceRequest'
      responses:
        '202':
          description: Accepted. The request has been accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddScopedEntityResponseDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '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
        '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: AddScopedEntities
    put:
      tags:
      - ScopedEntity
      summary: Updates the entities that are in scope for Screening
      description: 'This method is used to update the entities that are in scope for Screening.


        Required permissions:

        Following permissions are required: ScreeningEdit, ScreeningAccess'
      operationId: putApiV3ScopedEntity
      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: The list of scoped entities to be updated
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateScopedEntityDtoListServiceRequest'
      responses:
        '202':
          description: Accepted. The request has been accepted
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '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
        '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: UpdateScopedEntities
    servers:
    - url: /screeningcommand
  /api/scoped-entity/journey/{journeyId}/process/{processId}:
    get:
      tags:
      - ScopedEntity
      summary: Get all entities in scope for Screening for a given Journey and Process
      description: 'This method returns all entities and whether or not they are in scope for Screening for a given Journey and Process.


        The method returns a list of scoped entity objects.


        Required permissions:

        Following permissions are required: ScreeningAccess'
      operationId: GetScopedEntitiesByJourneyAndProcessId
      parameters:
      - name: journeyId
        in: path
        description: The ID of the journey
        required: true
        schema:
          type: string
      - name: processId
        in: path
        description: The ID of the process that started the Screening request
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The list of entities in scope for Screening is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScopedEntityDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '500':
          description: Internal server error
        '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
        '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: /screeningquery
  /api/v2/scoped-entity/journey/{journeyId}/process/{processId}:
    get:
      tags:
      - ScopedEntity
      summary: Get all entities in scope for Screening for a given Journey and Process
      description: 'This method returns all entities and whether or not they are in scope for Screening for a given Journey and Process.


        The method returns a list of scoped entity objects.


        Required permissions:

        Following permissions are required: ScreeningAccess'
      operationId: getApiV2ScopedEntityJourneyByJourneyIdProcessByProcessId
      parameters:
      - name: journeyId
        in: path
        description: The ID of the journey
        required: true
        schema:
          type: string
      - name: processId
        in: path
        description: The ID of the process that started the Screening request
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The list of entities in scope for Screening is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScopedEntityDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '500':
          description: Internal server error
        '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
        '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: GetScopedEntitiesByJourneyAndProcessId
    servers:
    - url: /screeningquery
  /api/v3/scoped-entity/journey/{journeyId}/process/{processId}:
    get:
      tags:
      - ScopedEntity
      summary: Get all entities in scope for Screening for a given Journey and Process
      description: 'This method returns all entities and whether or not they are in scope for Screening for a given Journey and Process.


        The method returns a list of scoped entity objects.


        Required permissions:

        Following permissions are required: ScreeningAccess'
      operationId: getApiV3ScopedEntityJourneyByJourneyIdProcessByProcessId
      parameters:
      - name: journeyId
        in: path
        description: The ID of the journey
        required: true
        schema:
          type: string
      - name: processId
        in: path
        description: The ID of the process that started the Screening request
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The list of entities in scope for Screening is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScopedEntityDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '500':
          description: Internal server error
        '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
        '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: GetScopedEntitiesByJourneyAndProcessId
    servers:
    - url: /screeningquery
  /api/v4/scoped-entity/journey/{journeyId}/process/{processId}:
    get:
      tags:
      - ScopedEntity
      summary: Get all entities in scope for Screening for a given Journey and Process
      description: 'This method returns all entities and whether or not they are in scope for Screening for a given Journey and Process.


        The method returns a list of scoped entity objects.


        Required permissions:

        Following permissions are required: ScreeningAccess'
      operationId: getApiV4ScopedEntityJourneyByJourneyIdProcessByProcessId
      parameters:
      - name: journeyId
        in: path
        description: The ID of the journey
        required: true
        schema:
          type: string
      - name: processId
        in: path
        description: The ID of the process that started the Screening request
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The list of entities in scope for Screening is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScopedEntityDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '500':
          description: Internal server error
        '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
        '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: GetScopedEntitiesByJourneyAndProcessId
    servers:
    - url: /screeningquery
components:
  schemas:
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    AddScopedEntityDto:
      type: object
      properties:
        legalEntityId:
          type: string
          description: The unique ID for a Legal Entity in Fen-X
          format: uuid
          example: 12be5a50-66c2-44bb-851e-afc4fc4a28c2
        isInScopeByManualOverride:
          type: boolean
          description: Flag to manually determine if entity is in scope for Screening
          example: true
      additionalProperties: false
      description: Represents the scoped entity in the AddScopedEntitiesToJourneyProcess request
    AddScopedEntityResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The unique ID for the scoped Entity
          format: uuid
          example: 12be5a50-66c2-44bb-851e-afc4fc4a28c2
        legalEntityId:
          type: string
          description: The unique ID for a Legal Entity in Fen-X
          format: uuid
          example: 701fdce8-e347-4b0b-b94a-24fd1cfccfb1
        isInScopeByManualOverride:
          type:
          - boolean
          - 'null'
          description: Flag to manually determine if entity is in scope for Screening
        isInScopeByScopingRulesRun:
          type: boolean
          description: Flag to check if scoping rules determined that the entity is in scope for Screening
      additionalProperties: false
      description: Represents the AddScopedEntitiesToJourneyProcess response
    UpdateScopedEntityDtoListServiceRequest:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/UpdateScopedEntityDto'
      additionalProperties: false
    AddScopedEntityResponseDtoIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AddScopedEntityResponseDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    AddScopedEntitiesToJourneyProcessDto:
      type: object
      properties:
        journeyId:
          type: string
          description: The unique Fen-X identifier for the journey that the screening relates to
          format: uuid
          example: d74e1554-a09d-44c4-9bde-48cce9caeaae
        processId:
          type: string
          description: The unique Fen-X identifier for the process in the journey that the screening relates to
          format: uuid
          example: bf0ebd57-ee07-413d-b1ba-d1257487b590
        scopedEntities:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AddScopedEntityDto'
          description: List of new scoped entities
      additionalProperties: false
      description: Represents the AddScopedEntitiesToJourneyProcess request
    UpdateScopedEntityDto:
      type: object
      properties:
        id:
          type: string
          description: The unique ID for the scoped Entity
          format: uuid
          example: 12be5a50-66c2-44bb-851e-afc4fc4a28c2
        isInScopeByManualOverride:
          type: boolean
          description: Flag to manually determine if entity is in scope for Screening
          example: true
      additionalProperties: false
      description: Represents the scoped entity in the UpdateScopedEntities request
    AddScopedEntitiesToJourneyProcessDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/AddScopedEntitiesToJourneyProcessDto'
          description: Represents the AddScopedEntitiesToJourneyProcess request
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ScopedEntityDto:
      required:
      - journeyId
      - legalEntityId
      - processId
      type: object
      properties:
        id:
          type: string
          description: The unique ID for the scoped entity
          format: uuid
          example: 12be5a50-66c2-44bb-851e-afc4fc4a28c2
        legalEntityId:
          minLength: 1
          type: string
          description: The unique ID for a Legal Entity in Fen-X
          example: 679f501c-632a-474c-aca8-3ab7245d75cd
        journeyId:
          minLength: 1
          type: string
          description: The unique Fen-X identifier for the journey that the screening relates to
          example: 1eac7a8c-35bb-4202-9829-fb86fee9f388
        processId:
          minLength: 1
          type: string
          description: The unique Fen-X identifier for the process in the journey that the screening relates to
          example: aa8eb381-7457-4581-ad74-cc397e62b18c
        isInScopeByScopingRulesRun:
          type: boolean
          description: Flag to check if entity is in scope for Screening after running the scoping rules
          example: true
        isInScopeByManualOverride:
          type:
          - boolean
          - 'null'
          description: Flag to check if entity was manually set in scope for Screening
          example: true
      additionalProperties: false
      description: Represents Scoped Entity
    ScopedEntityDtoIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScopedEntityDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-screeningcommand-v1-0-openapi.json
- fenergo-screeningcommand-v2-0-openapi.json
- fenergo-screeningcommand-v3-0-openapi.json
- fenergo-screeningquery-v1-0-openapi.json
- fenergo-screeningquery-v2-0-openapi.json
- fenergo-screeningquery-v3-0-openapi.json
- fenergo-screeningquery-v4-0-openapi.json