swagger: '2.0'
info:
  description: Configuration for mps_user_heatmap resource.
  version: 'v2'
  title: mps_user_heatmap
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: mps_user_heatmap
    description: mps_user_heatmap
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  authParam:
      in: header
      name: Authorization
      type: string
      required: true
      description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
  cloudParam:
      in: header
      name: isCloud
      type: string
      required: true
      description: set the value to true in case of Cloud services, false for on-prem deployment
paths:
  /massvc/{customerid}/nitro/v2/config/mps_user_heatmap:
    get:
      tags:
        - mps_user_heatmap
      summary: GET all mps_user_heatmap
      operationId: getall_mps_user_heatmap
      description: Use this operation to get user heat map
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: query
          name: filter
          type: string
          required: false
          description: "Use this query-parameter to get the filtered set of vm_device resources configured on the system. You can set a filter on any property of the resource.Example:  property-name1:property-value1 "
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the mps_user_heatmap resources in chunks.To be used along with pageno query parameter.
        - in: query
          name: pageno
          type: integer
          required: false
          description: Use this query-parameter to get the mps_user_heatmap resources in chunks.To be used along with pagesize query parameter.
        - in: query
          name: count
          type: string
          required: false
          description: Use this query-parameter to get the count of mps_user_heatmap resources.
          enum:
            - yes
      responses:
        200:
          description:  for mps_user_heatmap
          schema: 
              $ref: '#/definitions/getmps_user_heatmapsResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

definitions:
  getmps_user_heatmapResponse:
    type: object
    required:
      - mps_user_heatmap
    properties:
      mps_user_heatmap:
        $ref: '#/definitions/mps_user_heatmap'
    title: getmps_user_heatmapResponse
    example:
      mps_user_heatmap:
        hits: "number_value"
        region_code: "25"
        lat: "number_value"
        total_bytes: "number_value"
        lng: "number_value"
        total_count: "integer_value"

  getmps_user_heatmapsResponse:
    type: object
    required:
      - mps_user_heatmap
    properties:
      mps_user_heatmap:
        type: array
        items:
          $ref: '#/definitions/mps_user_heatmap'
    title: getmps_user_heatmapsResponse
    example:
      mps_user_heatmap:
        hits: "number_value"
        region_code: "25"
        lat: "number_value"
        total_bytes: "number_value"
        lng: "number_value"
        total_count: "integer_value"

  mps_user_heatmap_readwrite:
    type: object
    properties:
      hits:
        description: "hits"
        type: number
        format: int64
      region_code:
        description: "region_code"
        type: string
        format: string
      lat:
        description: "latitude"
        type: number
        format: double
      total_bytes:
        description: "total_bytes"
        type: number
        format: int64
      lng:
        description: "longitude"
        type: number
        format: double
      total_count:
        description: "Total count"
        type: integer
        format: int32

  mps_user_heatmap:
    allOf:
      - $ref: '#/definitions/mps_user_heatmap_readwrite'

  Error:
    properties:
      errorcode:
        type: number
        format: int32
        example: 1001
      errormessage:
        type: string
        format: string
        example: "id cannot be found"
