swagger: '2.0'
info:
  description: Configuration for AF APP Report table resource.
  version: 'v2'
  title: app_unit_backend
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: app_unit_backend
    description: AF APP Report table
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/app_unit_backend:
    get:
      tags:
        - app_unit_backend
      summary: GET all app_unit_backend
      operationId: getall_app_unit_backend
      description: Af Report for Top Backend APP by Request Count Managed by this AF Collector
      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:
            - total_requests
            - total_bytes
            - application_response_time
        - in: query
          name: type
          type: string
          required: false
          description: Use this query-parameter to specify the type
          enum:
            - total_requests
            - total_bytes
            - application_response_time
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the app_unit_backend 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 app_unit_backend 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 app_unit_backend resources.
          enum:
            - yes
      responses:
        200:
          description:  for app_unit_backend
          schema: 
              $ref: '#/definitions/getapp_unit_backendsResponse'
        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:
  getapp_unit_backendResponse:
    type: object
    required:
      - app_unit_backend
    properties:
      app_unit_backend:
        $ref: '#/definitions/app_unit_backend'
    title: getapp_unit_backendResponse
    example:
      app_unit_backend:
        total_bytes: "12300"
        application_response_time: "12.89"
        network_latency_client_side: "13.89"
        rpt_sample_time: "0"
        __count: "1"
        application_name: "Exchange"
        vservername: "SharepointLBvserver"
        server_response_time: "13.78"
        network_latency_server_side: "23.89"
        netscaler_processing_time: "54.89"
        device_ip_address: "1.1.1.1"
        ctnsappname_b: "Sharepoint"
        total_requests: "100"

  getapp_unit_backendsResponse:
    type: object
    required:
      - app_unit_backend
    properties:
      app_unit_backend:
        type: array
        items:
          $ref: '#/definitions/app_unit_backend'
    title: getapp_unit_backendsResponse
    example:
      app_unit_backend:
        total_bytes: "12300"
        application_response_time: "12.89"
        network_latency_client_side: "13.89"
        rpt_sample_time: "0"
        __count: "1"
        application_name: "Exchange"
        vservername: "SharepointLBvserver"
        server_response_time: "13.78"
        network_latency_server_side: "23.89"
        netscaler_processing_time: "54.89"
        device_ip_address: "1.1.1.1"
        ctnsappname_b: "Sharepoint"
        total_requests: "100"

  app_unit_backend_readwrite:
    type: object
    properties:
      total_bytes:
        description: "Total bytes accounted by this Application in sampled timeframe."
        type: number
        format: double
      application_response_time:
        description: "Application response time."
        type: number
        format: double
      network_latency_client_side:
        description: "Network latency client side."
        type: number
        format: double
      rpt_sample_time:
        description: "Report Sample time."
        type: number
        format: double
      __count:
        description: "count."
        type: number
        format: double
      vservername:
        description: "Application Name"
        type: string
        format: string
        maxLength: 255
      server_response_time:
        description: "Server response time."
        type: number
        format: double
      network_latency_server_side:
        description: "Network latency server side."
        type: number
        format: double
      netscaler_processing_time:
        description: "NetScaler processing time."
        type: number
        format: double
      ctnsappname_b:
        description: "Backend Application Name"
        type: string
        format: string
        maxLength: 255
      total_requests:
        description: "Total requests to this Application in given sampled timeframe."
        type: number
        format: double

  app_unit_backend:
    allOf:
      - $ref: '#/definitions/app_unit_backend_readwrite'

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