openapi: 3.2.0
info:
  title: Fenergo Dynamic Configuration API
  version: '1.0'
  description: 'Operations tagged DynamicConfiguration across 3 of this provider''s published API definitions: fenergo-authorizationcommand-v1-0-openapi.json, fenergo-authorizationquery-v1-0-openapi.json, fenergo-authorizationquery-v2-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /authorizationcommand
- url: /authorizationquery
security:
- Bearer: []
tags:
- name: DynamicConfiguration
paths:
  /api/dynamic-configuration:
    post:
      tags:
      - DynamicConfiguration
      summary: Create dynamic configuration
      description: 'Creates a new dynamic configuration


        Creates a new dynamic configuration.


        Returns the created dynamic configuration id.


        Required permissions:

        Following permissions are required: SecurityConfigCreate'
      operationId: CreateDynamicConfiguration
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Create dynamic configuration request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDynamicConfigurationRequestDtoServiceRequest'
      responses:
        '202':
          description: Success. Dynamic configuration created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDynamicConfigurationResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    get:
      tags:
      - DynamicConfiguration
      summary: Get dynamic configurations
      description: 'Returns existing dynamic configurations.


        Required permissions:

        Following permissions are required: SecurityConfigAccess'
      operationId: GetDynamicConfigurationsPage
      parameters:
      - name: PageSize
        in: query
        description: Size of the page (result set)
        schema:
          maximum: 100
          minimum: 1
          type: integer
          description: Size of the page (result set)
          format: int32
          example: 100
        example: 100
      - name: PaginationToken
        in: query
        description: 'Position token for the search results to start

          (leave empty to start from the 1st item)'
        schema:
          type:
          - string
          - 'null'
          description: 'Position token for the search results to start

            (leave empty to start from the 1st item)'
          example: null
        example: null
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The page of access layers is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicConfigurationPageDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /authorizationcommand
  /api/dynamic-configuration/{id}/clone:
    post:
      tags:
      - DynamicConfiguration
      summary: Clone dynamic configuration
      description: 'Creates a new dynamic configuration


        Clones an existing dynamic configuration.


        Returns the cloned dynamic configuration id.


        Required permissions:

        Following permissions are required: SecurityConfigCreate'
      operationId: CloneDynamicConfiguration
      parameters:
      - name: id
        in: path
        description: Dynamic Configuration 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 dynamic configuration request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloneDynamicConfigurationRequestDtoServiceRequest'
      responses:
        '202':
          description: Success. Dynamic configuration created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloneDynamicConfigurationResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /authorizationcommand
  /api/dynamic-configuration/{id}:
    put:
      tags:
      - DynamicConfiguration
      summary: Update dynamic configuration
      description: 'Updates dynamic configuration


        Required permissions:

        Following permissions are required: SecurityConfigEdit'
      operationId: UpdateDynamicConfiguration
      parameters:
      - name: id
        in: path
        description: Dynamic configuration id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Update dynamic configuration request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDynamicConfigurationRequestDtoServiceRequest'
      responses:
        '202':
          description: Success. Dynamic configuration updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDynamicConfigurationResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Dynamic configuration 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:
      - DynamicConfiguration
      summary: Delete dynamic configuration
      description: 'Deletes dynamic configuration


        Required permissions:

        Following permissions are required: SecurityConfigDelete'
      operationId: DeleteDynamicConfiguration
      parameters:
      - name: id
        in: path
        description: dynamic configuration 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. Dynamic configuration deleted
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Dynamic configuration 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
    get:
      tags:
      - DynamicConfiguration
      summary: Get dynamic configuration by id
      description: 'Returns the dynamic configuration for a given id.


        Required permissions:

        Following permissions are required: SecurityConfigAccess'
      operationId: GetDynamicConfigurationById
      parameters:
      - name: id
        in: path
        description: Dynamic configuration 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. Dynamic configuration is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicConfigurationDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Access layer 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: /authorizationcommand
  /api/v2/dynamic-configuration:
    get:
      tags:
      - DynamicConfiguration
      summary: Get dynamic configurations
      description: 'Returns existing dynamic configurations.


        Required permissions:

        Following permissions are required: SecurityConfigAccess'
      operationId: GetDynamicConfigurationsPage
      parameters:
      - name: PageSize
        in: query
        description: Size of the page (result set)
        schema:
          type: integer
          format: int32
          example: 100
        example: 100
      - name: PaginationToken
        in: query
        description: 'Position token for the search results to start

          (leave empty to start from the 1st item)'
        schema:
          type: string
          example: null
        example: null
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The page of access layers is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicConfigurationPageDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /authorizationquery
  /api/v2/dynamic-configuration/{id}:
    get:
      tags:
      - DynamicConfiguration
      summary: Get dynamic configuration by id
      description: 'Returns the dynamic configuration for a given id.


        Required permissions:

        Following permissions are required: SecurityConfigAccess'
      operationId: GetDynamicConfigurationById
      parameters:
      - name: id
        in: path
        description: Dynamic configuration 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. Dynamic configuration is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicConfigurationDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Access layer 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: /authorizationquery
