swagger: '2.0'
info:
  version: '1.0'
  title: Performance REST API
basePath: /api
tags:
  - name: reports-templates
    description: Client identity connector
paths:
  /reports-templates/groups:
    post:
      tags:
        - reports-templates
      summary: getReportsGroups
      description: Gets group list
      operationId: getReportsGroups
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: groupsSearchQuery
          in: body
          schema:
            $ref: '#/definitions/RTGroupsSearchQuery'
      responses:
        200:
          description: Reports templates group list
          schema:
            type: array
            items:
              $ref: '#/definitions/RTReportsGroupRow'
  /reports-templates/clients:
    post:
      tags:
        - reports-templates
      summary: getReportsClients
      description: Gets client list
      operationId: getReportsClients
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: clientsSearchQuery
          in: body
          schema:
            $ref: '#/definitions/RTClientsSearchQuery'
      responses:
        200:
          description: Reports templates client list
          schema:
            type: array
            items:
              $ref: '#/definitions/RTReportsPortfolioRow'
  /reports-templates/clients/{reportPortfolioIdn}:
      put:
        tags:
          - reports-templates
        summary: changeReportsPortfolioStatus
        description: Change specified portfolio status
        operationId: changeReportsPortfolioStatus
        consumes:
          - application/json
        produces:
          - application/json
        parameters:
          - type: string
            required: true
            name: reportPortfolioIdn
            in: path
        responses:
          200:
            description: Changed portfolio row
            schema:
              $ref: '#/definitions/RTReportsPortfolioRow'
          405:
            description: Change failed
  /reports-templates/groups/{reportGroupIdn}:
    delete:
      tags:
        - reports-templates
      summary: removeReportsGroup
      description: Remove specified group
      operationId: removeReportsGroup
      produces:
        - application/json
      parameters:
        - type: string
          required: true
          name: reportGroupIdn
          in: path
      responses:
        200:
          description: Removed group
          schema:
             $ref: '#/definitions/RTReportsGroupRow'
  /reports-templates/groups/{reportGroupIdn}/addClient/{portfolioIdn}:
    post:
      tags:
        - reports-templates
      summary: addClientToGroup
      description: Add client to group
      operationId: addClientToGroup
      produces:
        - application/json
      parameters:
        - type: string
          required: true
          name: reportGroupIdn
          in: path
        - type: string
          required: true
          name: portfolioIdn
          in: path
      responses:
        200:
          description: client added to group
        405:
          description: can not add client to group
  /reports-templates/groups/update:
    put:
      tags:
        - reports-templates
      summary: updateGroups
      description: Update groups
      operationId: updateGroups
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: groups
          in: body
          schema:
            type: array
            items:
              $ref: '#/definitions/RTReportsGroupRow'
      responses:
        200:
          description: Updated groups
          schema:
            type: array
            items:
              $ref: '#/definitions/RTReportsGroupRow'
        412:
          description: Can not update groups
definitions:
  RTReportsGroupRow:
    type: object
    properties:
      reportGroupIdn:
        type: string
      reportGroupName:
        type: string
      isDefault:
        type: boolean
      portfolios:
        type: array
        items:
          type: string
  RTReportsPortfolioRow:
    type: object
    properties:
      portfolioIdn:
        type: string
      reportClientIdn:
        type: string
      portfolioName:
        type: string
      clientType:
        type: string
      clientStatus:
        type: string
        enum:
        - REPORTED
        - NOT_ASSIGNED
        - UNREPORTED
      isDefault:
        type: boolean
  RTClientSortAndPaginationCriteria:
    type: object
    properties:
      requestedPage:
        type: number
      pageSize:
        type: number
      sortBy:
        type: string
        enum:
          - PORTFOLIO_NAME
          - CLIENT_TYPE
          - CLIENT_STATUS
      sortDirection:
        type: string
        enum:
          - ASCENDING
          - DESCENDING
  RTGroupSortAndPaginationCriteria:
    type: object
    properties:
      requestedPage:
        type: number
      pageSize:
        type: number
      sortDirection:
        type: string
        enum:
          - ASCENDING
          - DESCENDING
  RTClientsSearchQuery:
      type: object
      properties:
        queryString:
          type: string
        clientSortAndPaginationCriteria:
          $ref: '#/definitions/RTClientSortAndPaginationCriteria'
  RTGroupsSearchQuery:
      type: object
      properties:
        reportGroupNameQueryString:
          type: string
        groupSortAndPaginationCriteria:
          $ref: '#/definitions/RTGroupSortAndPaginationCriteria'