openapi: 3.2.0
info:
  title: Fenergo User Settings API
  version: '1.0'
  description: 'Operations tagged UserSettings across 2 of this provider''s published API definitions: fenergo-advanceddashboardcommand-v1-0-openapi.json, fenergo-advanceddashboardquery-v1-0-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /advanceddashboardcommand
- url: /advanceddashboardquery
security:
- Bearer: []
tags:
- name: User Settings
paths:
  /api/settings/user/selected-view:
    put:
      tags:
      - User Settings
      summary: Saves user view selection
      description: 'Save user view selection


        Required permissions:

        Following permissions are required: AdvancedDashboardAccess'
      operationId: SaveUserViewSelection
      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: Save user view selection request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SaveUserViewSelectionDtoServiceRequest'
      responses:
        '200':
          description: Success. User view selection saved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  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: /advanceddashboardcommand
  /api/settings/user/selected-filter:
    put:
      tags:
      - User Settings
      summary: Save the active filter set selection for a user
      description: 'Persists the user''s active filter set selection for a given dashboard type


        Required permissions:

        Following permissions are required: AdvancedDashboardAccess'
      operationId: SaveActiveFilterSet
      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: Save active filter set request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SaveActiveFilterSetDtoServiceRequest'
      responses:
        '200':
          description: Success. Active filter set selection saved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. The filter set was not found for this user
                  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: /advanceddashboardcommand
  /api/settings/user/filter-set:
    post:
      tags:
      - User Settings
      summary: Save a new filter set
      description: 'Save a set of filters for a specific user


        Required permissions:

        Following permissions are required: AdvancedDashboardAccess'
      operationId: CreateFilterSet
      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
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FilterSetCreationDtoServiceRequest'
      responses:
        '202':
          description: Success. A new saved filter entry is created
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not found. The saved filter id and tenant id were not found
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '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: /advanceddashboardcommand
  /api/settings/user/filter-set/{id}:
    delete:
      tags:
      - User Settings
      summary: Delete an existing filter set
      description: 'Required permissions:

        Following permissions are required: AdvancedDashboardAccess'
      operationId: DeleteFilterSet
      parameters:
      - name: id
        in: path
        description: FilterSetId
        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: Accepted for processing
        '400':
          description: Invalid request
          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: FilterSet with given ID does not exists
                  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:
      - User Settings
      summary: Update existing FilterSet
      description: 'This method will update an existing FilterSet

        The FilterSet will be updated with the data provided in the DTO.


        Required permissions:

        Following permissions are required: AdvancedDashboardAccess'
      operationId: UpdateFilterSet
      parameters:
      - name: id
        in: path
        description: The Id of the existing FilterSet to update
        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: ServiceRequest with the Fenergo.Nebula.Dashboard.Advanced.Command.Application.Dto.FilterSetUpdateDto to update
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FilterSetUpdateDtoServiceRequest'
      responses:
        '202':
          description: Success. ConfigurationEnvironment updated
        '400':
          description: Not Found. FilterSet with given ID does not exist
          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
                  type: Error
                  errorCode: Error Code
        '500':
          description: Internal Server Error. An unhandled exception occurred
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /advanceddashboardcommand
  /api/settings/user/filter-set/journey:
    get:
      tags:
      - User Settings
      summary: Get JourneyDashboard saved filter set data for current user
      description: 'Returns the saved filter set data for the current user


        Required permissions:

        Following permissions are required: AdvancedDashboardAccess'
      operationId: GetJourneyDashboardFilterSetsForUser
      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.Filter set data is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterSetsForUserDtoServiceResponse'
        '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: /advanceddashboardquery
  /api/settings/user/filter-set/task:
    get:
      tags:
      - User Settings
      summary: Get TaskDashboard saved filter set data for current user
      description: 'Returns the saved filter set data for the current user


        Required permissions:

        Following permissions are required: AdvancedDashboardAccess'
      operationId: GetTaskDashboardFilterSetsForUser
      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.Filter set data is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterSetsForUserDtoServiceResponse'
        '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: /advanceddashboardquery
components:
  schemas:
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    FilterSetCreationDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/FilterSetCreationDto'
      additionalProperties: false
    ValidationErrorModelListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorModel'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
      example:
        data:
        - propertyName: data
          errorMessage: Data is required
          attemptedValue: ''
          errorCode: NotNullValidator
        messages:
        - message: Data is required
          type: Error
          errorCode: Error Code
    DashboardFilter:
      type: object
      properties:
        columnName:
          type:
          - string
          - 'null'
        selectedOptions:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    FilterSetCreationDto:
      type: object
      properties:
        filterSource:
          allOf:
          - $ref: '#/components/schemas/DashboardType'
        filterSetName:
          type:
          - string
          - 'null'
        dashboardFilters:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DashboardFilter'
        activeConfigurationVersionId:
          type: string
          format: uuid
        viewName:
          type:
          - string
          - 'null'
      additionalProperties: false
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        attemptedValue: {}
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    SaveUserViewSelectionDto:
      required:
      - viewId
      type: object
      properties:
        viewId:
          minLength: 1
          type: string
        dashboardType:
          allOf:
          - $ref: '#/components/schemas/DashboardType'
      additionalProperties: false
    DashboardType:
      enum:
      - Journey
      - Task
      type: string
    SaveUserViewSelectionDtoServiceRequest:
      required:
      - data
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/SaveUserViewSelectionDto'
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    FilterSetUpdateDtoServiceRequest:
      required:
      - data
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/FilterSetUpdateDto'
      additionalProperties: false
    FilterSetUpdateDto:
      type: object
      properties:
        filterSetName:
          type:
          - string
          - 'null'
        dashboardFilters:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DashboardFilter'
        activeFilterSet:
          type: boolean
        activeConfigurationVersionId:
          type: string
          format: uuid
        viewName:
          type:
          - string
          - 'null'
      additionalProperties: false
    SaveActiveFilterSetDtoServiceRequest:
      required:
      - data
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/SaveActiveFilterSetDto'
      additionalProperties: false
    SaveActiveFilterSetDto:
      required:
      - filterSetId
      type: object
      properties:
        filterSetId:
          minLength: 1
          type: string
          format: uuid
        dashboardType:
          allOf:
          - $ref: '#/components/schemas/DashboardType'
      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
    FilterSetsForUserDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/FilterSetsForUserDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    FilterSetDto:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        filterSetName:
          type:
          - string
          - 'null'
        dashboardFilters:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DashboardFilter'
        activeConfigurationVersionId:
          type: string
          format: uuid
        viewName:
          type:
          - string
          - 'null'
      additionalProperties: false
    FilterSetsForUserDto:
      type: object
      properties:
        userId:
          type:
          - string
          - 'null'
        filterSets:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FilterSetDto'
        activeFilterSetId:
          type:
          - string
          - 'null'
          format: uuid
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-advanceddashboardcommand-v1-0-openapi.json
- fenergo-advanceddashboardquery-v1-0-0-openapi.json