swagger: '2.0'
info:
  description: Configuration for Af report for Threshold breach timeline resource.
  version: 'v2'
  title: threshold_breach_timeline
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: threshold_breach_timeline
    description: Af report for Threshold breach timeline
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/threshold_breach_timeline:
    get:
      tags:
        - threshold_breach_timeline
      summary: GET all threshold_breach_timeline
      operationId: getall_threshold_breach_timeline
      description: Af report for Threshold breach timeline.
      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: sla_enabled
          type: string
          required: false
          description: Use this query-parameter to indicate sla is enabled or not
          enum:
            - 0
            - 1
        - in: query
          name: type
          type: string
          required: false
          description: Use this query-parameter to specify the type
          enum:
            - ica_rtt
            - timeline_user_count
            - license_in_use
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the threshold_breach_timeline 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 threshold_breach_timeline 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 threshold_breach_timeline resources.
          enum:
            - yes
      responses:
        200:
          description:  for threshold_breach_timeline
          schema: 
              $ref: '#/definitions/getthreshold_breach_timelinesResponse'
        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:
  getthreshold_breach_timelineResponse:
    type: object
    required:
      - threshold_breach_timeline
    properties:
      threshold_breach_timeline:
        $ref: '#/definitions/threshold_breach_timeline'
    title: getthreshold_breach_timelineResponse
    example:
      threshold_breach_timeline:
        breach_entity_type: "APP"
        rpt_sample_time: "1580794364"
        __count: "10"
        breach_metric: "Hits"
        breach_count: "10"
        breach_entity: "outlook"
        breach_value: "10"

  getthreshold_breach_timelinesResponse:
    type: object
    required:
      - threshold_breach_timeline
    properties:
      threshold_breach_timeline:
        type: array
        items:
          $ref: '#/definitions/threshold_breach_timeline'
    title: getthreshold_breach_timelinesResponse
    example:
      threshold_breach_timeline:
        breach_entity_type: "APP"
        rpt_sample_time: "1580794364"
        __count: "10"
        breach_metric: "Hits"
        breach_count: "10"
        breach_entity: "outlook"
        breach_value: "10"

  threshold_breach_timeline_readwrite:
    type: object
    properties:
      breach_entity_type:
        description: "threshold violated entity_type e.g App, Device"
        type: string
        format: string
      rpt_sample_time:
        description: "Timestamp of record"
        type: number
        format: double
      __count:
        description: "Number of records"
        type: number
        format: double
      breach_metric:
        description: "all violated metric configured for entity"
        type: string
        format: string
      breach_count:
        description: "breach_count."
        type: number
        format: double
      breach_entity:
        description: "threshold violated entity e.g outlook"
        type: string
        format: string
      breach_value:
        description: "threshold breached value"
        type: number
        format: double

  threshold_breach_timeline:
    allOf:
      - $ref: '#/definitions/threshold_breach_timeline_readwrite'

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