openapi: 3.2.0
info:
  title: Fenergo Product Requirement Set API
  version: '1.0'
  description: 'Operations tagged ProductRequirementSet across 2 of this provider''s published API definitions: fenergo-productpolicycommand-v1-0-openapi.json, fenergo-productpolicyquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /productpolicycommand
- url: /productpolicyquery
security:
- Bearer: []
tags:
- name: ProductRequirementSet
paths:
  /api/product-requirement-set:
    post:
      tags:
      - ProductRequirementSet
      summary: Create product requirement set
      description: 'Creates a new product requirement set with a first draft version.


        The new version initializes with the provided data, has the default status of draft

        and the author as the only required signee.


        Required permissions:

        Following permissions are required: ProductConfigurationEdit'
      operationId: CreateProductRequirementSet
      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:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ProductRequirementSetDtoServiceRequest'
      responses:
        '202':
          description: Success. Product requirement set created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateProductRequirementSetResponseServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    get:
      tags:
      - ProductRequirementSet
      summary: Get requirement sets
      description: 'Returns all requirement sets and theirs requirements if specified in the parameter.


        Returns only requirement sets by default.


        Required permissions:

        At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess'
      operationId: GetAllProductRequirementSets
      parameters:
      - name: includeRequirements
        in: query
        description: Flag to include product requirements in the response.
        schema:
          type: boolean
          default: false
      - 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. List of product requirement sets data is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductRequirementSetDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /productpolicycommand
  /api/product-requirement-set/{setId}:
    post:
      tags:
      - ProductRequirementSet
      summary: Create product requirement set version
      description: 'Creates a new version of an existing product requirement set.


        Assigns the next available version number.


        The new version initializes with the provided data, has the default status of draft

        and the author as the only required signee.


        Required permissions:

        Following permissions are required: ProductConfigurationEdit'
      operationId: CreateProductRequirementSetVersion
      parameters:
      - name: setId
        in: path
        description: Product requirement set 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 product requirement set version request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ProductRequirementSetDtoServiceRequest'
      responses:
        '202':
          description: Success. Product requirement set version created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductRequirementSetDtoServiceResponse'
        '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. Product requirement set with given id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    delete:
      tags:
      - ProductRequirementSet
      summary: Delete product requirement set and all its versions
      description: 'Deletes an existing product requirement set and all its versions.


        Required permissions:

        Following permissions are required: ProductConfigurationDelete'
      operationId: DeleteProductRequirementSet
      parameters:
      - name: setId
        in: path
        description: Product requirement set 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. Product requirement set deleted
        '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. Product requirement set with given id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    get:
      tags:
      - ProductRequirementSet
      summary: Get product requirement set by id
      description: 'Returns the active, currently in effect, published product requirement set version for a given id.


        Required permissions:

        At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess'
      operationId: GetProductRequirementSetById
      parameters:
      - name: setId
        in: path
        description: Product requirement set id
        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. Product requirement set is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductRequirementSetVersionDtoServiceResponse'
        '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. Product Requirement set with given id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /productpolicycommand
  /api/product-requirement-set/{setId}/version/{versionNumber}/draft:
    post:
      tags:
      - ProductRequirementSet
      summary: Create product requirement set version from provided set id
      description: 'Creates a new version of an existing product requirement set.


        Assigns the next available version number.


        The new version initializes with the latest published product requirement set data, has the default status of draft

        and the author as the only required signee.


        Required permissions:

        Following permissions are required: ProductConfigurationEdit'
      operationId: CreateProductRequirementSetVersionFromSetId
      parameters:
      - name: setId
        in: path
        description: Product requirement set id
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: Version number to create new draft from
        required: true
        schema:
          type: integer
          format: int32
      - 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. Product requirement set version created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateProductRequirementSetVersionFromSetIdResponseServiceResponse'
        '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. Product requirement set with given id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /productpolicycommand
  /api/product-requirement-set/{setId}/version/{versionNumber}:
    put:
      tags:
      - ProductRequirementSet
      summary: Update product requirement set version
      description: 'Updates an existing product requirement set version. Only draft and rejected versions are allowed to be updated.


        Required permissions:

        Following permissions are required: ProductConfigurationEdit'
      operationId: UpdateProductRequirementSetVersion
      parameters:
      - name: setId
        in: path
        description: Product requirement set id
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: Version number to update
        required: true
        schema:
          type: integer
          format: int32
      - 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 product requirement set version request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateProductRequirementSetVersionDtoServiceRequest'
      responses:
        '202':
          description: Success. Product requirement set version updated
        '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. Product requirement set 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
        '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:
      - ProductRequirementSet
      summary: Delete product requirement set version
      description: 'Deletes the selected version of an existing product requirement set.


        If the version is the last one, then the version number of it will become the next available one for the model.

        Otherwise, the version number will be flagged as deleted and become unavailable.


        Required permissions:

        Following permissions are required: ProductConfigurationDelete'
      operationId: DeleteProductRequirementSetVersion
      parameters:
      - name: setId
        in: path
        description: Product requirement set id
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: Version number to delete
        required: true
        schema:
          type: integer
          format: int32
      - 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. Product requirement set version deleted
        '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. Product requirement set with given id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    get:
      tags:
      - ProductRequirementSet
      summary: Get product requirement set by id and version
      description: 'Returns product requirement set for a given id and version number.


        Required permissions:

        At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess'
      operationId: GetProductRequirementSetVersionById
      parameters:
      - name: setId
        in: path
        description: Product requirement set id
        required: true
        schema:
          type: string
      - name: versionNumber
        in: path
        description: Product requirement set version number
        required: true
        schema:
          type: integer
          format: int32
      - 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. Product requirement set is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductRequirementSetVersionDtoServiceResponse'
        '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. Product requirement set with given id/version does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /productpolicycommand
  /api/product-requirement-set/{productRequirementSetId}/version/{versionNumber}/clone:
    post:
      tags:
      - ProductRequirementSet
      summary: Clone product requirement set version
      description: 'Clones the selected version of an existing product requirement set and creates a new model with a single version.


        The new version contains all the data of the original selected one,

        will have the default status of draft and the author as the only required signee.


        Returns the id of the cloned product requirement set version.


        Required permissions:

        Following permissions are required: ProductConfigurationEdit'
      operationId: CloneProductRequirementSetVersion
      parameters:
      - name: productRequirementSetId
        in: path
        description: Product requirement set id
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: Version number to clone
        required: true
        schema:
          type: integer
          format: int32
      - 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: Clone Product requirement set version request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CloneProductRequirementSetVersionDtoServiceRequest'
      responses:
        '202':
          description: Success. Product requirement set version cloned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloneProductRequirementSetVersionResponseServiceResponse'
        '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. Product requirement set with given id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /productpolicycommand
  /api/product-requirement-set/{setId}/version/{versionNumber}/submit-for-approval:
    put:
      tags:
      - ProductRequirementSet
      summary: Submit product requirement set version for approval
      description: 'Submits the selected version of an existing product requirement set for approval.


        Required permissions:

        Following permissions are required: ProductConfigurationEdit'
      operationId: SubmitProductRequirementSetVersion
      parameters:
      - name: setId
        in: path
        description: Product requirement set id
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: Version number to submit
        required: true
        schema:
          type: integer
          format: int32
      - 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. Product requirement set version submitted
        '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. Product requirement set with given id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /productpolicycommand
  /api/product-requirement-set/{setId}/version/{versionNumber}/sign:
    put:
      tags:
      - ProductRequirementSet
      summary: Sign product requirement set version
      description: 'Signs the selected version of an existing product requirement set and changes the version status accordingly to the action (Approve/Reject).


        Required permissions:

        Following permissions are required: ProductConfigurationApprove'
      operationId: SignProductRequirementSetVersion
      parameters:
      - name: setId
        in: path
        description: Product requirement set id
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: Version number to sign
        required: true
        schema:
          type: integer
          format: int32
      - 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: Sign product requirement set version request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApproveActionServiceRequest'
      responses:
        '202':
          description: Success. Product requirement set version signed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductRequirementSetVersionSignResponseServiceResponse'
        '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. Product requirement set with given id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /productpolicycommand
  /api/product-requirement-set/{setId}/version/{versionNumber}/archive:
    put:
      tags:
      - ProductRequirementSet
      summary: Archive product requirement set version
      description: 'Archives the selected version of an existing product requirement set.


        Required permissions:

        Following permissions are required: ProductConfigurationArchive'
      operationId: ArchiveProductRequirementSetVersion
      parameters:
      - name: setId
        in: path
        description: Product requirement set id
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: Version number to archive
        required: true
        schema:
          type: integer
          format: int32
      - 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. Product requirement set version archived
        '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. Product requirement set with given id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /productpolicycommand
  /api/product-requirement-set/{id}/version/{versionNumber}/field:
    post:
      tags:
      - ProductRequirementSet
      summary: Add requirement
      description: 'Adds a new product requirement to an existing product requirement set.


        Returns the id of the created product requirement.


        Required permissions:

        Following permissions are required: ProductConfigurationEdit'
      operationId: AddProductRequirement
      parameters:
      - name: id
        in: path
        description: Product requirement set id
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: Product requirement set version number
        required: true
        schema:
          type: integer
          format: int32
      - 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: Add product requirement request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ProductRequirementDtoServiceRequest'
      responses:
        '202':
          description: Success. Product requirement added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemCreatedDtoServiceResponse'
        '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. Product requirement set with given id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    put:
      tags:
      - ProductRequirementSet
      summary: Update requirement
      description: 'Updates an existing product requirement in specific product requirement set.


        Required permissions:

        Following permissions are required: ProductConfigurationEdit'
      operationId: UpdateProductRequirement
      parameters:
      - name: id
        in: path
        description: Product requirement set id
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: Product requirement set version number
        required: true
        schema:
          type: integer
          format: int32
      - 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 product requirement request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateProductRequirementDtoServiceRequest'
      responses:
        '202':
          description: Success. Product requirement updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateProductRequirementDtoServiceResponse'
        '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. Product requirement set 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
        '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: /productpolicycommand
  /api/product-requirement-set/{id}/version/{versionNumber}/field/{fieldId}:
    delete:
      tags:
      - ProductRequirementSet
      summary: Delete requirement
      description: 'Deletes an existing product requirement in specific product requirement set.


        Required permissions:

        Following permissions are required: ProductConfigurationEdit'
      operationId: DeleteProductRequirement
      parameters:
      - name: id
        in: path
        description: Product requirement set id
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: Product requirement set version number
        required: true
        schema:
          type: integer
          format: int32
      - name: fieldId
        in: path
        description: Product requirement id to delete
        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. Product requirement deleted
        '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. Product requirement set/requirement with given id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /productpolicycommand
  /api/product-requirement-set/{setId}/version/{versionNumber}/update-product-requirements-dataprotection-jurisdiction:
    put:
      tags:
      - ProductRequirementSet
      summary: Update product pequirements DataProtectionJurisdiction
      description: 'Update DataProtectionJurisdiction for all Product requirements in specified Product Requirement Set using DefaultDataProtectionJurisdiction


        Required permissions:

        Following permissions are required: ProductConfigurationEdit'
      operationId: UpdateProductRequirementsDataProtectionJurisdiction
      parameters:
      - name: setId
        in: path
        description: Product requirement set id
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: Version number to update data protection jurisdiction
        required: true
        schema:
          type: integer
          format: int32
      - 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. Requirement set attributes updated with default data protection jurisdiction
        '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. Requirement set with given id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /productpolicycommand
  /api/product-requirement-set/{setId}/version/{versionNumber}/field/{id}:
    get:
      tags:
      - ProductRequirementSet
      summary: Get requirement by id
      description: 'Returns requirement by given product requirement set id, requirement set version number and requirement id.


        Required permissions:

        At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess'
      operationId: GetProductRequirementById
      parameters:
      - name: setId
        in: path
        description: Product requirement set id
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: Product requirement set version number
        required: true
        schema:
          type: integer
          format: int32
      - name: id
        in: path
        description: Product requirement 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:
        '200':
          description: Success. Product requirement is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductRequirementDtoServiceResponse'
        '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. Product requirement set/requirement with given id/version does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /productpolicyquery
  /api/product-requirement-set/jurisdictions:
    get:
      tags:
      - ProductRequirementSet
      summary: Get jurisdictions
      description: 'Returns all jurisdictions available in tenant product requirement sets


        Required permissions:

        At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess'
      operationId: GetJurisdictions
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. List of available jurisdictions is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequirementSetJurisdictionDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /productpolicyquery
components:
  schemas:
    CollectionMinimumCountRuleDtoValidationRuleDto:
      type: object
      properties:
        isActive:
          type: boolean
        staticRule:
          allOf:
          - $ref: '#/components/schemas/CollectionMinimumCountRuleDto2'
      additionalProperties: false
    ValueLimitRuleDtoConditionalValueDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        logicalOperation:
          type:
          - string
          - 'null'
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto'
        value:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDto2'
        priority:
          type: integer
          format: int32
      additionalProperties: false
    ExternalProviderRuleDto:
      allOf:
      - $ref: '#/components/schemas/BasicRuleDto'
      - type: object
        properties:
          providerId:
            type: string
            format: uuid
        additionalProperties: false
    UpdateProductRequirementSetVersionDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateProductRequirementSetVersionDto'
          description: Request DTO representing set of properties which define a new version of product requirement set
      additionalProperties: false
    DateLimitRangeDto:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        relativeTo:
          type:
          - string
          - 'null'
        source:
          type:
          - string
          - 'null'
        field:
          type:
          - string
          - 'null'
        offset:
          type:
          - string
          - 'null'
        periodType:
          type:
          - string
          - 'null'
        offsetPeriod:
          type:
          - string
          - 'null'
      additionalProperties: false
    SpecialCharactersRuleDtoValidationRuleDto:
      type: object
      properties:
        isActive:
          type: boolean
        staticRule:
          allOf:
          - $ref: '#/components/schemas/SpecialCharactersRuleDto2'
      additionalProperties: false
    DateLimitRuleDto4:
      type: object
      properties:
        errorMessage:
          type:
          - string
          - 'null'
        minDate:
          type:
          - string
          - 'null'
          format: date-time
        maxDate:
          type:
          - string
          - 'null'
          format: date-time
        rangeFrom:
          allOf:
          - $ref: '#/components/schemas/DateLimitRangeDto'
        rangeTo:
          allOf:
          - $ref: '#/components/schemas/DateLimitRangeDto'
      additionalProperties: false
    ValidationDataDto:
      type: object
      properties:
        isMandatory:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
        specialCharacters:
          allOf:
          - $ref: '#/components/schemas/SpecialCharactersRuleDto'
        noNumbers:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
        onlyInteger:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
        noNegative:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
        onlyDecimal:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
        regex:
          allOf:
          - $ref: '#/components/schemas/RegexRuleDto'
        characterLimit:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDto'
        numberLimit:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDto'
        noFutureDates:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
        noPastDates:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
        dateLimit:
          allOf:
          - $ref: '#/components/schemas/DateLimitRuleDto2'
          description: Validation rule that allows to set date range
        multiSelectLimit:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDto'
        collectionMinimumCount:
          allOf:
          - $ref: '#/components/schemas/CollectionMinimumCountRuleDto'
        collectionMaximumCount:
          allOf:
          - $ref: '#/components/schemas/CollectionMaximumCountRuleDto'
        externalProvider:
          allOf:
          - $ref: '#/components/schemas/ExternalProviderRuleDto'
        externalDataGroupProvider:
          allOf:
          - $ref: '#/components/schemas/ExternalProviderRuleDto'
        disallowTodaysDate:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
          description: Validation rule that does not allow todays date
      additionalProperties: false
      description: Request DTO representing validation data metadata
    CommonRequirementSetDto:
      type: object
      properties:
        setId:
          type: string
          description: The UiD of the data requirement set
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        name:
          type:
          - string
          - 'null'
          description: Requirement set name
          example: Fenergo Comprehensive Standard Policy Requirements
        jurisdiction:
          type:
          - string
          - 'null'
          description: Requirement set jurisdiction
          example: Global
        conditions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDto'
          description: Conditions under which the requirement set can be applied
        versionNumber:
          type: integer
          description: The versions number
          format: int32
          example: 1
        effectiveFrom:
          type: string
          description: The date that the version takes effect when published
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        signees:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Signee'
          description: The defined list of signees for the version
      additionalProperties: false
      description: Request DTO representing requirement set data
    BasicRuleDto:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    CreateProductRequirementSetResponseServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateProductRequirementSetResponse'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ConditionDto:
      required:
      - logicalOperation
      - name
      - operands
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          minLength: 1
          type: string
        description:
          type:
          - string
          - 'null'
        logicalOperation:
          minLength: 1
          type: string
        operands:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto'
      additionalProperties: false
      example:
        id: 118313c6-91e6-4b05-a537-5a1ab906418f
        name: Company-type only
        description: Applicable only when EntityType=Company
        logicalOperation: AND
        operands:
        - fieldName: EntityType
          value:
          - string
          valueType: text
          operation: equal
          operands: []
    RegexRuleDtoConditionalValidationRuleDto:
      type: object
      properties:
        isActive:
          type: boolean
        staticRule:
          allOf:
          - $ref: '#/components/schemas/RegexRuleDto2'
        dynamicRules:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RegexRuleDtoConditionalValueDto'
      additionalProperties: false
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    OwnershipValidationDataDto:
      type: object
      properties:
        isMandatory:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
          description: Mandatory requirement
        partyCount:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDto'
          description: What is the minimum number of relationships that need to be added in order for this requirement to be fulfilled?
        addAllParties:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
          description: Is the unwrapping requirement non-calculable?
        idvIsMandatory:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
          description: Mandatory ID&V
        idvPartyCount:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDto'
          description: What is the minimum number of relationships that need to be ID&Vd in order for this requirement to be fulfilled?
        idvAllParties:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
          description: Do all entities that meet the criteria of this requirement need to be ID&Vd?
      additionalProperties: false
    ValueField:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
        field:
          type:
          - string
          - 'null'
      additionalProperties: false
    Decision:
      enum:
      - Approve
      - Reject
      type: string
    ValueLimitRuleDto2:
      allOf:
      - $ref: '#/components/schemas/BasicRuleDto2'
      - type: object
        properties:
          minValue:
            type:
            - integer
            - 'null'
            format: int32
          maxValue:
            type:
            - integer
            - 'null'
            format: int32
        additionalProperties: false
    ProductRequirementSetVersionSignResponse:
      type: object
      properties:
        setId:
          type: string
          description: The UiD of the product requirement set
          format: uuid
        versionNumber:
          type: integer
          description: The number of the version that has been signed
          format: int32
          example: 2
        status:
          allOf:
          - $ref: '#/components/schemas/VersionStatus'
          description: The new version status
          example: Rejected
      additionalProperties: false
      description: Sign product requirement set response contains the new version status
    ConditionDefinitionDto:
      type: object
      properties:
        fieldName:
          type:
          - string
          - 'null'
        value:
          type:
          - array
          - 'null'
          items:
            type: string
        valueId:
          type:
          - array
          - 'null'
          items:
            type: string
        valueType:
          type:
          - string
          - 'null'
        dataSource:
          type:
          - string
          - 'null'
        operation:
          type:
          - string
          - 'null'
        logicalOperation:
          type:
          - string
          - 'null'
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto'
        valueField:
          allOf:
          - $ref: '#/components/schemas/ValueField'
      additionalProperties: false
    RegexRuleDto:
      allOf:
      - $ref: '#/components/schemas/BasicRuleDto'
      - type: object
        properties:
          isCaseSensitive:
            type: boolean
          regexValue:
            type:
            - string
            - 'null'
        additionalProperties: false
    UpdateProductRequirementDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateProductRequirementDto'
          description: Request DTO representing requirement metadata
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    BasicRuleDtoConditionalValidationRuleDto:
      type: object
      properties:
        isActive:
          type: boolean
        staticRule:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto2'
        dynamicRules:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/BasicRuleDtoConditionalValueDto'
      additionalProperties: false
    DateLimitRuleDtoConditionalValueDto2:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        logicalOperation:
          type:
          - string
          - 'null'
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto'
        value:
          allOf:
          - $ref: '#/components/schemas/DateLimitRuleDto4'
        priority:
          type: integer
          format: int32
      additionalProperties: false
    DateTimePeriodFormulaSchemaDto:
      required:
      - formulaSetId
      - formulaString
      type: object
      properties:
        formulaSetId:
          minLength: 1
          type: string
          description: Formula set id
          format: uuid
          example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c
        versionNumber:
          type:
          - integer
          - 'null'
          description: Formula version number
          format: int32
          example: 1
        formulaString:
          minLength: 1
          type: string
          description: Formula string
        dateTimePeriodFormulaVariables:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/DateTimePeriodFormulaVariableDto'
          description: Details of the formula schema
      additionalProperties: false
    ItemCreatedDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ItemCreatedDto'
          description: Response DTO representing created Item Instance
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    CreateProductRequirementSetVersionFromSetIdResponse:
      type: object
      properties:
        setId:
          type: string
          format: uuid
        versionNumber:
          type: integer
          format: int32
      additionalProperties: false
    DateTimePeriodFormulaVariableDto:
      required:
      - value
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
        timePeriodKind:
          type:
          - string
          - 'null'
        value:
          minLength: 1
          type: string
        type:
          type:
          - string
          - 'null'
        timeZoneId:
          type:
          - string
          - 'null'
      additionalProperties: false
    RegexRuleDto2:
      allOf:
      - $ref: '#/components/schemas/BasicRuleDto2'
      - type: object
        properties:
          isCaseSensitive:
            type: boolean
          regexValue:
            type:
            - string
            - 'null'
        additionalProperties: false
    AccessLayerDto:
      required:
      - businessRelated
      - geographic
      type: object
      properties:
        geographic:
          type: array
          items:
            minLength: 1
            type: string
          description: Collection of geographic access layers
        businessRelated:
          type: array
          items:
            minLength: 1
            type: string
          description: Collection of business related access layers
      additionalProperties: false
      description: DTO representing associated access layers
    OwnershipValidationRuleDto:
      type: object
      properties:
        id:
          type: string
          description: The UiD of the ownership validation rule
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        setId:
          type: string
          description: The UiD of the requirement set
          format: uuid
          example: 012cfe3a-7bfa-41e7-8269-d49b3b38dff3
        ownershipValidationData:
          allOf:
          - $ref: '#/components/schemas/OwnershipValidationDataDto'
          description: Ownership Validation Data - set of validation rules specific to ownership requirement
      additionalProperties: false
    ReferenceDto:
      type: object
      properties:
        type:
          maxLength: 256
          type:
          - string
          - 'null'
          description: Reference type
          example: FATCA
        description:
          maxLength: 2048
          type:
          - string
          - 'null'
          description: Reference description
          example: Foreign Account Tax Compliance Act
        url:
          maxLength: 2048
          type:
          - string
          - 'null'
          description: Reference URL
          example: www.irs.gov
      additionalProperties: false
      description: Request DTO representing reference metadata
    ProductRequirementDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ProductRequirementDto'
          description: Request DTO representing product requirement metadata
      additionalProperties: false
    ProductRequirementSetDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ProductRequirementSetDto'
          description: Request DTO representing product requirement set data
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    StringConditionalValueDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        logicalOperation:
          type:
          - string
          - 'null'
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto'
        value:
          type:
          - string
          - 'null'
        priority:
          type: integer
          format: int32
      additionalProperties: false
    DateLimitRuleDto2:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        minDate:
          type:
          - string
          - 'null'
          format: date-time
        maxDate:
          type:
          - string
          - 'null'
          format: date-time
        rangeFrom:
          allOf:
          - $ref: '#/components/schemas/DateLimitRangeDto'
        rangeTo:
          allOf:
          - $ref: '#/components/schemas/DateLimitRangeDto'
      additionalProperties: false
    BasicRuleDto2:
      type: object
      properties:
        errorMessage:
          type:
          - string
          - 'null'
      additionalProperties: false
    CloneProductRequirementSetVersionResponse:
      type: object
      properties:
        requirementSetId:
          type: string
          description: Id of the cloned product requirement set
          format: uuid
        expectedRequirementCount:
          type: integer
          description: Expected number of requirements of the cloned product requirement set
          format: int32
      additionalProperties: false
      description: Request DTO representing clone product requirement set data
    EmptyRuleDto:
      type: object
      additionalProperties: false
    BasicRuleDtoConditionalValueDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        logicalOperation:
          type:
          - string
          - 'null'
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto'
        value:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto2'
        priority:
          type: integer
          format: int32
      additionalProperties: false
    ProductRequirementSetVersionSignResponseServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ProductRequirementSetVersionSignResponse'
          description: Sign product requirement set response contains the new version status
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ExternalProviderRuleDtoValidationRuleDto:
      type: object
      properties:
        isActive:
          type: boolean
        staticRule:
          allOf:
          - $ref: '#/components/schemas/ExternalProviderRuleDto2'
      additionalProperties: false
    CloneProductRequirementSetVersionDto:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Product Requirement Set Name
          example: Fenergo Comprehensive Standard Policy Requirements
        jurisdiction:
          type:
          - string
          - 'null'
          description: Product Requirement Set Jurisdiction
          example: Global
      additionalProperties: false
    ValueLimitRuleDtoConditionalValidationRuleDto:
      type: object
      properties:
        isActive:
          type: boolean
        staticRule:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDto2'
        dynamicRules:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValueLimitRuleDtoConditionalValueDto'
      additionalProperties: false
    ProductRequirementSetDto:
      allOf:
      - $ref: '#/components/schemas/CommonRequirementSetDto'
      - type: object
        properties:
          created:
            type: string
            description: The creation date of the version (Read-only)
            format: date-time
            example: '2021-01-01T14:48:00.000Z'
          status:
            allOf:
            - $ref: '#/components/schemas/VersionStatus'
            description: The status of the version
            example: Draft
          requirements:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/ProductRequirementDto'
            description: List of requirements
        additionalProperties: false
      description: Request DTO representing product requirement set data
    UpdateProductRequirementSetVersionDto:
      allOf:
      - $ref: '#/components/schemas/CommonRequirementSetDto'
      - type: object
        properties:
          requirements:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/ProductRequirementDto'
            description: List of requirements
          defaultDataProtectionJurisdiction:
            type:
            - string
            - 'null'
            description: Default data protection jurisdiction for requirement set
            example: Global
          version:
            type: integer
            description: "Current version of Data Group aggregate where the changes needs to be applied. 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
            example: 5
        additionalProperties: false
      description: Request DTO representing set of properties which define a new version of product requirement set
    VersionStatus:
      enum:
      - Draft
      - Pending
      - Rejected
      - Published
      - Archived
      - Deleted
      type: string
    CollectionMinimumCountRuleDto2:
      allOf:
      - $ref: '#/components/schemas/BasicRuleDto2'
      - type: object
        properties:
          requiredTypesMinCount:
            type:
            - object
            - 'null'
            additionalProperties:
              type: integer
              format: int32
          overallMinimumCount:
            type: integer
            format: int32
        additionalProperties: false
    CloneProductRequirementSetVersionDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CloneProductRequirementSetVersionDto'
      additionalProperties: false
    CreateProductRequirementSetResponse:
      allOf:
      - $ref: '#/components/schemas/ProductRequirementSetDto'
      - type: object
        properties:
          defaultDataProtectionJurisdiction:
            type:
            - string
            - 'null'
        additionalProperties: false
    BasicRuleDtoValidationRuleDto:
      type: object
      properties:
        isActive:
          type: boolean
        staticRule:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto2'
      additionalProperties: false
    SpecialCharactersRuleDto:
      allOf:
      - $ref: '#/components/schemas/BasicRuleDto'
      - type: object
        properties:
          excludedCharacters:
            type:
            - array
            - 'null'
            items:
              type: string
        additionalProperties: false
    DataFieldDto:
      required:
      - propertyName
      - propertyType
      type: object
      properties:
        propertyName:
          minLength: 1
          type: string
          description: Property name
          example: firstName
        propertyType:
          minLength: 1
          type: string
          description: Property type
          example: text
        propertyTypeId:
          type:
          - string
          - 'null'
          description: Property type id
          format: uuid
          example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c
        linkChildFieldPropertyName:
          type:
          - string
          - 'null'
          description: Linked child field property name
          example: productCategory
        linkedParentFieldPropertyName:
          type:
          - string
          - 'null'
          description: Linked Parent field property name
          example: productCategory
        formulaSchema:
          allOf:
          - $ref: '#/components/schemas/FormulaSchemaDto'
          description: Number formula schema
        dateTimePeriodFormulaSchema:
          allOf:
          - $ref: '#/components/schemas/DateTimePeriodFormulaSchemaDto'
          description: Date formula schema
        customActionProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: 'Properties which can be passed to a custom action function in the UI, provided as

            basic string key-value pairs to allow action functions to be created generically.'
        externalSearchApiProviderId:
          type:
          - string
          - 'null'
          description: ExternalSearchApiProviderId
          format: uuid
      additionalProperties: false
      description: Request DTO representing data field metadata
    CollectionMaximumCountRuleDtoValidationRuleDto:
      type: object
      properties:
        isActive:
          type: boolean
        staticRule:
          allOf:
          - $ref: '#/components/schemas/CollectionMaximumCountRuleDto2'
      additionalProperties: false
    Signee:
      type: object
      properties:
        subject:
          type:
          - string
          - 'null'
        successor:
          allOf:
          - $ref: '#/components/schemas/Approver'
        action:
          allOf:
          - $ref: '#/components/schemas/ApproveAction'
        hasProcessedRequest:
          type: boolean
          readOnly: true
      additionalProperties: false
    DateLimitRuleDtoConditionalValidationRuleDto2:
      type: object
      properties:
        isActive:
          type: boolean
        staticRule:
          allOf:
          - $ref: '#/components/schemas/DateLimitRuleDto4'
        dynamicRules:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DateLimitRuleDtoConditionalValueDto2'
      additionalProperties: false
    CollectionMaximumCountRuleDto:
      allOf:
      - $ref: '#/components/schemas/BasicRuleDto'
      - type: object
        properties:
          requiredTypesMaxCount:
            type:
            - object
            - 'null'
            additionalProperties:
              type: integer
              format: int32
          overallMaximumCount:
            type:
            - integer
            - 'null'
            format: int32
        additionalProperties: false
    RegexRuleDtoConditionalValueDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        logicalOperation:
          type:
          - string
          - 'null'
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto'
        value:
          allOf:
          - $ref: '#/components/schemas/RegexRuleDto2'
        priority:
          type: integer
          format: int32
      additionalProperties: false
    UpdateProductRequirementDto:
      allOf:
      - $ref: '#/components/schemas/ProductRequirementDto'
      - type: object
        properties:
          version:
            type: integer
            description: "Current version of Data Group aggregate where the changes needs to be applied. 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
            example: 5
        additionalProperties: false
      description: Request DTO representing requirement metadata
    ValidationRuleDto:
      type: object
      properties:
        id:
          type: string
          description: The UiD of the validation rule
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        setId:
          type: string
          description: The UiD of the requirement set/data group
          format: uuid
          example: 012cfe3a-7bfa-41e7-8269-d49b3b38dff3
        propertyId:
          type: string
          description: The UiD of the requirement/data group field
          format: uuid
          example: 450df9bf-b2d3-48cf-ab8d-481c69b74373
        dataGroupId:
          type:
          - string
          - 'null'
          description: The UiD of the of data group - is set only when requirement/data group field propertyType is set to "dataGroup"
          format: uuid
          example: 8eb83ec6-1539-46a9-b0ba-c5138a09580c
        isDataGroup:
          type: boolean
          description: Flag indicating it is validation rules for data group field
          example: true
        propertyName:
          type:
          - string
          - 'null'
          description: Requirement/data group field property name
          example: firstName
        friendlyName:
          type:
          - string
          - 'null'
          description: Requirement/data group field friendly Name
          example: First Name
        validationType:
          type:
          - string
          - 'null'
          description: Validation type
          example: text
        validationData:
          allOf:
          - $ref: '#/components/schemas/ValidationDataDto'
          description: Validation Data - set of validation rules specific to requirement/data group field
      additionalProperties: false
      description: Request DTO representing validation rule metadata
    ApproveActionServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ApproveAction'
      additionalProperties: false
    ProductRequirementDto:
      required:
      - category
      - entityType
      - jurisdiction
      - type
      type: object
      properties:
        identifier:
          type: string
          description: The UiD of the requirement
          format: uuid
          example: 84ec28e2-d786-417b-850f-96321dd849dd
        requirementSetId:
          type: string
          description: The UiD of the requirement set
          format: uuid
          example: 228313c6-91e6-4b05-a537-5a1ab906418f
        category:
          minLength: 1
          type: string
          description: Requirement business category
          example: Basic Details
        description:
          type:
          - string
          - 'null'
          description: Requirement description
          example: This is the client first name
        template:
          type:
          - string
          - 'null'
          description: Requirement template
          example: Product
        entityType:
          minLength: 1
          type: string
          description: Requirement entity type
          example: Individual
        name:
          type:
          - string
          - 'null'
          description: Requirement name
          example: First Name
        order:
          type:
          - number
          - 'null'
          description: Requirement the order which the field will appears
          format: double
          example: 1
        isSensitiveData:
          type: boolean
          description: Requirement sensitive data flag
          example: true
        isMaterialData:
          type: boolean
          description: Requirement material data flag
          example: true
        isCoreDefinition:
          type: boolean
          description: 'Requirement is defined as core

            and cannot be deleted or altered'
          example: false
        isIndexable:
          type: boolean
          description: Requirement is data indexed for search flag
          example: true
        isSecondaryIdentifier:
          type: boolean
          description: Is this requirement used to search and filter on products
          example: true
        jurisdiction:
          minLength: 1
          type: string
          description: Requirement jurisdiction
          example: Global
        dataProtectionJurisdiction:
          type:
          - string
          - 'null'
          description: Jurisdiction for data protection
          example: Global
        classification:
          type:
          - string
          - 'null'
          description: Requirement classification
          example: Customer Profiling
        isReadOnly:
          type: boolean
          description: Read-only flag
          example: true
        isMandatory:
          type: boolean
          description: Requirement mandatory flag
          example: true
        targetEntity:
          type:
          - string
          - 'null'
          description: Requirement target entity
          example: Client
        type:
          minLength: 1
          type: string
          description: Requirement type
          example: Data
        documentDescription:
          type:
          - string
          - 'null'
          description: Requirement document description
          example: Articles of Incorporation
        documentDataKey:
          type:
          - string
          - 'null'
          description: Requirement document datakey
          example: Passport
        acceptableDocumentTypes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Acceptable document types for the document requirement
        partyType:
          type:
          - string
          - 'null'
          description: Requirement party type
          example: Shareholder
          deprecated: true
        partyTypes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Requirement party types
        partyCount:
          type:
          - integer
          - 'null'
          description: Requirement party count
          format: int32
          example: 1
          deprecated: true
        uboThreshold:
          type:
          - number
          - 'null'
          description: Requirement UBO threshold
          format: double
          example: 10
        ownershipDataKey:
          type:
          - string
          - 'null'
          description: The datakey that is used to identify this requirement
          example: seniorManagersRequirement
        sourceEntityType:
          type:
          - string
          - 'null'
          description: Any of the related party entity types selected can be counted toward this requirement
          example: Individual
          deprecated: true
        relatedPartyEntityTypes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Requirement related party entity types
        directAssociationsOnly:
          type: boolean
          description: When enabled, only related parties directly associated to the main client entity will be counted towards this requirement
          example: true
        idvOn:
          type: boolean
          description: Is there an ID&V element applicable to this requirement?
          example: true
        idvName:
          type:
          - string
          - 'null'
          description: Name of the ID&V requirement and label which will be applied to the ID&V chip
          example: ID&V 1 Senior Manager
        idvTooltip:
          type:
          - string
          - 'null'
          description: Tooltip description of the ID&V requirement
          example: At Least one CEO, CFO, COO, CTO, Board Member or Executive Director must be ID&Vd
        ownershipValidationRule:
          allOf:
          - $ref: '#/components/schemas/OwnershipValidationRuleDto'
          description: Ownership requirement validation data
        dataField:
          allOf:
          - $ref: '#/components/schemas/DataFieldDto'
          description: Requirement data field
        references:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ReferenceDto'
          description: Requirement references list
        conditions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDto'
          description: Requirement conditions list
        validationRule:
          allOf:
          - $ref: '#/components/schemas/ValidationRuleDto'
          description: Requirement validation data
        validationRulesV2:
          allOf:
          - $ref: '#/components/schemas/DataValidationRulesDto'
          description: Data requirement validation rules V2
        defaultValue:
          type:
          - string
          - 'null'
        documentAccessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Access layers determining the access to the document
        conditionalValues:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionalValueDto'
          description: List of conditional values
        tags:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of tags
        fieldAccessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Access layers determining the access to the field
        defaultDateType:
          type:
          - string
          - 'null'
          description: Default Date Type e.g. Standard Default Value
          example: 'true'
        isTotalProductColumn:
          type: boolean
          description: Specifies is field is going to be displayed with a total summation
          example: true
        uiDecoration:
          type:
          - string
          - 'null'
          description: 'Determines how the requirement should be rendered

            <example>null</example>'
        clearValueIfTriggerConditionNotMet:
          type: boolean
          description: When enabled, the field value is cleared if its trigger condition is not met
          example: true
      additionalProperties: false
      description: Request DTO representing product requirement metadata
    FormulaSchemaDto:
      required:
      - formulaSetId
      - formulaString
      type: object
      properties:
        formulaSetId:
          minLength: 1
          type: string
          description: Formula set id
          format: uuid
          example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c
        versionNumber:
          type:
          - integer
          - 'null'
          description: Formula set version number
          format: int32
          example: 1
        formulaString:
          minLength: 1
          type: string
          description: Formula string will be used to perform calculation
          example: $1 + $2
        formulaVariables:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/FormulaVariableDto'
          description: Metadata argument in formula string
      additionalProperties: false
    CloneProductRequirementSetVersionResponseServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CloneProductRequirementSetVersionResponse'
          description: Request DTO representing clone product requirement set data
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    EmptyRuleDtoConditionalValueDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        logicalOperation:
          type:
          - string
          - 'null'
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto'
        value:
          allOf:
          - $ref: '#/components/schemas/EmptyRuleDto'
        priority:
          type: integer
          format: int32
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    ExternalProviderRuleDto2:
      allOf:
      - $ref: '#/components/schemas/EmptyRuleDto'
      - type: object
        properties:
          providerId:
            type: string
            format: uuid
        additionalProperties: false
    ConditionalValueDto:
      allOf:
      - $ref: '#/components/schemas/StringConditionalValueDto'
      - type: object
        properties:
          valueId:
            type:
            - string
            - 'null'
        additionalProperties: false
    SpecialCharactersRuleDto2:
      allOf:
      - $ref: '#/components/schemas/BasicRuleDto2'
      - type: object
        properties:
          excludedCharacters:
            type:
            - array
            - 'null'
            items:
              type: string
        additionalProperties: false
    ValueLimitRuleDtoValidationRuleDto:
      type: object
      properties:
        isActive:
          type: boolean
        staticRule:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDto2'
      additionalProperties: false
    EmptyRuleDtoConditionalValidationRuleDto:
      type: object
      properties:
        isActive:
          type: boolean
        staticRule:
          allOf:
          - $ref: '#/components/schemas/EmptyRuleDto'
        dynamicRules:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EmptyRuleDtoConditionalValueDto'
      additionalProperties: false
    CollectionMaximumCountRuleDto2:
      allOf:
      - $ref: '#/components/schemas/BasicRuleDto2'
      - type: object
        properties:
          requiredTypesMaxCount:
            type:
            - object
            - 'null'
            additionalProperties:
              type: integer
              format: int32
          overallMaximumCount:
            type:
            - integer
            - 'null'
            format: int32
        additionalProperties: false
    UpdateProductRequirementDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateProductRequirementDto'
          description: Request DTO representing requirement metadata
      additionalProperties: false
    ValueLimitRuleDto:
      allOf:
      - $ref: '#/components/schemas/BasicRuleDto'
      - type: object
        properties:
          minValue:
            type:
            - integer
            - 'null'
            format: int32
          maxValue:
            type:
            - integer
            - 'null'
            format: int32
        additionalProperties: false
    ProductRequirementSetDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ProductRequirementSetDto'
          description: Request DTO representing product requirement set data
      additionalProperties: false
    ItemCreatedDto:
      type: object
      properties:
        id:
          type: string
          description: The UiD of the created item
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
      additionalProperties: false
      description: Response DTO representing created Item Instance
    CollectionMinimumCountRuleDto:
      allOf:
      - $ref: '#/components/schemas/BasicRuleDto'
      - type: object
        properties:
          requiredTypesMinCount:
            type:
            - object
            - 'null'
            additionalProperties:
              type: integer
              format: int32
          overallMinimumCount:
            type: integer
            format: int32
        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
    Approver:
      type: object
      properties:
        subject:
          type:
          - string
          - 'null'
        successor:
          allOf:
          - $ref: '#/components/schemas/Approver'
        action:
          allOf:
          - $ref: '#/components/schemas/ApproveAction'
        hasProcessedRequest:
          type: boolean
          readOnly: true
      additionalProperties: false
    FilterConditionDto:
      type: object
      properties:
        fieldName:
          type:
          - string
          - 'null'
        conditions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDto'
      additionalProperties: false
    CreateProductRequirementSetVersionFromSetIdResponseServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateProductRequirementSetVersionFromSetIdResponse'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    FormulaVariableDto:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
        propertyName:
          type:
          - string
          - 'null'
        filterConditions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FilterConditionDto'
      additionalProperties: false
    ApproveAction:
      type: object
      properties:
        comment:
          type:
          - string
          - 'null'
        decision:
          allOf:
          - $ref: '#/components/schemas/Decision'
        created:
          type: string
          format: date-time
      additionalProperties: false
    DataValidationRulesDto:
      type: object
      properties:
        mandatory:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDtoConditionalValidationRuleDto'
        specialCharacters:
          allOf:
          - $ref: '#/components/schemas/SpecialCharactersRuleDtoValidationRuleDto'
        noNumbers:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto'
        onlyInteger:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto'
        noNegative:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto'
        onlyDecimal:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto'
        regex:
          allOf:
          - $ref: '#/components/schemas/RegexRuleDtoConditionalValidationRuleDto'
        characterLimit:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDtoValidationRuleDto'
        numberLimit:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDtoValidationRuleDto'
        noFutureDates:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto'
        noPastDates:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto'
        dateLimit:
          allOf:
          - $ref: '#/components/schemas/DateLimitRuleDtoConditionalValidationRuleDto2'
          description: Validation rule that allows to set date range
        multiSelectLimit:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDtoConditionalValidationRuleDto'
        collectionMinimumCount:
          allOf:
          - $ref: '#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto'
        collectionMaximumCount:
          allOf:
          - $ref: '#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto'
        externalProvider:
          allOf:
          - $ref: '#/components/schemas/ExternalProviderRuleDtoValidationRuleDto'
        externalDataGroupProvider:
          allOf:
          - $ref: '#/components/schemas/ExternalProviderRuleDtoValidationRuleDto'
        readOnly:
          allOf:
          - $ref: '#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto'
        conditionalLimit:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDtoConditionalValidationRuleDto'
        timeZoneId:
          type:
          - string
          - 'null'
        disallowTodaysDate:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto'
          description: Validation rule that does not allow todays date
      additionalProperties: false
      description: Request DTO representing validation data metadata
    ConditionalValueDto_2:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        logicalOperation:
          type:
          - string
          - 'null'
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto'
        value:
          type:
          - string
          - 'null'
        priority:
          type: integer
          format: int32
        valueId:
          type:
          - string
          - 'null'
      additionalProperties: false
    SpecialCharactersRuleDto2_2:
      type: object
      properties:
        errorMessage:
          type:
          - string
          - 'null'
        excludedCharacters:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    SpecialCharactersRuleDto_2:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        excludedCharacters:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    ExternalProviderRuleDto_2:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        providerId:
          type: string
          format: uuid
      additionalProperties: false
    CalculatedResultDto:
      type: object
      properties:
        result:
          type:
          - string
          - 'null'
          description: Calculation result
        error:
          type:
          - string
          - 'null'
          description: Calculation error
      additionalProperties: false
    DataFieldDto_2:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
          description: Property name
          example: firstName
        propertyType:
          type:
          - string
          - 'null'
          description: Property type
          example: text
        propertyTypeId:
          type:
          - string
          - 'null'
          description: Property type id
          format: uuid
          example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c
        linkChildFieldPropertyName:
          type:
          - string
          - 'null'
          description: Linked child field property name
          example: productCategory
        linkedParentFieldPropertyName:
          type:
          - string
          - 'null'
          description: Linked Parent field property name
          example: productCategory
        formulaSchema:
          allOf:
          - $ref: '#/components/schemas/FormulaSchemaDto_2'
          description: Formula schema
        dateTimePeriodFormulaSchema:
          allOf:
          - $ref: '#/components/schemas/DateTimePeriodFormulaSchemaDto_2'
          description: Date formula schema
        customActionProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: 'Properties which can be passed to a custom action function in the UI, provided as

            basic string key-value pairs to allow action functions to be created generically.'
        externalSearchApiProviderId:
          type:
          - string
          - 'null'
          description: External search API provider id
          format: uuid
      additionalProperties: false
      description: Response DTO representing data field data
    DateTimePeriodFormulaSchemaDto_2:
      type: object
      properties:
        formulaSetId:
          type: string
          description: Formula set id
          format: uuid
          example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c
        versionNumber:
          type:
          - integer
          - 'null'
          description: Formula set version number
          format: int32
          example: 1
        formulaString:
          type:
          - string
          - 'null'
          description: Formula string will be used to perform calculation
          example: $1 + $2
        dateTimePeriodFormulaVariables:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/DateTimePeriodFormulaVariableDto_2'
          description: Metadata argument in formula string
      additionalProperties: false
    RequirementSetJurisdictionDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/RequirementSetJurisdictionDto'
          description: Response DTO representing requirement sets jurisdictions available
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    DateTimePeriodFormulaVariableDto_2:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
        timePeriodKind:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        timeZoneId:
          type:
          - string
          - 'null'
      additionalProperties: false
    RegexRuleDto2_2:
      type: object
      properties:
        errorMessage:
          type:
          - string
          - 'null'
        isCaseSensitive:
          type: boolean
        regexValue:
          type:
          - string
          - 'null'
      additionalProperties: false
    AccessLayerDto_2:
      type: object
      properties:
        geographic:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of geographic access layers e.g. ["Global"]
        businessRelated:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of business related access layers e.g. ["Global"]
      additionalProperties: false
      description: DTO representing associated access layers
    ProductRequirementSetVersionDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ProductRequirementSetVersionDto'
          description: Response DTO representing product requirement set version data
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ReferenceDto_2:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
          description: Reference type
          example: FATCA
        description:
          type:
          - string
          - 'null'
          description: Reference description
          example: Foreign Account Tax Compliance Act
        url:
          type:
          - string
          - 'null'
          description: Reference URL
          example: www.irs.gov
      additionalProperties: false
      description: Request DTO representing reference metadata
    Condition:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        logicalOperation:
          type:
          - string
          - 'null'
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinition'
      additionalProperties: false
    ExternalProviderRuleDto2_2:
      type: object
      properties:
        providerId:
          type: string
          format: uuid
      additionalProperties: false
    CollectionMaximumCountRuleDto2_2:
      type: object
      properties:
        errorMessage:
          type:
          - string
          - 'null'
        requiredTypesMaxCount:
          type:
          - object
          - 'null'
          additionalProperties:
            type: integer
            format: int32
        overallMaximumCount:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    Reference:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        url:
          type:
          - string
          - 'null'
      additionalProperties: false
    CollectionMaximumCountRuleDto_2:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        requiredTypesMaxCount:
          type:
          - object
          - 'null'
          additionalProperties:
            type: integer
            format: int32
        overallMaximumCount:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    ValueLimitRuleDto_2:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        minValue:
          type:
          - integer
          - 'null'
          format: int32
        maxValue:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    ConditionDto_2:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        logicalOperation:
          type:
          - string
          - 'null'
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto'
      additionalProperties: false
    ProductRequirementDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ProductRequirementDto_2'
          description: Request DTO representing requirement metadata
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    Requirement:
      required:
      - discriminator
      type: object
      properties:
        discriminator:
          type:
          - string
          - 'null'
          readOnly: true
        version:
          type: integer
          format: int32
        isLocked:
          type: boolean
        rootVersionId:
          type: string
          format: uuid
        versionNumber:
          type: integer
          format: int32
        id:
          type: string
          format: uuid
        tenant:
          type:
          - string
          - 'null'
        category:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        template:
          type:
          - string
          - 'null'
        entityType:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        isSensitiveData:
          type: boolean
        isMaterialData:
          type: boolean
        isCoreDefinition:
          type: boolean
        jurisdiction:
          type:
          - string
          - 'null'
        dataProtectionJurisdiction:
          type:
          - string
          - 'null'
        references:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Reference'
        targetEntity:
          type:
          - string
          - 'null'
        classification:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        conditions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Condition'
        tags:
          type:
          - array
          - 'null'
          items:
            type: string
        RequirementSetId:
          type: string
          format: uuid
      additionalProperties: false
      discriminator:
        propertyName: discriminator
        mapping:
          Data: '#/components/schemas/DataRequirement'
          Document: '#/components/schemas/DocumentRequirement'
          eSignature Document: '#/components/schemas/ESignatureDocumentRequirement'
          Ownership and Control: '#/components/schemas/OwnershipAndControlRequirement'
          DataGroup: '#/components/schemas/DataGroupField'
    ProductRequirementSetDtoIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ProductRequirementSetDto_2'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    CollectionMinimumCountRuleDto_2:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        requiredTypesMinCount:
          type:
          - object
          - 'null'
          additionalProperties:
            type: integer
            format: int32
        overallMinimumCount:
          type: integer
          format: int32
      additionalProperties: false
    ValueLimitRuleDto2_2:
      type: object
      properties:
        errorMessage:
          type:
          - string
          - 'null'
        minValue:
          type:
          - integer
          - 'null'
          format: int32
        maxValue:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    ValidationRuleDto_2:
      type: object
      properties:
        id:
          type: string
          description: The UiD of the validation rule
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        setId:
          type: string
          description: The UiD of the requirement set/data group
          format: uuid
          example: 012cfe3a-7bfa-41e7-8269-d49b3b38dff3
        propertyId:
          type: string
          description: The UiD of the requirement/data group field
          format: uuid
          example: 450df9bf-b2d3-48cf-ab8d-481c69b74373
        propertyTypeId:
          type:
          - string
          - 'null'
          description: The Guid containing the property type id
          format: uuid
          example: 450df9bf-b2d3-48cf-ab8d-481c69b74373
        linkChildFieldPropertyName:
          type:
          - string
          - 'null'
          description: The string containing the property name child of this property, only has value when propertyType is set to "selectLink"
          example: country
        linkedParentFieldPropertyName:
          type:
          - string
          - 'null'
          description: The string containing the property name parent of this property, only has value when propertyType is set to  "LinkedSelectV2" or "LinkedMultiSelectV2"
          example: country
        dataGroupId:
          type:
          - string
          - 'null'
          description: The UiD of the of data group - is set only when requirement/data group field propertyType is set to "dataGroup"
          format: uuid
          example: 8eb83ec6-1539-46a9-b0ba-c5138a09580c
        isDataGroup:
          type: boolean
          description: Flag indicating it is validation rules for data group field
          example: true
        propertyName:
          type:
          - string
          - 'null'
          description: Requirement/data group field property name
          example: firstName
        friendlyName:
          type:
          - string
          - 'null'
          description: Requirement/data group field friendly Name
          example: First Name
        validationType:
          type:
          - string
          - 'null'
          description: Validation type
          example: text
        validationData:
          allOf:
          - $ref: '#/components/schemas/ValidationDataDto'
          description: Validation Data - set of validation rules specific to requirement/data group field
      additionalProperties: false
      description: Request DTO representing validation rule metadata
    ProductRequirementDto_2:
      type: object
      properties:
        rootVersionId:
          type: string
          description: The UiD of the root requirement set version
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        versionNumber:
          type: integer
          description: Requirement set version number
          format: int32
          example: 1
        id:
          type: string
          description: The UiD of the requirement
          format: uuid
          example: 84ec28e2-d786-417b-850f-96321dd849dd
        tenant:
          type:
          - string
          - 'null'
          description: The UiD of the tenant
          example: c345f3e9-c9f7-40ac-9eaa-654c2d2de1d1
        category:
          type:
          - string
          - 'null'
          description: Requirement business category
          example: Basic Details
        description:
          type:
          - string
          - 'null'
          description: Requirement description
          example: This is the client first name
        template:
          type:
          - string
          - 'null'
          description: Requirement template
          example: Product
        entityType:
          type:
          - string
          - 'null'
          description: Requirement entity type
          example: Individual
        name:
          type:
          - string
          - 'null'
          description: Requirement name
          example: First Name
        isSecondaryIdentifier:
          type: boolean
          description: Requirement Secondary Identifier flag
          example: true
        isSensitiveData:
          type: boolean
          description: Requirement sensitive data flag
          example: true
        isMaterialData:
          type: boolean
          description: Requirement material data flag
          example: true
        isCoreDefinition:
          type: boolean
          description: 'Requirement is defined as core

            and cannot be deleted or altered'
          example: false
        jurisdiction:
          type:
          - string
          - 'null'
          description: Requirement jurisdiction
          example: Global
        references:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ReferenceDto_2'
          description: Requirement references list
        targetEntity:
          type:
          - string
          - 'null'
          description: Requirement target entity
          example: Client
        classification:
          type:
          - string
          - 'null'
          description: Requirement classification
          example: Customer Profiling
        type:
          type:
          - string
          - 'null'
          description: Requirement type
          example: Data
        conditions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDto_2'
          description: Requirement conditions list
        RequirementSetId:
          type: string
          description: The UiD of the current requirement set version
          format: uuid
          example: c060f297-70a2-4d4c-9360-9b5b39060ff0
        versionId:
          type: string
          description: The UiD of the current requirement set version
          format: uuid
          example: e060f297-70a2-4d4c-9360-9b5b39060ff0
        dataField:
          allOf:
          - $ref: '#/components/schemas/DataFieldDto_2'
          description: Data Field
        order:
          type:
          - number
          - 'null'
          description: Order
          format: double
          example: 1
        defaultValue:
          type:
          - string
          - 'null'
          description: Default Value
          example: Not Available
        defaultDateType:
          type:
          - string
          - 'null'
          description: Default Date Type e.g. Standard Default Value
          example: 'true'
        isReadOnly:
          type: boolean
          description: Is requirement readonly
          example: false
        isIndexable:
          type: boolean
          description: Is requirement indexable
          example: true
        isMandatoryIndexable:
          type: boolean
          description: Is requirement mandatory indexable
          example: true
        isMandatory:
          type: boolean
          description: Is requirement mandatory
          example: false
        documentDescription:
          type:
          - string
          - 'null'
          description: Document Description
          example: Driver License
        documentDataKey:
          type:
          - string
          - 'null'
          description: Document Data Key
        acceptableDocumentTypes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Acceptable document types for the e-signature document requirement
        documentAccessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto_2'
          description: Document Access Layers
        ownershipDataKey:
          type:
          - string
          - 'null'
          description: Ownership Data Key
          example: DataKey
        partyTypes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Party Types e.g. ["Director"]
        uboThreshold:
          type:
          - number
          - 'null'
          description: UBO Threshold
          format: double
          example: 0.6
        relatedPartyEntityTypes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Types of Related Party Entity e.g. ["Individual"]
        directAssociationsOnly:
          type: boolean
          description: Is Only direct association
          example: false
        idvOn:
          type: boolean
          description: Is Idv On
          example: false
        idvName:
          type:
          - string
          - 'null'
          description: Idv Name
          example: IdentityRequirement
        idvTooltip:
          type:
          - string
          - 'null'
          description: Idv Tooltip
          example: Identity Requirement
        ownershipValidationRule:
          allOf:
          - $ref: '#/components/schemas/OwnershipValidationRuleDto'
          description: Ownership Validation Rule
        validationRule:
          allOf:
          - $ref: '#/components/schemas/ValidationRuleDto_2'
          description: Validation Rule
        validationRulesV2:
          allOf:
          - $ref: '#/components/schemas/DataValidationRulesDto'
          description: Requirement validation rules V2
        conditionalValues:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionalValueDto_2'
          description: List of conditional values
        hasEvaluatedConditionalValue:
          type: boolean
          description: Does this field has evaluated conditional value?
        evaluatedConditionalValue:
          type:
          - string
          - 'null'
          description: Evaluated conditional value
        hasCalculatedValue:
          type: boolean
          description: Does this field has calculated value?
        calculatedFieldResult:
          allOf:
          - $ref: '#/components/schemas/CalculatedResultDto'
          description: Calcualtion value
        tags:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of tags
        isTotalProductColumn:
          type: boolean
          description: Specifies is field is going to be displayed with a total summation
          example: true
        uiDecoration:
          type:
          - string
          - 'null'
          description: 'Determines how the requirement should be rendered

            <example>null</example>'
        dataProtectionJurisdiction:
          type:
          - string
          - 'null'
          description: Jurisdiction for data protection
          example: Global
        aggregateVersion:
          type:
          - integer
          - 'null'
          description: Requirement aggregate version
          format: int32
          example: 1
        fieldAccessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto_2'
          description: Field Access Layers
        clearValueIfTriggerConditionNotMet:
          type: boolean
          description: When enabled, the field value is cleared if its trigger condition is not met
          example: true
      additionalProperties: false
      description: Request DTO representing requirement metadata
    ProductRequirementSetVersionDto:
      type: object
      properties:
        versionNumber:
          type: integer
          description: The versions number
          format: int32
          example: 1
        effectiveFrom:
          type: string
          description: The date that the version takes effect when published
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        effectiveUntil:
          type:
          - string
          - 'null'
          description: The calculated date that the version ceases being active
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        publicationDate:
          type:
          - string
          - 'null'
          description: The date that the version got published
          format: date-time
          readOnly: true
          example: '2021-01-01T14:48:00.000Z'
        status:
          allOf:
          - $ref: '#/components/schemas/VersionStatus'
          description: The status of the version
          example: Published
        created:
          type: string
          description: The creation date of the version
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        isActive:
          type: boolean
          description: 'The calculated flag to annotate whether this is the model''s latest version

            at the time of the query (not necessarily published)'
          example: true
        signees:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Signee'
          description: The defined list of signees for the version
        version:
          type: integer
          description: Version number for given Aggregate (concurrency check)
          format: int32
          example: 1
        id:
          type: string
          description: The UiD of the requirement set version
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        setId:
          type: string
          description: The UiD of the requirement set that the version belongs to
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        requirementSetStatus:
          type:
          - string
          - 'null'
          description: Requirement set status
          example: Active
        name:
          type:
          - string
          - 'null'
          description: Requirement set name
          example: Fenergo Comprehensive Standard Policy Requirements
        jurisdiction:
          type:
          - string
          - 'null'
          description: Requirement set jurisdiction
          example: Global
        defaultDataProtectionJurisdiction:
          type:
          - string
          - 'null'
          description: Default jurisdiction for data protection
          example: Global
        requirements:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Requirement'
          description: List of requirements
        conditions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDto_2'
          description: Conditions under which the requirement set can be applied
      additionalProperties: false
      description: Response DTO representing product requirement set version data
    ProductRequirementSetDto_2:
      type: object
      properties:
        id:
          type: string
          description: The UiD of the product requirement set
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        versions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ProductRequirementSetVersionDto'
          description: Versions associated to this product requirement set
        version:
          type: integer
          description: Version number for given Aggregate (concurrency check)
          format: int32
          example: 1
        status:
          type:
          - string
          - 'null'
          description: Product Requirement Set status
          example: Active
        jurisdiction:
          type:
          - string
          - 'null'
          description: Jurisdiction of the product requirement set
          example: Global
      additionalProperties: false
      description: Response DTO representing product requirement set data
    FormulaSchemaDto_2:
      type: object
      properties:
        formulaSetId:
          type: string
          description: Formula set id
          format: uuid
          example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c
        versionNumber:
          type:
          - integer
          - 'null'
          description: Formula set version number
          format: int32
          example: 1
        formulaString:
          type:
          - string
          - 'null'
          description: Formula string will be used to perform calculation
          example: $1 + $2
        formulaVariables:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/FormulaVariableDto'
          description: Metadata argument in formula string
      additionalProperties: false
    RequirementSetJurisdictionDto:
      type: object
      properties:
        availableJurisdictions:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of available jurisdictions in which requirement sets are created
      additionalProperties: false
      description: Response DTO representing requirement sets jurisdictions available
    RegexRuleDto_2:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        isCaseSensitive:
          type: boolean
        regexValue:
          type:
          - string
          - 'null'
      additionalProperties: false
    CollectionMinimumCountRuleDto2_2:
      type: object
      properties:
        errorMessage:
          type:
          - string
          - 'null'
        requiredTypesMinCount:
          type:
          - object
          - 'null'
          additionalProperties:
            type: integer
            format: int32
        overallMinimumCount:
          type: integer
          format: int32
      additionalProperties: false
    ConditionDefinition:
      type: object
      properties:
        fieldName:
          type:
          - string
          - 'null'
        value:
          type:
          - array
          - 'null'
          items:
            type: string
        valueId:
          type:
          - array
          - 'null'
          items:
            type: string
        valueType:
          type:
          - string
          - 'null'
        dataSource:
          type:
          - string
          - 'null'
        operation:
          type:
          - string
          - 'null'
        logicalOperation:
          type:
          - string
          - 'null'
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinition'
        valueField:
          allOf:
          - $ref: '#/components/schemas/ValueField'
        isCondition:
          type: boolean
          readOnly: true
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-productpolicycommand-v1-0-openapi.json
- fenergo-productpolicyquery-v1-0-openapi.json