swagger: '2.0'
info:
  description: Configuration for NetScaler Filter Policy Configure Task resource.
  version: 'v2'
  title: ns_filterpolicy_template
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: ns_filterpolicy_template
    description: NetScaler Filter Policy Configure Task
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/ns_filterpolicy_template:
    get:
      tags:
        - ns_filterpolicy_template
      summary: GET all ns_filterpolicy_template
      operationId: getall_ns_filterpolicy_template
      description: Use this operation to get device profiles
      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 ns_filterpolicy_template 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 ns_filterpolicy_template 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 ns_filterpolicy_template resources.
          enum:
            - yes
      responses:
        200:
          description:  for ns_filterpolicy_template
          schema: 
              $ref: '#/definitions/getns_filterpolicy_templatesResponse'
        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'

    post:
      tags:
        - ns_filterpolicy_template
      summary: POST operation for ns_filterpolicy_template
      operationId: post_ns_filterpolicy_template
      description: POST operation for ns_filterpolicy_template
      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: onerror
          description: Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
          required: false
          type: string
          default: CONTINUE
          enum:
            - EXIT
            - CONTINUE
        - in: body
          name: ns_filterpolicy_template
          description: ns_filterpolicy_template object
          schema:
              $ref: '#/definitions/addns_filterpolicy_templateRequest'
      responses:
        200:
          description: add for ns_filterpolicy_template
          schema: 
              $ref: '#/definitions/addns_filterpolicy_templateResponse'
        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:
  addns_filterpolicy_templateRequest:
    type: object
    required:
      - ns_filterpolicy_template
    properties:
      ns_filterpolicy_template:
        $ref: '#/definitions/ns_filterpolicy_template_readwrite'
    title: addns_filterpolicy_templateRequest
    example:
      ns_filterpolicy_template:
        priority: "0"
        device_groups: "[devgrp1, devgrp2]"
        name: "www.citrix.com"
        variables: [{        parent_name: "string_value"
,        value: "string_value"
,        name: "string_value"
,        valuex: "string_value"
,        display_name: "string_value"
,        description: "string_value"
,        device_values: [{        value: "string_value"
,        id: "string_value"
,        valuex: "string_value"
,        device_group: "string_value"
,        device: "string_value"
}]
,        parent_id: "string_value"
,        default_value: "string_value"
,        id: "string_value"
,        type: "string_value"
,        values_enum_db: "string_value"
}]
        state: "UP"
        devices: "1.1.1.1"
        actionType: "string_value"
        actionName: "string_value"
        expression: "string_value"

  addns_filterpolicy_templateResponse:
    type: object
    required:
      - ns_filterpolicy_template
    properties:
      ns_filterpolicy_template:
        $ref: '#/definitions/ns_filterpolicy_template'
    title: addns_filterpolicy_templateResponse
    example:
      ns_filterpolicy_template:
        priority: "0"
        device_groups: "[devgrp1, devgrp2]"
        name: "www.citrix.com"
        variables: [{        device_values_mapping: "string_value"
,        parent_name: "string_value"
,        value: "string_value"
,        name: "string_value"
,        valuex: "string_value"
,        display_name: "string_value"
,        description: "string_value"
,        device_values: [{}]
,        parent_id: "string_value"
,        default_value: "string_value"
,        id: "string_value"
,        type: "string_value"
,        values_enum_db: "string_value"
}]
        state: "UP"
        devices: "1.1.1.1"
        actionType: "string_value"
        actionName: "string_value"
        expression: "string_value"

  getns_filterpolicy_templateResponse:
    type: object
    required:
      - ns_filterpolicy_template
    properties:
      ns_filterpolicy_template:
        $ref: '#/definitions/ns_filterpolicy_template'
    title: getns_filterpolicy_templateResponse
    example:
      ns_filterpolicy_template:
        priority: "0"
        device_groups: "[devgrp1, devgrp2]"
        name: "www.citrix.com"
        variables: [{        device_values_mapping: "string_value"
,        parent_name: "string_value"
,        value: "string_value"
,        name: "string_value"
,        valuex: "string_value"
,        display_name: "string_value"
,        description: "string_value"
,        device_values: [{}]
,        parent_id: "string_value"
,        default_value: "string_value"
,        id: "string_value"
,        type: "string_value"
,        values_enum_db: "string_value"
}]
        state: "UP"
        devices: "1.1.1.1"
        actionType: "string_value"
        actionName: "string_value"
        expression: "string_value"

  getns_filterpolicy_templatesResponse:
    type: object
    required:
      - ns_filterpolicy_template
    properties:
      ns_filterpolicy_template:
        type: array
        items:
          $ref: '#/definitions/ns_filterpolicy_template'
    title: getns_filterpolicy_templatesResponse
    example:
      ns_filterpolicy_template:
        priority: "0"
        device_groups: "[devgrp1, devgrp2]"
        name: "www.citrix.com"
        variables: [{        device_values_mapping: "string_value"
,        parent_name: "string_value"
,        value: "string_value"
,        name: "string_value"
,        valuex: "string_value"
,        display_name: "string_value"
,        description: "string_value"
,        device_values: [{}]
,        parent_id: "string_value"
,        default_value: "string_value"
,        id: "string_value"
,        type: "string_value"
,        values_enum_db: "string_value"
}]
        state: "UP"
        devices: "1.1.1.1"
        actionType: "string_value"
        actionName: "string_value"
        expression: "string_value"

  ns_filterpolicy_template_readwrite:
    type: object
    properties:
      priority:
        description: "Policy Priority"
        type: integer
        format: int32
      device_groups:
        description: "Device Group Array on which for which template is applied"
        type: array
        items:
          type: string
          format: string
      name:
        description: "Name of Policy"
        type: string
        format: string
      variables:
        type: array
        items:
          $ref: '#/definitions/variable_values_readwrite'
      state:
        description: "State of the Policy: enabled/disabled"
        type: string
        format: string
      devices:
        description: "Device IP Address Array on which template is applied"
        type: array
        items:
          type: string
          format: IP Address
      actionType:
        description: "Action Type of the Policy"
        type: string
        format: string
      actionName:
        description: "Action Name of the Policy"
        type: string
        format: string
      expression:
        description: "Expression of the Policy"
        type: string
        format: string

  ns_filterpolicy_template:
    allOf:
      - $ref: '#/definitions/ns_filterpolicy_template_readwrite'

  variable_values_readwrite:
    type: object
    properties:
      parent_name:
        type: string
        format: string
      value:
        description: "Value of the Variable to be used for all device ips/groups"
        type: string
        format: string
      name:
        description: "Variable name"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      valuex:
        description: "Secure Value of the Variable to be used for all device ips/groups"
        type: string
        format: password
      display_name:
        description: "Display name of configuration variable"
        type: string
        format: string
        minLength: 1
        maxLength: 1024
      description:
        description: "Description of configuration variable"
        type: string
        format: string
        minLength: 1
        maxLength: 1024
      device_values:
        type: array
        items:
          $ref: '#/definitions/device_values_map_readwrite'
      parent_id:
        type: string
        format: string
      default_value:
        description: "Default Value of configuration variable"
        type: string
        format: string
      type:
        description: "Type of Variable"
        type: string
        format: string
        minLength: 1
        maxLength: 64
      values_enum_db:
        description: "Comma separated list of possible values of variable"
        type: string
        format: string

  variable_values:
    allOf:
      -
        properties:
          id:
            type: string
            format: string
      - $ref: '#/definitions/variable_values_readwrite'

  device_values_map_readwrite:
    type: object
    properties:
      value:
        description: "Value of the Variable to be used for device ip/group"
        type: string
        format: string
      valuex:
        description: "Secure Value of the Variable to be used for device ip/group"
        type: string
        format: password
      device_group:
        description: "Device Group for which value is to be defined"
        type: string
        format: string
      device:
        description: "IP Address for this device"
        type: string
        format: ipaddress

  device_values_map:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key for all the device value mapping
            type: string
            format: uuid
          parent_name:
             description: "Parent Name"
             type: string
             format: string
          parent_id:
             description: "Parent ID"
             type: string
             format: uuid
      - $ref: '#/definitions/device_values_map_readwrite'

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