swagger: '2.0'
info:
  description: Configuration for Profile Safety Data resource.
  version: 'v2'
  title: profile_safety_data
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: profile_safety_data
    description: Profile Safety Data
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}/macro/v1/security/profile_safety_data:
    get:
      tags:
        - profile_safety_data
      summary: GET all profile_safety_data
      operationId: getall_profile_safety_data
      description: Latest Profile safety data information.
      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: 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: type
          type: string
          required: false
          description: Use this query-parameter to specify the type of report
          enum:
            - detail
            - timeseries
            - summary
            - summary_by_profile_type
            - summary_by_profile_sig_name
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the profile_safety_data 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 profile_safety_data 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 profile_safety_data resources.
          enum:
            - yes
      responses:
        200:
          description:  for profile_safety_data
          schema: 
              $ref: '#/definitions/getprofile_safety_datasResponse'
        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:
  getprofile_safety_dataResponse:
    type: object
    required:
      - profile_safety_data
    properties:
      profile_safety_data:
        $ref: '#/definitions/profile_safety_data'
    title: getprofile_safety_dataResponse
    example:
      profile_safety_data:
        profile_block_count: "40"
        iprep_safety_index: "4"
        profile_not_block_count: "40"
        profile_sig_disable_count: "20"
        profile_sig_enable_count: "10"
        profile_none_count: "30"
        profile_sig_name: "profile_sig_name"
        sig_log_count: "40"
        profile_safety_index: "4"
        profile_name: "Profile_1"

  getprofile_safety_datasResponse:
    type: object
    required:
      - profile_safety_data
    properties:
      profile_safety_data:
        type: array
        items:
          $ref: '#/definitions/profile_safety_data'
    title: getprofile_safety_datasResponse
    example:
      profile_safety_data:
        profile_block_count: "40"
        iprep_safety_index: "4"
        profile_not_block_count: "40"
        profile_sig_disable_count: "20"
        profile_sig_enable_count: "10"
        profile_none_count: "30"
        profile_sig_name: "profile_sig_name"
        sig_log_count: "40"
        profile_safety_index: "4"
        profile_name: "Profile_1"

  profile_safety_data_readwrite:
    type: object
    properties:
      profile_block_count:
        description: "block_count."
        type: number
        format: int64
      iprep_safety_index:
        description: "IP Reputation safety index."
        type: integer
        format: int32
      profile_not_block_count:
        description: "not_block_count."
        type: number
        format: int64
      profile_sig_disable_count:
        description: "profile_sig_disable_count"
        type: number
        format: int64
      profile_sig_enable_count:
        description: "sig_enable_count"
        type: number
        format: int64
      profile_none_count:
        description: "none_count."
        type: number
        format: int64
      profile_sig_name:
        description: "profile_sig_name"
        type: string
        format: string
      sig_log_count:
        description: "sig_log_count"
        type: number
        format: int64
      profile_safety_index:
        description: "profile safety index."
        type: integer
        format: int32
      profile_name:
        description: "profile_name"
        type: string
        format: string

  profile_safety_data:
    allOf:
      - $ref: '#/definitions/profile_safety_data_readwrite'

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