openapi: 3.2.0
info:
  title: Fenergo Nebula Advanced Dashboard Query Dashboard…
  description: '**Advanced Dashboard Query API**:


    Advanced Dashboard Query API provides endpoints in order to retrieve all related models and their versions.


    **Advanced Dashboard Query API provides**:'
  version: 1.0.0
servers:
- url: /advanceddashboardquery
security:
- Bearer: []
tags:
- name: DashboardConfiguration
paths:
  /api/dashboard-configuration/journey:
    get:
      tags:
      - DashboardConfiguration
      summary: Get Journey dashboard configuration
      description: 'Returns the configuration for dashboards for given tenant.


        Required permissions:

        Following permissions are required: AdvancedDashboardAccess'
      operationId: GetJourneyDashboardConfiguration
      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. Dashboard configuration is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardConfigurationDtoServiceResponse'
        '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
  /api/dashboard-configuration/task:
    get:
      tags:
      - DashboardConfiguration
      summary: Get Task dashboard configuration
      description: 'Returns the configuration for dashboards for given tenant.


        Required permissions:

        Following permissions are required: AdvancedDashboardAccess'
      operationId: GetTaskDashboardConfiguration
      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. Dashboard configuration is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardConfigurationDtoServiceResponse'
        '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
components:
  schemas:
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    DashboardColumn:
      type: object
      properties:
        field:
          allOf:
          - $ref: '#/components/schemas/DashboardField'
        label:
          type:
          - string
          - 'null'
        filterable:
          type: boolean
        order:
          type:
          - integer
          - 'null'
          format: int32
        isHidden:
          type: boolean
        customProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
      additionalProperties: false
    DashboardFieldSource:
      enum:
      - Journey
      - Task
      - Entity
      - EntityProperty
      type: string
    DashboardField:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        source:
          allOf:
          - $ref: '#/components/schemas/DashboardFieldSource'
        type:
          allOf:
          - $ref: '#/components/schemas/DashboardFieldType'
      additionalProperties: false
    DashboardFieldType:
      enum:
      - Id
      - Text
      - Number
      - Date
      - Lookup
      - Object
      - Collection
      - Boolean
      type: string
    DashboardConfigurationDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/DashboardConfigurationDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    DashboardConfigurationDto:
      type: object
      properties:
        userSelection:
          allOf:
          - $ref: '#/components/schemas/UserViewSelectionDto'
        retrievedViewId:
          type:
          - string
          - 'null'
        activeConfigurationId:
          type:
          - string
          - 'null'
          format: uuid
        columns:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DashboardColumn'
        availableViews:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DashboardViewLiteDto'
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    UserViewSelectionDto:
      type: object
      properties:
        selectedViewId:
          type:
          - string
          - 'null'
        selectedViewName:
          type:
          - string
          - 'null'
        selectedConfigurationId:
          type:
          - string
          - 'null'
          format: uuid
      additionalProperties: false
    DashboardViewLiteDto:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
      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
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header