openapi: 3.2.0
info:
  title: /IOTCONNECT™ Device Deployment API
  description: 'Device REST API contains information of Device modules.


    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: Deployment
  description: Deployment API List
paths:
  /api/v2/deployments:
    get:
      tags:
      - Deployment
      summary: Get Deployment list
      description: This API endpoint provides you the get list of device update deployments.
      responses:
        '412':
          description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
        '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 the deployment list received successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentListResponse'
        '401':
          description: Indicates that authentication is failed because of the token is invalid or expired or missing.
      operationId: getApiV2Deployments
      x-operation-id-source: derived
    post:
      tags:
      - Deployment
      summary: Create scheduled deployment for device update
      description: This API endpoint provides you to create deployment for IotHub Device.
      responses:
        '412':
          description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
        '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 the Deployment created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentCreateResponse'
        '401':
          description: Indicates that authentication is failed because of the token is invalid or expired or missing.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentCreateRequest'
      operationId: postApiV2Deployments
      x-operation-id-source: derived
components:
  schemas:
    ErrorModel:
      type: object
      properties:
        param:
          type:
          - string
          - 'null'
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    DeploymentCreateResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            type: string
        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
    DeploymentCreateRequest:
      type: object
      properties:
        updateInfo:
          $ref: '#/components/schemas/DeviceUpdate'
        adu-group:
          type:
          - string
          - 'null'
        deploymentTime:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
    DeploymentList:
      type: object
      properties:
        deploymentId:
          type:
          - string
          - 'null'
        deploymentType:
          type:
          - string
          - 'null'
        deviceGroupType:
          type:
          - string
          - 'null'
        startDateTime:
          type: string
          format: date-time
        isCompleted:
          type:
          - boolean
          - 'null'
      additionalProperties: false
    DeploymentListResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DeploymentList'
        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
    DeviceUpdate:
      type: object
      properties:
        provider:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        version:
          type:
          - string
          - 'null'
      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
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please enter JWT with Bearer into field
      name: Authorization
      in: header