swagger: '2.0'
info:
  description: Configuration for Af report for HDX Desktop Session resource.
  version: 'v2'
  title: hdx_desktop_session
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: hdx_desktop_session
    description: Af report for HDX Desktop Session
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_session:
    get:
      tags:
        - hdx_desktop_session
      summary: GET all hdx_desktop_session
      operationId: getall_hdx_desktop_session
      description: Af Report for HDX Desktop Session.
      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:
            - bandwidth
            - sr_reconnect_count
            - acr_count
        - in: query
          name: type
          type: string
          required: false
          description: Use this query-parameter to specify the type
          enum:
            - bandwidth
            - sr_reconnect_count
            - acr_count
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the hdx_desktop_session 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_session 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_session resources.
          enum:
            - yes
      responses:
        200:
          description:  for hdx_desktop_session
          schema: 
              $ref: '#/definitions/gethdx_desktop_sessionsResponse'
        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_desktop_sessionResponse:
    type: object
    required:
      - hdx_desktop_session
    properties:
      hdx_desktop_session:
        $ref: '#/definitions/hdx_desktop_session'
    title: gethdx_desktop_sessionResponse
    example:
      hdx_desktop_session:
        serverside_packet_retransmits: "0"
        user_type: "0"
        hdx_desktop_username: "test_user"
        is_msi: "0"
        count_usb_rejected: "0"
        ip_block_name: "*"
        launch_duration: "10"
        latitude: "12.9716"
        l7_threshold_configure_value: "0"
        longitude: "77.5946"
        region_code: "BLR"
        host_delay: "52"
        region: "Bangalore"
        total_bytes: "79138"
        is_active: "1"
        client_ip_address: "1.1.1.1"
        pn_agent_version: "0"
        client_latency: "40"
        count_usb_accepted: "0"
        client_hostname: "MyDesktop"
        usb_status: "number_value"
        client_side_ns_delay: "152"
        server_side_ns_delay: "152"
        application_enumeration_duration: "0"
        session_reconnect: "0"
        serverside_rto: "1"
        l7_threshold_max_server_breach: "0"
        duration_summary_bandwidth: "0"
        country: "IND"
        session_hop_diagram: "true"
        clientside_packet_retransmits: "0"
        server_ip_address: "1.1.1.1"
        count_usb_stopped: "0"
        rpt_sample_time: "1580364711"
        clientside_0_win: "2"
        bandwidth: "10"
        session_setup_time: "1580364711"
        clientside_rto: "1"
        ica_app_name: "app1"
        client_version: "14.1.12"
        clientside_cb: "1"
        session_rtt: "0"
        __count: "10"
        country_code: "string_value"
        l7_threshold_breach_count: "0"
        state: "Active"
        euem: "0"
        client_type: "Citrix Windows client"
        device_type: "1"
        l7_clientside_latency: "10"
        server_jitter: "-1"
        client_jitter: "-1"
        id: "00000000-0000-375c-0000-000400000004"
        serverside_0_win: "1"
        is_multi_hop: "0"
        server_latency: "40"
        l7_threshold_max_client_breach: "0"
        serverside_cb: "1"
        l7_threshold_avg_client_breach: "0"
        acr_count: "0"
        session_duration: "40"
        ica_rtt: "100"
        sr_reconnect_count: "0"
        selected_time_total_byte: "0"
        ha_failover_count: "0"
        l7_monitoring_supported: "0"
        l7_threshold_avg_server_breach: "0"
        client_srtt: "40"
        edt_type: "Unknown"
        ica_device_ip_address: "1.1.1.1"
        city: "Bangalore"
        receiver_version: "1.1.1"
        vdi_image_name: "image_name"
        up_time: "-1"
        client_tx_bytes: "-1"
        session_setup_time_local: "154233212"
        client_rx_bytes: "-1"
        server_srtt: "40"
        session_end_time: "1580364711"
        l7_serverside_latency: "10"

  gethdx_desktop_sessionsResponse:
    type: object
    required:
      - hdx_desktop_session
    properties:
      hdx_desktop_session:
        type: array
        items:
          $ref: '#/definitions/hdx_desktop_session'
    title: gethdx_desktop_sessionsResponse
    example:
      hdx_desktop_session:
        serverside_packet_retransmits: "0"
        user_type: "0"
        hdx_desktop_username: "test_user"
        is_msi: "0"
        count_usb_rejected: "0"
        ip_block_name: "*"
        launch_duration: "10"
        latitude: "12.9716"
        l7_threshold_configure_value: "0"
        longitude: "77.5946"
        region_code: "BLR"
        host_delay: "52"
        region: "Bangalore"
        total_bytes: "79138"
        is_active: "1"
        client_ip_address: "1.1.1.1"
        pn_agent_version: "0"
        client_latency: "40"
        count_usb_accepted: "0"
        client_hostname: "MyDesktop"
        usb_status: "number_value"
        client_side_ns_delay: "152"
        server_side_ns_delay: "152"
        application_enumeration_duration: "0"
        session_reconnect: "0"
        serverside_rto: "1"
        l7_threshold_max_server_breach: "0"
        duration_summary_bandwidth: "0"
        country: "IND"
        session_hop_diagram: "true"
        clientside_packet_retransmits: "0"
        server_ip_address: "1.1.1.1"
        count_usb_stopped: "0"
        rpt_sample_time: "1580364711"
        clientside_0_win: "2"
        bandwidth: "10"
        session_setup_time: "1580364711"
        clientside_rto: "1"
        ica_app_name: "app1"
        client_version: "14.1.12"
        clientside_cb: "1"
        session_rtt: "0"
        __count: "10"
        country_code: "string_value"
        l7_threshold_breach_count: "0"
        state: "Active"
        euem: "0"
        client_type: "Citrix Windows client"
        device_type: "1"
        l7_clientside_latency: "10"
        server_jitter: "-1"
        client_jitter: "-1"
        id: "00000000-0000-375c-0000-000400000004"
        serverside_0_win: "1"
        is_multi_hop: "0"
        server_latency: "40"
        l7_threshold_max_client_breach: "0"
        serverside_cb: "1"
        l7_threshold_avg_client_breach: "0"
        acr_count: "0"
        session_duration: "40"
        ica_rtt: "100"
        sr_reconnect_count: "0"
        selected_time_total_byte: "0"
        ha_failover_count: "0"
        l7_monitoring_supported: "0"
        l7_threshold_avg_server_breach: "0"
        client_srtt: "40"
        edt_type: "Unknown"
        ica_device_ip_address: "1.1.1.1"
        city: "Bangalore"
        receiver_version: "1.1.1"
        vdi_image_name: "image_name"
        up_time: "-1"
        client_tx_bytes: "-1"
        session_setup_time_local: "154233212"
        client_rx_bytes: "-1"
        server_srtt: "40"
        session_end_time: "1580364711"
        l7_serverside_latency: "10"

  hdx_desktop_session_readwrite:
    type: object
    properties:
      serverside_packet_retransmits:
        description: "Server side packet retransmits."
        type: number
        format: double
      user_type:
        description: "User Access Type"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      is_msi:
        description: "If Session is MSI or not"
        type: number
        format: double
      count_usb_rejected:
        description: "No. of times USB Rejected"
        type: number
        format: double
      ip_block_name:
        description: "ip_block_name"
        type: string
        format: string
      launch_duration:
        description: "ica session launch duration."
        type: number
        format: double
      latitude:
        description: "latitude"
        type: number
        format: double
      l7_threshold_configure_value:
        description: "L7 Threshold value"
        type: number
        format: double
      longitude:
        description: "longitude"
        type: number
        format: double
      region_code:
        description: "region_code"
        type: string
        format: string
      host_delay:
        description: "Server induced delay."
        type: number
        format: double
      region:
        description: "region"
        type: string
        format: string
      total_bytes:
        description: "Total bytes."
        type: number
        format: double
      is_active:
        description: "Is Active."
        type: number
        format: double
      pn_agent_version:
        description: "Name of ICA session pn agent version"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      client_latency:
        description: "client latency."
        type: number
        format: double
      count_usb_accepted:
        description: "No. of times USB Accepted"
        type: number
        format: double
      client_hostname:
        description: "city"
        type: string
        format: string
        maxLength: 255
      usb_status:
        description: "USB Redirection Status"
        type: number
        format: double
      client_side_ns_delay:
        description: "Client to Server NetScaler delay."
        type: number
        format: double
      server_side_ns_delay:
        description: "Server to Client NetScaler delay."
        type: number
        format: double
      application_enumeration_duration:
        description: "Time taken for app enumeration to launch."
        type: number
        format: double
      session_reconnect:
        description: "Session reconnect."
        type: number
        format: double
      serverside_rto:
        description: "serverside rto."
        type: number
        format: double
      l7_threshold_max_server_breach:
        description: "L7 Threshold MAX Server Breach Value"
        type: number
        format: double
      duration_summary_bandwidth:
        description: "Avg Bandwidth for duration summary."
        type: number
        format: double
      country:
        description: "country"
        type: string
        format: string
      session_hop_diagram:
        description: "Session Hop Diagram"
        type: boolean
        format: boolean
      clientside_packet_retransmits:
        description: "Client side packet retransmits."
        type: number
        format: double
      server_ip_address:
        description: "Server IP Address."
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      count_usb_stopped:
        description: "No. of times USB Stopped"
        type: number
        format: double
      rpt_sample_time:
        description: "Report Sample time."
        type: number
        format: double
      clientside_0_win:
        description: "Client side 0 window count."
        type: number
        format: double
      bandwidth:
        description: "Avg Bandwidth."
        type: number
        format: double
      session_setup_time:
        description: "ICA Session setup time."
        type: number
        format: double
      clientside_rto:
        description: "clientside rto."
        type: number
        format: double
      client_version:
        description: "Client Version"
        type: string
        format: string
        maxLength: 1024
      clientside_cb:
        description: "clientside cb"
        type: number
        format: double
      session_rtt:
        description: "ICA Session rtt."
        type: number
        format: double
      __count:
        description: "count."
        type: number
        format: double
      country_code:
        description: "country_code"
        type: string
        format: string
      l7_threshold_breach_count:
        description: "L7 Threshold Breach Count Value"
        type: number
        format: double
      state:
        description: "Desktop Session state."
        type: string
        format: string
      euem:
        description: "EUEM."
        type: number
        format: double
      client_type:
        description: "Client Type"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      device_type:
        description: "Device Type."
        type: string
        format: string
      l7_clientside_latency:
        description: "L7 clientside latency"
        type: number
        format: double
      server_jitter:
        description: "ICA User server jitter."
        type: number
        format: double
      client_jitter:
        description: "ICA User client jitter."
        type: number
        format: double
      id:
        description: "Id is HDX Desktop user session ID"
        type: string
        format: uuid
      serverside_0_win:
        description: "server side 0 window count."
        type: number
        format: double
      is_multi_hop:
        description: "Is Multi hop."
        type: number
        format: double
      server_latency:
        description: "server latency."
        type: number
        format: double
      l7_threshold_max_client_breach:
        description: "L7 Threshold MAX Client Breach Value"
        type: number
        format: double
      serverside_cb:
        description: "serverside cb"
        type: number
        format: double
      l7_threshold_avg_client_breach:
        description: "L7 Threshold AVG Client Breach Value"
        type: number
        format: double
      acr_count:
        description: "Session Reliability ACR count"
        type: number
        format: double
      session_duration:
        description: "session duration."
        type: number
        format: double
      ica_rtt:
        description: "ICA rtt."
        type: number
        format: double
      sr_reconnect_count:
        description: "Session Reliability Reconnect count"
        type: number
        format: double
      selected_time_total_byte:
        description: "Total bytes accounted by this URL in sampled timeframe."
        type: number
        format: double
      ha_failover_count:
        description: "ha_failover_count"
        type: number
        format: double
      l7_monitoring_supported:
        description: "L7 monitoring Supported or not"
        type: number
        format: double
      l7_threshold_avg_server_breach:
        description: "L7 Threshold AVG Server Breach Value"
        type: number
        format: double
      client_srtt:
        description: "client Smothen RTT."
        type: number
        format: double
      edt_type:
        description: "edt_type"
        type: string
        format: string
      city:
        description: "city"
        type: string
        format: string
      receiver_version:
        description: "Name of ICA session receiver version"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      vdi_image_name:
        description: "vdi_image_name"
        type: string
        format: string
      up_time:
        description: "ica session up time."
        type: number
        format: double
      client_tx_bytes:
        description: "Client Side Tx bytes."
        type: number
        format: double
      session_setup_time_local:
        description: "ICA Session setup time in local timezone."
        type: number
        format: double
      client_rx_bytes:
        description: "Client Side Rx bytes."
        type: number
        format: double
      server_srtt:
        description: "server Smothen RTT."
        type: number
        format: double
      session_end_time:
        description: "ICA Session end time."
        type: number
        format: double
      l7_serverside_latency:
        description: "L7 serverside latency"
        type: number
        format: double

  hdx_desktop_session:
    allOf:
      - $ref: '#/definitions/hdx_desktop_session_readwrite'

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