openapi: 3.2.0
info:
  title: /IOTCONNECT™ Firmware Io T Edge Deployment API
  description: 'Firmware REST API contains information of Device modules. It will give API methods to firmware communication and OTA.


    Headers


    Needed Headers for all the API.


    Authorization    Bearer + access_token (Generated From api/v1.1/auth/login API)


    Content-Type    application/json'
  version: '2.0'
security:
- Bearer: []
tags:
- name: IoTEdgeDeployment
  description: IoTEdge Deployments Api List
paths:
  /api/v2/iot-edge/deployments:
    post:
      tags:
      - IoTEdgeDeployment
      summary: Create new IoT Edge Deployment
      description: ''
      responses:
        '412':
          description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
        '401':
          description: Indicates that authentication is failed because of the token is invalid or expired or missing.
        '500':
          description: Indicates that the request could not be carried out because of some technical error on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsResponse'
        '200':
          description: Indicates that deployment completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IoTEdgeDeploymentCreateResponse'
        '403':
          description: Indicates that the user is not authorized to access this section.
        '409':
          description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.

            Firmware name already exists, firmware software version already exists, firmware hardware version already exists

            and invalid logged user or company.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IoTEdgeDeploymentCreateRequest'
      operationId: postApiV2IotEdgeDeployments
      x-operation-id-source: derived
    get:
      tags:
      - IoTEdgeDeployment
      summary: Get IoT edge deployment list
      description: 'This API endpoint provides you the list of iot edge deployments.


        You can also add the filters as given in the parameters. Though the filters are optional, to apply them, you need to send these filter parameters in a query string.'
      parameters:
      - name: pageNumber
        in: query
        description: 'To fetch specific page data. eg: 2'
        schema:
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: 'To define number of records in single page. eg: 25'
        schema:
          type: integer
          format: int32
      - name: searchText
        in: query
        description: To search for specific texts in the list.
        schema:
          type: string
      - name: sortBy
        in: query
        description: 'To sort the list. To do that, Specify Field name to sort with and sorting order. eg: firstName asc'
        schema:
          type: string
      responses:
        '412':
          description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
        '401':
          description: Indicates that authentication is failed because of the token is invalid or expired or missing.
        '500':
          description: Indicates that the request could not be carried out because of some technical error on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsResponse'
        '200':
          description: Indicates that deployment list is loaded successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IoTEdgeDeploymentListResponse'
        '204':
          description: Indicates that the request has been successfully processed and no records found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoContentResult'
        '403':
          description: Indicates that the user is not authorized to access this section.
        '409':
          description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server

            Company doesn''t exist, Logged in user is not valid etc.'
      operationId: getApiV2IotEdgeDeployments
      x-operation-id-source: derived
components:
  schemas:
    ErrorModel:
      type: object
      properties:
        param:
          type:
          - string
          - 'null'
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    NoContentResult:
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
      additionalProperties: false
    IoTEdgeDeploymentList:
      type: object
      properties:
        guid:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        groupName:
          type:
          - string
          - 'null'
        modules:
          type:
          - string
          - 'null'
        routes:
          type:
          - string
          - 'null'
        createdDate:
          type: string
          format: date-time
      additionalProperties: false
    IoTEdgeDeploymentListResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/IoTEdgeDeploymentList'
        status:
          enum:
          - 100
          - 101
          - 102
          - 103
          - 200
          - 201
          - 202
          - 203
          - 204
          - 205
          - 206
          - 207
          - 208
          - 226
          - 300
          - 301
          - 302
          - 303
          - 304
          - 305
          - 306
          - 307
          - 308
          - 400
          - 401
          - 402
          - 403
          - 404
          - 405
          - 406
          - 407
          - 408
          - 409
          - 410
          - 411
          - 412
          - 413
          - 414
          - 415
          - 416
          - 417
          - 421
          - 422
          - 423
          - 424
          - 426
          - 428
          - 429
          - 431
          - 451
          - 500
          - 501
          - 502
          - 503
          - 504
          - 505
          - 506
          - 507
          - 508
          - 510
          - 511
          type: integer
          format: int32
        message:
          type:
          - string
          - 'null'
        count:
          type:
          - integer
          - 'null'
          format: int64
      additionalProperties: false
    IoTEdgeDeploymentCreateResponse:
      type: object
      properties:
        data:
          type:
          - object
          - 'null'
        status:
          enum:
          - 100
          - 101
          - 102
          - 103
          - 200
          - 201
          - 202
          - 203
          - 204
          - 205
          - 206
          - 207
          - 208
          - 226
          - 300
          - 301
          - 302
          - 303
          - 304
          - 305
          - 306
          - 307
          - 308
          - 400
          - 401
          - 402
          - 403
          - 404
          - 405
          - 406
          - 407
          - 408
          - 409
          - 410
          - 411
          - 412
          - 413
          - 414
          - 415
          - 416
          - 417
          - 421
          - 422
          - 423
          - 424
          - 426
          - 428
          - 429
          - 431
          - 451
          - 500
          - 501
          - 502
          - 503
          - 504
          - 505
          - 506
          - 507
          - 508
          - 510
          - 511
          type: integer
          format: int32
        message:
          type:
          - string
          - 'null'
        count:
          type:
          - integer
          - 'null'
          format: int64
      additionalProperties: false
    IoTEdgeModule:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        version:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
        restartPolicy:
          type:
          - string
          - 'null'
        image:
          type:
          - string
          - 'null'
      additionalProperties: false
    IoTEdgeDeploymentCreateRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        deviceGroup:
          type: string
          format: uuid
        userName:
          type:
          - string
          - 'null'
        password:
          type:
          - string
          - 'null'
        address:
          type:
          - string
          - 'null'
        modules:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/IoTEdgeModule'
        routes:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/IoTEdgeRoute'
      additionalProperties: false
    ErrorsResponse:
      type: object
      properties:
        status:
          type: integer
          format: int32
        message:
          type:
          - string
          - 'null'
        error:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorModel'
      additionalProperties: false
    IoTEdgeRoute:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        fromModule:
          type:
          - string
          - 'null'
        toModule:
          type:
          - string
          - 'null'
        fromChannel:
          type:
          - string
          - 'null'
        toChannel:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please enter JWT with Bearer into field
      name: Authorization
      in: header