openapi: 3.2.0
info:
  title: /IOTCONNECT™ Device Azure Sphere 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: AzureSphere
  description: Azure Sphere Api List
paths:
  /api/v2/sphere-devices/products:
    get:
      tags:
      - AzureSphere
      summary: Get Sphere Product List
      description: This API endpoint gives you the list of sphere products.
      parameters:
      - name: pageSize
        in: query
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        schema:
          type: integer
          format: int32
      - name: sortBy
        in: query
        schema:
          type: string
      - name: Name
        in: query
        schema:
          type: string
      - name: Description
        in: query
        schema:
          type: string
      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 product list received successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductListResponse'
        '204':
          description: Indicates that the request has been successfully processed and no records found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoContentResult'
        '401':
          description: Indicates that authentication is failed because of the token is invalid or expired or missing.
        '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.

            invalid logged user or company.'
      operationId: getApiV2SphereDevicesProducts
      x-operation-id-source: derived
    post:
      tags:
      - AzureSphere
      summary: Create sphere product
      description: This API endpoint creates new sphere product.
      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 product created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductCreateResponse'
        '204':
          description: Indicates that the request has been successfully processed and no records found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoContentResult'
        '401':
          description: Indicates that authentication is failed because of the token is invalid or expired or missing.
        '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.

            invalid logged user or company.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductCreateRequest'
        description: Json object with sphere product details.
      operationId: postApiV2SphereDevicesProducts
      x-operation-id-source: derived
  /api/v2/sphere-devices/products/{guid}:
    patch:
      tags:
      - AzureSphere
      summary: Update sphere product
      description: This API endpoint update sphere product.
      parameters:
      - name: guid
        in: path
        description: guid to update sphere product.
        required: true
        schema:
          type: string
          format: uuid
      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 product updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductUpdateResponse'
        '204':
          description: Indicates that the request has been successfully processed and no records found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoContentResult'
        '401':
          description: Indicates that authentication is failed because of the token is invalid or expired or missing.
        '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.

            invalid logged user or company.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductUpdateRequest'
        description: Json object with sphere product details.
      operationId: patchApiV2SphereDevicesProductsByGuid
      x-operation-id-source: derived
    delete:
      tags:
      - AzureSphere
      summary: Delete sphere product
      description: This API endpoint delete sphere product.
      parameters:
      - name: guid
        in: path
        description: productGuid to delete sphere product.
        required: true
        schema:
          type: string
          format: uuid
      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 product deleted successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductDeleteResponse'
        '204':
          description: Indicates that the request has been successfully processed and no records found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoContentResult'
        '401':
          description: Indicates that authentication is failed because of the token is invalid or expired or missing.
        '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.

            invalid logged user or company.'
      operationId: deleteApiV2SphereDevicesProductsByGuid
      x-operation-id-source: derived
    get:
      tags:
      - AzureSphere
      summary: Get Sphere Product Detail
      description: This API endpoint gives you detail of sphere product.
      parameters:
      - name: guid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      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 product detail loaded successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductListResponse'
        '204':
          description: Indicates that the request has been successfully processed and no records found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoContentResult'
        '401':
          description: Indicates that authentication is failed because of the token is invalid or expired or missing.
        '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.

            invalid logged user or company.'
      operationId: getApiV2SphereDevicesProductsByGuid
      x-operation-id-source: derived
  /api/v2/sphere-devices/tenants/{tenantId}/permission:
    get:
      tags:
      - AzureSphere
      summary: Check iotconnect tenant has permission to access azure sphere tenant or not
      description: This API endpoint Check iotconnect tenant has permission to access azure sphere tenant or not.
      parameters:
      - name: tenantId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      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 iotconnect tenant has permission or not to access azure sphere tenant.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantPermissionResponse'
        '204':
          description: Indicates that the request has been successfully processed and no records found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoContentResult'
        '401':
          description: Indicates that authentication is failed because of the token is invalid or expired or missing.
        '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.

            invalid logged user or company.'
      operationId: getApiV2SphereDevicesTenantsByTenantIdPermission
      x-operation-id-source: derived
  /api/v2/sphere-devices/devices/syncDeviceDetail:
    post:
      tags:
      - AzureSphere
      summary: Sync devicegroup and product from Azure sphere tenant
      description: This API endpoint sync devicegroup and product from Azure sphere tenant.
      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 device synced successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncSphereGroupAndProductResponse'
        '204':
          description: Indicates that the request has been successfully processed and no records found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoContentResult'
        '401':
          description: Indicates that authentication is failed because of the token is invalid or expired or missing.
        '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.

            invalid logged user or company.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SyncSphereGroupAndProductRequest'
        description: Json object with device group id.
      operationId: postApiV2SphereDevicesDevicesSyncDeviceDetail
      x-operation-id-source: derived
components:
  schemas:
    TenantPermissionResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            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
    ProductUpdateResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            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
    ProductCreateRequest:
      type: object
      properties:
        createDefaultGroups:
          type: boolean
        name:
          maxLength: 50
          pattern: ^[a-zA-Z0-9_]*$
          type:
          - string
          - 'null'
          description: Name of the sphere product
        description:
          maxLength: 100
          type:
          - string
          - 'null'
          description: Sphere product description
      additionalProperties: false
    ErrorModel:
      type: object
      properties:
        param:
          type:
          - string
          - 'null'
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    SyncSphereGroupAndProductResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            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
    NoContentResult:
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
      additionalProperties: false
    ProductListResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SphereProductList'
        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
    SyncSphereGroupAndProductRequest:
      type: object
      properties:
        deviceGuid:
          type: string
          format: uuid
        deviceId:
          type:
          - string
          - 'null'
      additionalProperties: false
    SphereProductList:
      type: object
      properties:
        guid:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
      additionalProperties: false
    ProductCreateResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            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
    ErrorsResponse:
      type: object
      properties:
        status:
          type: integer
          format: int32
        message:
          type:
          - string
          - 'null'
        error:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorModel'
      additionalProperties: false
    ProductDeleteResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            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
    ProductUpdateRequest:
      type: object
      properties:
        name:
          maxLength: 50
          pattern: ^[a-zA-Z0-9_]*$
          type:
          - string
          - 'null'
          description: Name of the sphere product
        description:
          maxLength: 100
          type:
          - string
          - 'null'
          description: Sphere product description
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please enter JWT with Bearer into field
      name: Authorization
      in: header