swagger: '2.0'
info:
  description: Configuration for Af report for ICA App resource.
  version: 'v2'
  title: ica_app
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: ica_app
    description: Af report for ICA App
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/ica_app:
    get:
      tags:
        - ica_app
      summary: GET all ica_app
      operationId: getall_ica_app
      description: Af Report for ICA App.
      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:
            - timeline_user_count
            - active_launches
            - app_launch_count
            - user_count
            - launch_duration
        - in: query
          name: type
          type: string
          required: false
          description: Use this query-parameter to specify the type
          enum:
            - timeline_user_count
            - active_launches
            - app_launch_count
            - user_count
            - launch_duration
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the ica_app 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 ica_app 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 ica_app resources.
          enum:
            - yes
      responses:
        200:
          description:  for ica_app
          schema: 
              $ref: '#/definitions/getica_appsResponse'
        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:
  getica_appResponse:
    type: object
    required:
      - ica_app
    properties:
      ica_app:
        $ref: '#/definitions/ica_app'
    title: getica_appResponse
    example:
      ica_app:
        ica_user_name: "Alex"
        __count: "1"
        active_session_count: "1"
        state: "Up"
        app_launch_count: "1"
        launch_duration: "1500"
        id: "00000000-0000-375c-0000-000400000004"
        app_enumeration_duration: "900"
        app_count: "1"
        name: "testapp"
        total_bytes: "13002"
        is_active: "0"
        user_count: "1"
        usage_time: "1000"
        app_start_time: "1582552912"
        ica_device_ip_address: "1.1.1.1"
        active_launches: "1"
        active_app_count: "1"
        ica_session_id: "e4d8ec98cfda4250a3081b6f238b18ea"
        up_time: "1000"
        rpt_sample_time: "0"
        app_start_time_local: "1582552912"
        app_terminate_time: "1582559912"

  getica_appsResponse:
    type: object
    required:
      - ica_app
    properties:
      ica_app:
        type: array
        items:
          $ref: '#/definitions/ica_app'
    title: getica_appsResponse
    example:
      ica_app:
        ica_user_name: "Alex"
        __count: "1"
        active_session_count: "1"
        state: "Up"
        app_launch_count: "1"
        launch_duration: "1500"
        id: "00000000-0000-375c-0000-000400000004"
        app_enumeration_duration: "900"
        app_count: "1"
        name: "testapp"
        total_bytes: "13002"
        is_active: "0"
        user_count: "1"
        usage_time: "1000"
        app_start_time: "1582552912"
        ica_device_ip_address: "1.1.1.1"
        active_launches: "1"
        active_app_count: "1"
        ica_session_id: "e4d8ec98cfda4250a3081b6f238b18ea"
        up_time: "1000"
        rpt_sample_time: "0"
        app_start_time_local: "1582552912"
        app_terminate_time: "1582559912"

  ica_app_readwrite:
    type: object
    properties:
      __count:
        description: "count."
        type: number
        format: double
      active_session_count:
        description: "active_session_count."
        type: number
        format: double
      state:
        description: "App state."
        type: string
        format: string
      app_launch_count:
        description: "ica app_launch_count"
        type: number
        format: double
      launch_duration:
        description: "ICA App launch duration."
        type: number
        format: double
      id:
        description: "Id is ICA App  Name"
        type: string
        format: string
        minLength: 1
        maxLength: 64
      app_enumeration_duration:
        description: "ica app enumeration duration."
        type: number
        format: double
      app_count:
        description: "ica app_count."
        type: number
        format: double
      name:
        description: "Name of ICA Device"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      total_bytes:
        description: "Total bytes accounted by this URL in sampled timeframe."
        type: number
        format: double
      is_active:
        description: "Is Active."
        type: number
        format: double
      user_count:
        description: "user_count."
        type: number
        format: double
      usage_time:
        description: "ica app usages time."
        type: number
        format: double
      app_start_time:
        description: "Application start time."
        type: number
        format: double
      active_launches:
        description: "ica active_launches"
        type: number
        format: double
      active_app_count:
        description: "ica active_app_count."
        type: number
        format: double
      up_time:
        description: "ica app up time."
        type: number
        format: double
      rpt_sample_time:
        description: "Report Sample time."
        type: number
        format: double
      app_start_time_local:
        description: "Application start time in local timezone."
        type: number
        format: double
      app_terminate_time:
        description: "Application terminate time."
        type: number
        format: double

  ica_app:
    allOf:
      - $ref: '#/definitions/ica_app_readwrite'

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