swagger: '2.0'
info:
  description: Configuration for SWG Transaction Report resource.
  version: 'v2'
  title: swg_trans_details
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: swg_trans_details
    description: SWG Transaction Report
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/swg_trans_details:
    get:
      tags:
        - swg_trans_details
      summary: GET all swg_trans_details
      operationId: getall_swg_trans_details
      description: Af Report for Top URL being 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: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the swg_trans_details 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 swg_trans_details 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 swg_trans_details resources.
          enum:
            - yes
      responses:
        200:
          description:  for swg_trans_details
          schema: 
              $ref: '#/definitions/getswg_trans_detailssResponse'
        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:
  getswg_trans_detailsResponse:
    type: object
    required:
      - swg_trans_details
    properties:
      swg_trans_details:
        $ref: '#/definitions/swg_trans_details'
    title: getswg_trans_detailsResponse
    example:
      swg_trans_details:
        protocol: "HTTP"
        __count: "0"
        operating_system: "Windows"
        total_ssl_intercepts: "0"
        block_count_prev: "0"
        url_repu_level_2_count_prev: "1"
        total_bytes_in: "64"
        clean_url_count_prev: "1"
        url_reputation_prev: "0"
        urlcategory: "Others"
        user_agent: "testuser4"
        total_bytes: "64"
        url_repu_level_3_count: "1"
        total_bytes_in_prev: "64"
        port: "80"
        total_bytes_prev: "228"
        user_name: "NetScaler123"
        total_requests_prev: "1"
        url_reputation: "0"
        url_category: "Unknown"
        client_ip_address: "1.1.1.1"
        user_count: "1"
        url_repu_level_3_count_prev: "1"
        ssli_action_prev: "None"
        url_repu_level_4_count: "1"
        http_req_method: "GET"
        ssli_action: "None"
        http_rsp_status: "200"
        block_count: "0"
        urlcategory_prev: "Others"
        url_repu_level_2_count: "1"
        url_group_category_prev: "Others"
        domain_name_prev: "video.spiegel.de"
        url_group_category: "Others"
        total_bytes_out_prev: "329"
        url_repu_level_4_count_prev: "1"
        rpt_sample_time: "1580922196"
        user_count_prev: "1"
        domain_name: "video.spiegel.de"
        total_bytes_out: "427"
        exporter_id: "1.1.1.1"
        clean_url_count: "1"
        vserver_name: "testapp"
        total_requests: "1"

  getswg_trans_detailssResponse:
    type: object
    required:
      - swg_trans_details
    properties:
      swg_trans_details:
        type: array
        items:
          $ref: '#/definitions/swg_trans_details'
    title: getswg_trans_detailssResponse
    example:
      swg_trans_details:
        protocol: "HTTP"
        __count: "0"
        operating_system: "Windows"
        total_ssl_intercepts: "0"
        block_count_prev: "0"
        url_repu_level_2_count_prev: "1"
        total_bytes_in: "64"
        clean_url_count_prev: "1"
        url_reputation_prev: "0"
        urlcategory: "Others"
        user_agent: "testuser4"
        total_bytes: "64"
        url_repu_level_3_count: "1"
        total_bytes_in_prev: "64"
        port: "80"
        total_bytes_prev: "228"
        user_name: "NetScaler123"
        total_requests_prev: "1"
        url_reputation: "0"
        url_category: "Unknown"
        client_ip_address: "1.1.1.1"
        user_count: "1"
        url_repu_level_3_count_prev: "1"
        ssli_action_prev: "None"
        url_repu_level_4_count: "1"
        http_req_method: "GET"
        ssli_action: "None"
        http_rsp_status: "200"
        block_count: "0"
        urlcategory_prev: "Others"
        url_repu_level_2_count: "1"
        url_group_category_prev: "Others"
        domain_name_prev: "video.spiegel.de"
        url_group_category: "Others"
        total_bytes_out_prev: "329"
        url_repu_level_4_count_prev: "1"
        rpt_sample_time: "1580922196"
        user_count_prev: "1"
        domain_name: "video.spiegel.de"
        total_bytes_out: "427"
        exporter_id: "1.1.1.1"
        clean_url_count: "1"
        vserver_name: "testapp"
        total_requests: "1"

  swg_trans_details_readwrite:
    type: object
    properties:
      protocol:
        description: "protocol used"
        type: string
        format: string
      __count:
        description: "count."
        type: number
        format: double
      operating_system:
        description: "Client Operating System Name."
        type: string
        format: string
        maxLength: 255
      total_ssl_intercepts:
        description: "Total Intercepts"
        type: number
        format: double
      block_count_prev:
        description: "BLOCK URL Count"
        type: number
        format: double
      url_repu_level_2_count_prev:
        description: "URL reputation level 2 count prev"
        type: number
        format: double
      total_bytes_in:
        description: "Total bytes in"
        type: number
        format: double
      clean_url_count_prev:
        description: "Clean URL count Prev"
        type: number
        format: double
      url_reputation_prev:
        description: "URL reputation"
        type: number
        format: int64
      urlcategory:
        description: "URL Category"
        type: string
        format: string
      user_agent:
        description: "User Agent Name."
        type: string
        format: string
        maxLength: 255
      total_bytes:
        description: "Total bytes"
        type: number
        format: double
      url_repu_level_3_count:
        description: "URL reputation level 3 count"
        type: number
        format: double
      total_bytes_in_prev:
        description: "Total bytes in"
        type: number
        format: double
      port:
        description: "prot used"
        type: number
        format: double
      total_bytes_prev:
        description: "Total bytes prev"
        type: number
        format: double
      user_name:
        description: "User Name"
        type: string
        format: string
        maxLength: 255
      total_requests_prev:
        description: "Total transactions"
        type: number
        format: double
      url_reputation:
        description: "URL reputation"
        type: number
        format: double
      url_category:
        description: "URL Category"
        type: number
        format: double
      client_ip_address:
        description: "Client ip address"
        type: string
        format: string
        maxLength: 255
      user_count:
        description: "Users Count"
        type: number
        format: double
      url_repu_level_3_count_prev:
        description: "URL reputation level 3 count prev"
        type: number
        format: double
      ssli_action_prev:
        description: "URL Action"
        type: string
        format: string
      url_repu_level_4_count:
        description: "URL reputation level 4 count"
        type: number
        format: double
      http_req_method:
        description: "HTTP Request Method."
        type: string
        format: string
        maxLength: 255
      ssli_action:
        description: "URL Action"
        type: string
        format: string
      http_rsp_status:
        description: "HTTP Response Status Method."
        type: string
        format: string
        maxLength: 255
      block_count:
        description: "Block URL Count"
        type: number
        format: double
      urlcategory_prev:
        description: "URL Category"
        type: string
        format: string
      url_repu_level_2_count:
        description: "URL reputation level 2 count"
        type: number
        format: double
      url_group_category_prev:
        description: "URL Group Category"
        type: string
        format: string
      domain_name_prev:
        description: "HTTP Request URL."
        type: string
        format: string
        maxLength: 2000
      url_group_category:
        description: "URL Group Category"
        type: string
        format: string
      total_bytes_out_prev:
        description: "Total bytes out"
        type: number
        format: double
      url_repu_level_4_count_prev:
        description: "URL reputation level 4 count prev"
        type: number
        format: double
      rpt_sample_time:
        description: "Report Sample time."
        type: number
        format: double
      user_count_prev:
        description: "Users Count"
        type: number
        format: double
      domain_name:
        description: "HTTP Request URL."
        type: string
        format: string
        maxLength: 2000
      total_bytes_out:
        description: "Total bytes out"
        type: number
        format: double
      exporter_id:
        description: "Exporter ID"
        type: string
        format: string
        maxLength: 255
      clean_url_count:
        description: "Clean URL count"
        type: number
        format: double
      vserver_name:
        description: "AppName"
        type: string
        format: string
        maxLength: 255
      total_requests:
        description: "Total transactions"
        type: number
        format: double

  swg_trans_details:
    allOf:
      - $ref: '#/definitions/swg_trans_details_readwrite'

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