components:
  schemas:
    CloneDynamicConfigurationResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The UiD of the cloned dynamic configuration
          format: uuid
          example: d7f592a5-3feb-4607-bf39-ab9e81c45db0
      additionalProperties: false
      description: Response DTO representing cloned dynamic configuration data
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
          description: The message
          example: Success
        type:
          type:
          - string
          - 'null'
          description: 'Type of the message

            One of Info, Warning, Error, Forbidden'
          example: Info
        errorCode:
          type:
          - string
          - 'null'
          description: Error Code
          example: INTERNAL_SERVER_ERROR
      additionalProperties: false
      description: The message associated to the service response
    UpdateDynamicConfigurationResponseDto:
      type: object
      properties:
        version:
          type: integer
          description: Version of dynamic configuration after update
          format: int32
          example: 1
      additionalProperties: false
      description: Response DTO representing updated dynamic configuration
    CloneDynamicConfigurationResponseDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CloneDynamicConfigurationResponseDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    UpdateDynamicConfigurationRequestDto:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Name of the dynamic configuration
          example: Canada rule
        description:
          type:
          - string
          - 'null'
          description: Description of the dynamic configuration
          example: Rule for Canada Private Banking
        geographicAccessLayerId:
          type:
          - string
          - 'null'
          description: 'UiD of the referenced Geographic access layer

            The access layer DataType must match the dynamic configuration DataType property'
          format: uuid
          example: 4e63e0ee-c5f8-4115-a1e6-a980dadcacd1
        businessRelatedAccessLayerId:
          type:
          - string
          - 'null'
          description: 'UiD of the referenced Business related access layer

            The access layer DataType must match the dynamic configuration DataType property'
          format: uuid
          example: ec7c05d2-fc98-442c-ba5b-51652b59738c
        dataType:
          $ref: '#/components/schemas/AccessLayerDataTypeDto'
        conditions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDto'
          description: Conditions under which the dynamic configuration is assigned
        version:
          type: integer
          description: "Current version of the dynamic configuration 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: 1
      additionalProperties: false
      description: Request DTO representing dynamic configuration data to update
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    CreateDynamicConfigurationRequestDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreateDynamicConfigurationRequestDto'
      additionalProperties: false
      description: Service request data
    CreateDynamicConfigurationRequestDto:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Name of the dynamic configuration
          example: Canada rule
        description:
          type:
          - string
          - 'null'
          description: Description of the dynamic configuration
          example: Rule for Canada Private Banking
        geographicAccessLayerId:
          type:
          - string
          - 'null'
          description: 'UiD of the referenced Geographic access layer

            The access layer DataType must match the dynamic configuration DataType property'
          format: uuid
          example: 4e63e0ee-c5f8-4115-a1e6-a980dadcacd1
        businessRelatedAccessLayerId:
          type:
          - string
          - 'null'
          description: 'UiD of the referenced Business related access layer

            The access layer DataType must match the dynamic configuration DataType property'
          format: uuid
          example: ec7c05d2-fc98-442c-ba5b-51652b59738c
        dataType:
          $ref: '#/components/schemas/AccessLayerDataTypeDto'
        conditions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDto'
          description: Conditions under which the dynamic configuration is assigned
      additionalProperties: false
      description: Request DTO representing dynamic configuration to create
    ValueField:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          description: Value of DataSource used to filter field values
        field:
          type:
          - string
          - 'null'
          description: Field value used to validate conditional value
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data:
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    UpdateDynamicConfigurationResponseDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UpdateDynamicConfigurationResponseDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    AccessLayerDataTypeDto:
      enum:
      - Field
      - Entity
      - Journey
      - Document
      - Search
      - Product
      - ProductField
      type: string
    ConditionDefinitionDto:
      type: object
      properties:
        fieldName:
          type:
          - string
          - 'null'
          description: Name of the field to evaluate
          example: EntityType
        value:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of values
        valueId:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of value ids
        valueType:
          type:
          - string
          - 'null'
          description: Type of the value
          example: text
        dataSource:
          type:
          - string
          - 'null'
          description: Data source from which field is retrieved. If empty then Entity Data properties will be used.
          example: entityDataMetadata
        operation:
          type:
          - string
          - 'null'
          description: Logical operation to be performed to match the values
          example: equal
        logicalOperation:
          type:
          - string
          - 'null'
          description: Logical operation to be performed on the operands collection
          example: AND
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto'
          description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
        valueField:
          $ref: '#/components/schemas/ValueField'
      additionalProperties: false
      description: Represents condition
    CreateDynamicConfigurationResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The UiD of created dynamic configuration
          format: uuid
          example: c1009239-898f-41e7-a1cb-3c9513487234
      additionalProperties: false
      description: Response DTO representing created dynamic configuration
    UpdateDynamicConfigurationRequestDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UpdateDynamicConfigurationRequestDto'
      additionalProperties: false
      description: Service request data
    ConditionDto:
      required:
      - logicalOperation
      - operands
      type: object
      properties:
        id:
          type: string
          description: The ID of the condition
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        name:
          type:
          - string
          - 'null'
          description: The name of the condition
          example: Company-type only
        description:
          type:
          - string
          - 'null'
          description: The description of the condition
          example: Applicable only when EntityType=Company
        logicalOperation:
          minLength: 1
          type: string
          description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection
          example: AND
        operands:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto'
          description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
      additionalProperties: false
      description: Represents condition root
    CloneDynamicConfigurationRequestDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CloneDynamicConfigurationRequestDto'
      additionalProperties: false
      description: Service request data
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
          description: Name of the property
          example: data
        errorMessage:
          type:
          - string
          - 'null'
          description: User friendly error message
          example: Data is required
        attemptedValue:
          description: Invalid value
        errorCode:
          type:
          - string
          - 'null'
          description: Internal error code
          example: NotNullValidator
      additionalProperties: false
      description: Represents the details of validation error
    CreateDynamicConfigurationResponseDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreateDynamicConfigurationResponseDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    ValidationErrorModelListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorModel'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
      example:
        data:
        - propertyName: data
          errorMessage: Data is required
          attemptedValue: ''
          errorCode: NotNullValidator
        messages:
        - message: Data is required
          type: Error
          errorCode: Error Code
    CloneDynamicConfigurationRequestDto:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Name of cloned dynamic configuration
          example: Canada configuration - clone
      additionalProperties: false
      description: Request DTO representing dynamic configuration data to clone
    DynamicConfigurationDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/DynamicConfigurationDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    ConditionDto_2:
      type: object
      properties:
        id:
          type: string
          description: The ID of the condition
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        name:
          type:
          - string
          - 'null'
          description: The name of the condition
          example: Company-type only
        description:
          type:
          - string
          - 'null'
          description: The description of the condition
          example: Applicable only when EntityType=Company
        logicalOperation:
          type:
          - string
          - 'null'
          description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection
          example: AND
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto_2'
          description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
      additionalProperties: false
      description: Represents condition root
    DynamicConfigurationPageDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/DynamicConfigurationPageDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    DynamicConfigurationDto:
      type: object
      properties:
        id:
          type: string
          description: The UiD of the team
          format: uuid
          example: c22cd44f-492a-4f67-bd9f-c85a3084341e
        name:
          type:
          - string
          - 'null'
          description: Name of the dynamic configuration
          example: Canada rule
        description:
          type:
          - string
          - 'null'
          description: Description of the dynamic configuration
          example: Rule for Canada Private Banking
        geographicAccessLayer:
          allOf:
          - $ref: '#/components/schemas/DynamicConfigurationAccessLayerDto'
          description: Referenced Geographic access layer
        businessRelatedAccessLayer:
          allOf:
          - $ref: '#/components/schemas/DynamicConfigurationAccessLayerDto'
          description: Referenced Business related access layer
        dataType:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDataTypeDto_2'
          description: 'Data type of the dynamic configuration

            Both referenced access layers must be of that type

            Only Entity, Journey and Product are supported'
          example: Entity
        conditions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDto_2'
          description: Conditions under which the dynamic configuration is assigned
        modifiedBy:
          type:
          - string
          - 'null'
          description: 'UiD of the user who last modified the record

            May be null if was modified by MTLS client'
          example: 6e769824-9346-45b7-8969-c9b29723069b
        modified:
          type:
          - string
          - 'null'
          description: Date of last modification of the record
          format: date-time
        version:
          type: integer
          description: Version number for given Entity
          format: int32
          example: 1
      additionalProperties: false
      description: Response DTO representing dynamic configuration data
    ConditionDefinitionDto_2:
      type: object
      properties:
        fieldName:
          type:
          - string
          - 'null'
          description: Name of the field to evaluate
          example: EntityType
        value:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of values
        valueId:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of value ids
        valueType:
          type:
          - string
          - 'null'
          description: Type of the value
          example: text
        dataSource:
          type:
          - string
          - 'null'
          description: Data source from which field is retrieved. If empty then Entity Data properties will be used.
          example: entityDataMetadata
        operation:
          type:
          - string
          - 'null'
          description: Logical operation to be performed to match the values
          example: equal
        logicalOperation:
          type:
          - string
          - 'null'
          description: Logical operation to be performed on the operands collection
          example: AND
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto_2'
          description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
        valueField:
          allOf:
          - $ref: '#/components/schemas/ValueField'
          description: Field value used for conditional limit validation
      additionalProperties: false
      description: Represents condition
    DynamicConfigurationAccessLayerDto:
      type: object
      properties:
        accessLayerId:
          type: string
          description: UiD of the associated access layer
          format: uuid
          example: e4ec4810-6386-4610-a605-0d636f393daf
        dataKey:
          type:
          - string
          - 'null'
          description: DataKey of the associated access layer
          example: Canada
      additionalProperties: false
    DynamicConfigurationPageDto:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DynamicConfigurationDto'
        paginationToken:
          type:
          - string
          - 'null'
      additionalProperties: false
    AccessLayerDataTypeDto_2:
      enum:
      - Field
      - DataGroup
      - Entity
      - Journey
      - Document
      - Search
      - Product
      - ProductField
      type: string
    ConditionDto_3:
      type: object
      properties:
        id:
          type: string
          description: The ID of the condition
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        name:
          type:
          - string
          - 'null'
          description: The name of the condition
          example: Company-type only
        description:
          type:
          - string
          - 'null'
          description: The description of the condition
          example: Applicable only when EntityType=Company
        logicalOperation:
          type:
          - string
          - 'null'
          description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection
          example: AND
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto_3'
          description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
      additionalProperties: false
      description: Represents condition root
    DynamicConfigurationDto_2:
      type: object
      properties:
        id:
          type: string
          description: The UiD of the team
          format: uuid
          example: c22cd44f-492a-4f67-bd9f-c85a3084341e
        name:
          type:
          - string
          - 'null'
          description: Name of the dynamic configuration
          example: Canada rule
        description:
          type:
          - string
          - 'null'
          description: Description of the dynamic configuration
          example: Rule for Canada Private Banking
        geographicAccessLayer:
          allOf:
          - $ref: '#/components/schemas/DynamicConfigurationAccessLayerDto'
          description: Referenced Geographic access layer
        businessRelatedAccessLayer:
          allOf:
          - $ref: '#/components/schemas/DynamicConfigurationAccessLayerDto'
          description: Referenced Business related access layer
        dataType:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDataTypeDto_3'
          description: 'Data type of the dynamic configuration

            Both referenced access layers must be of that type

            Only Entity, Journey and Product are supported'
          example: Entity
        conditions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDto_3'
          description: Conditions under which the dynamic configuration is assigned
        modifiedBy:
          type:
          - string
          - 'null'
          description: 'UiD of the user who last modified the record

            May be null if was modified by MTLS client'
          example: 6e769824-9346-45b7-8969-c9b29723069b
        modified:
          type:
          - string
          - 'null'
          description: Date of last modification of the record
          format: date-time
        version:
          type: integer
          description: Version number for given Entity
          format: int32
          example: 1
      additionalProperties: false
      description: Response DTO representing dynamic configuration data
    ConditionDefinitionDto_3:
      type: object
      properties:
        fieldName:
          type:
          - string
          - 'null'
          description: Name of the field to evaluate
          example: EntityType
        value:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of values
        valueId:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of value ids
        valueType:
          type:
          - string
          - 'null'
          description: Type of the value
          example: text
        dataSource:
          type:
          - string
          - 'null'
          description: Data source from which field is retrieved. If empty then Entity Data properties will be used.
          example: entityDataMetadata
        operation:
          type:
          - string
          - 'null'
          description: Logical operation to be performed to match the values
          example: equal
        logicalOperation:
          type:
          - string
          - 'null'
          description: Logical operation to be performed on the operands collection
          example: AND
        operands:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConditionDefinitionDto_3'
          description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
        valueField:
          allOf:
          - $ref: '#/components/schemas/ValueField'
          description: Field value used for conditional limit validation
      additionalProperties: false
      description: Represents condition
    AccessLayerDataTypeDto_3:
      enum:
      - Field
      - DataGroup
      - Entity
      - Journey
      - Document
      - Search
      - Product
      - ProductField
      type: string
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-authorizationcommand-v1-0-openapi.json
- fenergo-authorizationquery-v1-0-openapi.json
- fenergo-authorizationquery-v2-0-openapi.json