swagger: '2.0'
info:
  description: Configuration for Task Log resource.
  version: 'v2'
  title: task_log
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: task_log
    description: Task Log
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/task_log:
    get:
      tags:
        - task_log
      summary: GET all task_log
      operationId: getall_task_log
      description: Use this operation to get task
      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 task_log 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 task_log 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 task_log resources.
          enum:
            - yes
      responses:
        200:
          description:  for task_log
          schema: 
              $ref: '#/definitions/gettask_logsResponse'
        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/task_log/{id}:
    get:
      tags:
        - task_log
      summary: GET by key for task_log
      operationId: getbykey_task_log
      description: Use this operation to get task
      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 task_log
          schema: 
              $ref: '#/definitions/gettask_logResponse'
        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:
  gettask_logResponse:
    type: object
    required:
      - task_log
    properties:
      task_log:
        $ref: '#/definitions/task_log'
    title: gettask_logResponse
    example:
      task_log:
        executed_by: "nsroot"
        status: "Completed"
        name: "Configure_AppFlow"
        tenant_id: "7ed7946f-4af7-11e9-99d2-b6fe81a85d18"
        starttime: "1579734319"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        endtime: "1579734319"
        tag: "sharepoint_application"

  gettask_logsResponse:
    type: object
    required:
      - task_log
    properties:
      task_log:
        type: array
        items:
          $ref: '#/definitions/task_log'
    title: gettask_logsResponse
    example:
      task_log:
        executed_by: "nsroot"
        status: "Completed"
        name: "Configure_AppFlow"
        tenant_id: "7ed7946f-4af7-11e9-99d2-b6fe81a85d18"
        starttime: "1579734319"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        endtime: "1579734319"
        tag: "sharepoint_application"


  task_log:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key for all the task logs
            type: string
            format: uuid
          executed_by:
             description: "User Name"
             type: string
             format: string
             minLength: 1
             maxLength: 128
          status:
             description: "Status"
             type: string
             format: string
             maxLength: 128
          name:
             description: "Task Name"
             type: string
             format: string
             minLength: 1
             maxLength: 128
          starttime:
             description: "Start Time"
             type: integer
             format: int32
          endtime:
             description: "End Time"
             type: integer
             format: int32
          tag:
             description: "Tag. Used in tracking tasks created by specific entities, say an application."
             type: string
             format: string
             maxLength: 128

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