swagger: '2.0'
info:
  description: Configuration for Activity Status resource.
  version: 'v2'
  title: poll_activity_status
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: poll_activity_status
    description: Activity Status
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: id
   in: path
   type: string
   description: Id is system generated key for all the task logs
   required: true
  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/poll_activity_status:
    get:
      tags:
        - poll_activity_status
      summary: GET all poll_activity_status
      operationId: getall_poll_activity_status
      description: Use this operation to get activity status
      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 poll_activity_status 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 poll_activity_status 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 poll_activity_status resources.
          enum:
            - yes
      responses:
        200:
          description:  for poll_activity_status
          schema: 
              $ref: '#/definitions/getpoll_activity_statussResponse'
        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'

  /massvc/{customerid}/nitro/v2/config/poll_activity_status/{id}:
    get:
      tags:
        - poll_activity_status
      summary: GET by key for poll_activity_status
      operationId: getbykey_poll_activity_status
      description: Use this operation to get activity status
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/idParam'
        - 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
      responses:
        200:
          description:  for poll_activity_status
          schema: 
              $ref: '#/definitions/getpoll_activity_statusResponse'
        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:
  getpoll_activity_statusResponse:
    type: object
    required:
      - poll_activity_status
    properties:
      poll_activity_status:
        $ref: '#/definitions/poll_activity_status'
    title: getpoll_activity_statusResponse
    example:
      poll_activity_status:
        instance_level_progress: "integer_value"
        status: "Completed"
        message: "ns_client_ipaddress : 1.1.1.1"
        ns_ip_address: "1.1.1.1"
        total_instances: "integer_value"
        is_last: "boolean_value"
        act_id: "{stylebook_params}"
        timestamp: "1579491807.00"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        module: "api"

  getpoll_activity_statussResponse:
    type: object
    required:
      - poll_activity_status
    properties:
      poll_activity_status:
        type: array
        items:
          $ref: '#/definitions/poll_activity_status'
    title: getpoll_activity_statussResponse
    example:
      poll_activity_status:
        instance_level_progress: "integer_value"
        status: "Completed"
        message: "ns_client_ipaddress : 1.1.1.1"
        ns_ip_address: "1.1.1.1"
        total_instances: "integer_value"
        is_last: "boolean_value"
        act_id: "{stylebook_params}"
        timestamp: "1579491807.00"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        module: "api"

  poll_activity_status_readwrite:
    type: object
    properties:
      instance_level_progress:
        description: "Instance level Polling Progress Percentage"
        type: integer
        format: int32
      status:
        description: "Status"
        type: string
        format: string
      message:
        description: "Message"
        type: string
        format: string
      ns_ip_address:
        description: "NetScaler IP Address"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      total_instances:
        description: "Total number of devices to be polled"
        type: integer
        format: int32
      timestamp:
        description: "timestamp in seconds"
        type: number
        format: double

  poll_activity_status:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key for all the task logs
            type: string
            format: uuid
          is_last:
             description: "is_last"
             type: boolean
             format: boolean
          act_id:
             description: "Activity Id"
             type: string
             format: string
          module:
             description: "Module name in which the Polling is done"
             type: string
             format: string
      - $ref: '#/definitions/poll_activity_status_readwrite'

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