swagger: '2.0'
info:
  description: Configuration for Af report for HDX Desktop resource.
  version: 'v2'
  title: hdx_desktop
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: hdx_desktop
    description: Af report for HDX Desktop
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/hdx_desktop:
    get:
      tags:
        - hdx_desktop
      summary: GET all hdx_desktop
      operationId: getall_hdx_desktop
      description: Af Report for HDX Desktop.
      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: args
          type: string
          required: false
          description: "Use this query-parameter to specify arguments.Example:  property-name1:property-value1 "
        - in: query
          name: duration
          type: string
          required: true
          description: "Duration "
          enum:
            - last_1_hour
            - last_1_day
            - last_1_week
            - last_1_month
        - in: query
          name: cr_enabled
          type: string
          required: false
          description: Use this query-parameter to indicate cr is enabled or not
          enum:
            - 0
            - 1
        - in: query
          name: report_start_time
          type: string
          required: false
          description: Use this query-parameter to specify the start time from which the summary for report is considered
        - in: query
          name: report_end_time
          type: string
          required: false
          description: Use this query-parameter to specify the end time until where summary for report is considered
        - in: query
          name: asc
          type: string
          required: false
          description: Use this query-parameter to specify whether the results should be in ascending order or not
          enum:
            - yes
            - no
        - in: query
          name: sla_enabled
          type: string
          required: false
          description: Use this query-parameter to indicate sla is enabled or not
          enum:
            - 0
            - 1
        - in: query
          name: order_by
          type: string
          required: false
          description: Use this query-parameter to get the result that is ordered by the given property
          enum:
            - desktop_count
            - ica_rtt
        - in: query
          name: type
          type: string
          required: false
          description: Use this query-parameter to specify the type
          enum:
            - desktop_count
            - ica_rtt
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the hdx_desktop 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 hdx_desktop 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 hdx_desktop resources.
          enum:
            - yes
      responses:
        200:
          description:  for hdx_desktop
          schema: 
              $ref: '#/definitions/gethdx_desktopsResponse'
        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:
  gethdx_desktopResponse:
    type: object
    required:
      - hdx_desktop
    properties:
      hdx_desktop:
        $ref: '#/definitions/hdx_desktop'
    title: gethdx_desktopResponse
    example:
      hdx_desktop:
        ica_user_name: "Ram"
        client_srtt: "1.0"
        __count: "1"
        active_session_count: "1"
        hdx_desktop_username: "Ram"
        edt_type: "TCP"
        desktop_count: "5"
        ica_device_ip_address: "1.1.1.1"
        active_desktop_count: "1"
        id: "1.1.1.1"
        ip_address: "1.1.1.1"
        duration_summary_bandwidth: "515.10"
        active_session_duration: "120"
        server_latency: "47.89"
        session_duration: "1000"
        name: "Desktop101"
        total_bytes: "45000"
        rpt_sample_time: "1000"
        client_subnet: "1.1.1.1"
        username: "Ram"
        ica_rtt: "7.89"
        bandwidth: "500.45"
        server_srtt: "1.0"
        selected_time_total_byte: "534"
        client_latency: "23.41"

  gethdx_desktopsResponse:
    type: object
    required:
      - hdx_desktop
    properties:
      hdx_desktop:
        type: array
        items:
          $ref: '#/definitions/hdx_desktop'
    title: gethdx_desktopsResponse
    example:
      hdx_desktop:
        ica_user_name: "Ram"
        client_srtt: "1.0"
        __count: "1"
        active_session_count: "1"
        hdx_desktop_username: "Ram"
        edt_type: "TCP"
        desktop_count: "5"
        ica_device_ip_address: "1.1.1.1"
        active_desktop_count: "1"
        id: "1.1.1.1"
        ip_address: "1.1.1.1"
        duration_summary_bandwidth: "515.10"
        active_session_duration: "120"
        server_latency: "47.89"
        session_duration: "1000"
        name: "Desktop101"
        total_bytes: "45000"
        rpt_sample_time: "1000"
        client_subnet: "1.1.1.1"
        username: "Ram"
        ica_rtt: "7.89"
        bandwidth: "500.45"
        server_srtt: "1.0"
        selected_time_total_byte: "534"
        client_latency: "23.41"

  hdx_desktop_readwrite:
    type: object
    properties:
      ica_user_name:
        description: "ica_user_name"
        type: string
        format: string
      client_srtt:
        description: "client Smothen RTT."
        type: number
        format: double
      __count:
        description: "count."
        type: number
        format: double
      active_session_count:
        description: "active_session_count."
        type: number
        format: double
      hdx_desktop_username:
        description: "hdx_dektop_username"
        type: string
        format: string
      edt_type:
        description: "edt_type"
        type: string
        format: string
      desktop_count:
        description: "desktop_count."
        type: number
        format: double
      ica_device_ip_address:
        description: "Ica device IP Address."
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      active_desktop_count:
        description: "ica active_desktop_count."
        type: number
        format: double
      id:
        description: "Id is HDX Desktop username"
        type: string
        format: string
      ip_address:
        description: "NetScaler IP Address."
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      duration_summary_bandwidth:
        description: "Avg Bandwidth for duration summary."
        type: number
        format: double
      active_session_duration:
        description: "active session duration in seconds."
        type: number
        format: double
      server_latency:
        description: "server latency."
        type: number
        format: double
      session_duration:
        description: "session duration."
        type: number
        format: double
      name:
        description: "HDX Desktop Name"
        type: string
        format: string
      total_bytes:
        description: "Total bytes."
        type: number
        format: double
      rpt_sample_time:
        description: "Report Sample time (epoch time)."
        type: number
        format: double
      client_subnet:
        description: "Client Subnet."
        type: string
        format: ipaddress
        maxLength: 64
      username:
        description: "username"
        type: string
        format: string
      ica_rtt:
        description: "ICA rtt."
        type: number
        format: double
      bandwidth:
        description: "Avg Bandwidth."
        type: number
        format: double
      server_srtt:
        description: "server Smothen RTT."
        type: number
        format: double
      selected_time_total_byte:
        description: "Total bytes accounted by this URL in sampled timeframe."
        type: number
        format: double
      client_latency:
        description: "client latency."
        type: number
        format: double

  hdx_desktop:
    allOf:
      - $ref: '#/definitions/hdx_desktop_readwrite'

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