swagger: '2.0'
info:
  description: Configuration for City wise devices summary resource.
  version: 'v2'
  title: device_summary
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: device_summary
    description: City wise devices summary
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/device_summary:
    get:
      tags:
        - device_summary
      summary: GET all device_summary
      operationId: getall_device_summary
      description: Use this operation to get device summary report
      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 device_summary 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 device_summary 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 device_summary resources.
          enum:
            - yes
      responses:
        200:
          description:  for device_summary
          schema: 
              $ref: '#/definitions/getdevice_summarysResponse'
        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:
  getdevice_summaryResponse:
    type: object
    required:
      - device_summary
    properties:
      device_summary:
        $ref: '#/definitions/device_summary'
    title: getdevice_summaryResponse
    example:
      device_summary:
        total_critical_events: "0"
        longitude: "77.407043"
        total_devices_outofservice: "0"
        total_major_events: "0"
        total_events: "0"
        cityname: "string_value"
        total_agents_outofservice: "0"
        tenant_id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        total_agents_up: "0"
        total_number_of_devices: "0"
        total_devices_down: "0"
        latitude: "8.896610"
        total_devices_up: "0"
        total_number_of_agents: "0"
        total_agents_down: "0"

  getdevice_summarysResponse:
    type: object
    required:
      - device_summary
    properties:
      device_summary:
        type: array
        items:
          $ref: '#/definitions/device_summary'
    title: getdevice_summarysResponse
    example:
      device_summary:
        total_critical_events: "0"
        longitude: "77.407043"
        total_devices_outofservice: "0"
        total_major_events: "0"
        total_events: "0"
        cityname: "string_value"
        total_agents_outofservice: "0"
        tenant_id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        total_agents_up: "0"
        total_number_of_devices: "0"
        total_devices_down: "0"
        latitude: "8.896610"
        total_devices_up: "0"
        total_number_of_agents: "0"
        total_agents_down: "0"

  device_summary_readwrite:
    type: object
    properties:
      cityname:
        description: "City Name"
        type: string
        format: string
        maxLength: 255

  device_summary:
    allOf:
      -
        properties:
          total_critical_events:
             description: "Total Critical events city wise."
             type: integer
             format: int32
          longitude:
             description: "longitude of the city"
             type: number
             format: double
          total_devices_outofservice:
             description: "Total devices out of service city wise."
             type: integer
             format: int32
          total_major_events:
             description: "Total major events."
             type: integer
             format: int32
          total_events:
             description: "Total events city wise."
             type: integer
             format: int32
          total_agents_outofservice:
             description: "Total agents out of service city wise."
             type: integer
             format: int32
          tenant_id:
             description: "Tenant Id"
             type: string
             format: uuid
             maxLength: 255
          total_agents_up:
             description: "Total agents up city wise."
             type: integer
             format: int32
          total_number_of_devices:
             description: "Total number of devices deployed city wise.."
             type: integer
             format: int32
          total_devices_down:
             description: "Total agents down city wise."
             type: integer
             format: int32
          latitude:
             description: "latitude of the city"
             type: number
             format: double
          total_devices_up:
             description: "Total agents down city wise."
             type: integer
             format: int32
          total_number_of_agents:
             description: "Total number of agents deployed city wise."
             type: integer
             format: int32
          total_agents_down:
             description: "Total agents down city wise."
             type: integer
             format: int32
      - $ref: '#/definitions/device_summary_readwrite'

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