openapi: 3.2.0 info: title: Avnet Device API version: '1.0' description: 'Operations tagged Device across 2 of this provider''s published API definitions: avnet-iotconnect-device-aws-prod-swagger.json, avnet-iotconnect-device-azure-prod-swagger.json. Each path carries the servers of the definition it was published in.' security: - Bearer: [] tags: - name: Device description: Device Api List paths: /api/v2.1/Device: post: tags: - Device summary: Add new device description: 'IoT device is a smart device that supports internet connectivity. Through connectivity, established using IoT communication protocols, these devices can interact with other devices. Not only that, it grants remote access to a user for managing the device as per their needs. These devices can be anything from consumer devices, wearables, home appliances, industrial monitoring systems to security systems. Add any quantity and a variety of devices using this API endpoint for easy integration with IoTConnect. The approach requires a device template, defining the features and type of your devices. Features include attributes, settings, properties, rules, commands and so on, by applying them on devices, users can monitor and manage.' 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 is created successfully and returns created device guid. content: application/json: schema: $ref: '#/components/schemas/DeviceCreateResponse' '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.\nThe device template doesn't exist, entity doesn't exist, the device is already exists, invalid tag, \nno attributes found in device template, parent device doesn't exist, parent and child device tags are same \nand invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceCreateRequest' description: Json object with device details. operationId: postApiV21Device x-operation-id-source: derived get: tags: - Device summary: Get Device List description: 'This API endpoint gives you the list of available devices in your company. 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: sortBy in: query description: Sort by name and order, Eg. uniqueId asc, uniqueId desc etc. schema: type: string - name: UniqueId in: query description: The unique id of device schema: type: string - name: Name in: query description: The display name of device schema: type: string - name: TemplateName in: query description: The device template name schema: type: string - name: EntityName in: query description: The entity name schema: type: string - name: Status in: query description: The status of device, Eg. active or inactive schema: type: string - name: Property in: query description: The custom property name of device schema: type: string - name: Value in: query description: The custom property value of device schema: type: string - name: Acquired in: query description: The device acquire status, Eg. acquired, released or inprogress schema: type: string - name: TemplateGuid in: query schema: type: string - name: EntityGuid in: query schema: type: string - name: IncludeRecentValue in: query schema: type: boolean - name: customField in: query description: Include custom fields info, 'true' to include custom poperties of devices and 'false' to exclude schema: type: boolean - name: isEdge in: query description: 'IsEdge : Pass value as true to get only edge devices' schema: type: boolean - name: isGateway in: query description: 'IsGateway : Pass value as true to get only gateway devices' schema: type: boolean - name: isLowBandwidth in: query description: 'IsLowBandwidth : Pass value as true to get only low badnwidth devices' schema: type: boolean - name: greenGrass in: query description: 'GreenGrass : Pass value as true to get only greengrass devices' schema: type: boolean - name: wireless in: query description: 'Wireless : Pass value as true to get only wireless devices' schema: type: boolean - name: certificateGuid in: query description: Certificate Guid to filter devices by certificate 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 device list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceListResponse' '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: getApiV21Device x-operation-id-source: derived /api/v2.1/Device/{deviceGuid}: put: tags: - Device summary: Update a device description: Device details need to be updated anytime. Use this API endpoint to update your device details. Nevertheless, you can only update the display name, properties, notes and entity of a device. To update device details, you need to send deviceGuid in request url. parameters: - name: deviceGuid in: path description: The guid of the device. 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 device is updated successfully. content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' '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. The device doesn''t exist, the device is shared device, the entity doesn''t exist, the child device entity can not update and invalid logged user or company.' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceUpdateRequest' description: Json object with device update details. operationId: putApiV21DeviceByDeviceGuid x-operation-id-source: derived delete: tags: - Device summary: Delete a device description: To delete a device, use this API endpoint. To do that, you need to send a deviceGuid in request url that you want to delete. This will also release your device from Azure IoT Hub, even if the device is acquired. parameters: - name: deviceGuid in: path description: Device Guid 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 device deleted successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceDeleteResponse' '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. the device doesn''t exist, the device is shared device, an error occurred during delete a device from iothub and invalid logged user or company.' operationId: deleteApiV21DeviceByDeviceGuid x-operation-id-source: derived /api/v2.1/Device/{uniqueId}/acquire: put: tags: - Device summary: Acquire device broker info from cloud description: 'In simple words, acquire a device means registering your device on Azure IoT Hub. When you add a device, it adds in IoTConnect only. However, to transmit data from one device to the other, you need to register a device with Azure IoT Hub. To acquire your device, use this API endpoint. To do that, send device uniqueID in request url.' parameters: - name: uniqueId in: path description: The unique id of device required: true 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 device acquired successfully. content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' '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.\nthe device doesn't exist, the device template auth type is TPM, the device is not active, the device is already acquired, the device acquires process already started, \nthe child device cannot be acquired, message or device quota are exceeded, an error occurred during acquire the device on iothub and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceAcquireRequest' description: Json object operationId: putApiV21DeviceByUniqueIdAcquire x-operation-id-source: derived /api/v2.1/Device/{uniqueId}/release: put: tags: - Device summary: Release device from cloud description: This API endpoint is used to release or remove your IoT device from Azure IoT Hub. For that, you need to send device Unique ID in request url. parameters: - name: uniqueId in: path description: The unique id of device required: true schema: type: string - name: isCloudDevice in: query schema: type: boolean 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 released successfully. content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' '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.\nThe device doesn't exist, the device is not active, the device is already released, the device is shared device, \nan error occurred during release the device on iothub and invalid logged user or company." operationId: putApiV21DeviceByUniqueIdRelease x-operation-id-source: derived /api/v2.1/Device/{deviceGuid}/status: put: tags: - Device summary: Update device status description: This API endpoint allows you to change the status of your device. For that, you need to send deviceGuid in request url and isActive in the request body. In isActive, send true to activate your device and false to deactivate your device. When you deactivate your device, this will also release your device from Azure IoT Hub, even if the device is acquired. parameters: - name: deviceGuid in: path description: Device Guid 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 device activated or inactivated successfully. content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' '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 conflicts on the server,\nthe device doesn't exist, the device is already active or inactive, the device is shared device, \nmessage or device quota are exceeded to activate device only and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceUpdateStatusRequest' description: Json object operationId: putApiV21DeviceByDeviceGuidStatus x-operation-id-source: derived /api/v2.1/Device/uniqueId/{uniqueId}: get: tags: - Device summary: Get all the details of single device description: Getting all the details of a device, including firmware update, device availability and when it was last connected, etc., is critical for any user. To get all the details of a device, you need to send the device uniqueId in request url. Moreover, if you wish to fetch child device details, send gateway device uniqueId in parentDeviceUniqueId parameter of a query string. parameters: - name: uniqueId in: path description: Device Unique Id required: true schema: type: string - name: parentDeviceUniqueId in: query description: Gateway Device Unique Id 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 device information received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceInformationResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. the device doesn''t exist and invalid logged user or company.' operationId: getApiV21DeviceUniqueIdByUniqueId x-operation-id-source: derived /api/v2.1/Device/lookup: get: tags: - Device summary: Get device lookup description: 'This API endpoint provides you the lookup of all available devices in your company. 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: deviceTemplateGuid in: query description: To get device lookup by device template, required to pass device template guid. schema: type: string format: uuid - name: tag in: query description: To get device lookup by device tag. schema: type: string - name: iotEdgeEnabled in: query schema: type: boolean - name: getChildDevice in: query description: Required to pass 'true' for getting device lookup along with child devices and 'false' for getting device lookup without child devices. schema: type: boolean - name: excludeEdge in: query description: Required to pass 'false' for getting non-edge device lookup and 'true' for getting edge device lookup. schema: type: boolean - name: deviceEntityGuid in: query description: Entity guid schema: type: string format: uuid - name: hasVideoStream in: query description: Required to pass 'false' for getting non video stream device lookup and 'true' for getting video stream device lookup. schema: type: boolean 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 lookup received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceLookupResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '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: getApiV21DeviceLookup x-operation-id-source: derived /api/v2.1/template/{templateGuid}/device: get: tags: - Device summary: Get device list by templateGuid description: 'This API endpoint helps you to find out how many devices are registered under one device template. To find that out, send device templateGuid in request url. 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: templateGuid in: path description: The device template guid required: true schema: type: string format: uuid - 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: sortBy in: query description: Sort by name and order, Eg. uniqueId, deviceTemplateName, uniqueId asc, displayName desc etc. schema: type: string - name: UniqueId in: query description: The unique id of device schema: type: string - name: Name in: query description: The display name of device schema: type: string - name: TemplateName in: query description: The device template name schema: type: string - name: EntityName in: query description: The entity name schema: type: string - name: Status in: query description: The status of device, Eg. active or inactive schema: type: string - name: Property in: query description: The custom property name of device schema: type: string - name: Value in: query description: The custom property value of device schema: type: string - name: Acquired in: query description: The device acquire status, Eg. acquired, released or inprogress schema: type: string - name: TemplateGuid in: query schema: type: string - name: EntityGuid in: query schema: type: string - name: isEdge in: query description: 'IsEdge : Pass value as true to get only edge devices' schema: type: boolean - name: isGateway in: query description: 'IsGateway : Pass value as true to get only gateway devices' schema: type: boolean - name: isLowBandwidth in: query description: 'IsLowBandwidth : Pass value as true to get only low bandwidth devices' schema: type: boolean - name: greenGrass in: query description: 'GreenGrass : Pass value as true to get only greengrass devices' schema: type: boolean - name: wireless in: query description: 'Wireless : Pass value as true to get only wireless devices' schema: type: boolean 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 list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceListResponse' '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. '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: getApiV21TemplateByTemplateGuidDevice x-operation-id-source: derived /api/v2.1/entity/{entityGuid}/device: get: tags: - Device summary: Get device list by entityGuid description: 'Know how many devices are registered under one entity, using this API endpoint. To know that, send entityGuid in request url. 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: entityGuid in: path description: The entity guid required: true schema: type: string format: uuid - 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: sortBy in: query description: 'Sort by name and order, eg: uniqueId, deviceTemplateName, uniqueId asc, displayName desc etc.' schema: type: string - name: UniqueId in: query description: The unique id of device schema: type: string - name: Name in: query description: The display name of device schema: type: string - name: TemplateName in: query description: The device template name schema: type: string - name: EntityName in: query description: The entity name schema: type: string - name: Status in: query description: The status of device, Eg. active or inactive schema: type: string - name: Property in: query description: The custom property name of device schema: type: string - name: Value in: query description: The custom property value of device schema: type: string - name: Acquired in: query description: The device acquire status, Eg. acquired, released or inprogress schema: type: string - name: TemplateGuid in: query schema: type: string - name: EntityGuid in: query schema: type: string - name: isEdge in: query description: 'IsEdge : Pass value as true to get only edge devices' schema: type: boolean - name: isGateway in: query description: 'IsGateway : Pass value as true to get only gateway devices' schema: type: boolean - name: isLowBandwidth in: query description: 'IsLowBandwidth : Pass value as true to get only low bandwidth devices' schema: type: boolean - name: greenGrass in: query description: 'GreenGrass : Pass value as true to get only greengrass devices' schema: type: boolean - name: wireless in: query description: 'Wireless : Pass value as true to get only wireless devices' schema: type: boolean 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 list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceListResponse' '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. '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: getApiV21EntityByEntityGuidDevice x-operation-id-source: derived put: tags: - Device summary: Update device entity in bulk description: This API endpoint helps you to update an entity of multiple devices in a single call. For that, send the list of deviceGuids in the request body along with new entityGuid in request url. parameters: - name: entityGuid in: path description: Entity Guid 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 devices entity updated successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceEntityUpdateResponse' '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.\n An Entity doesn't exist and invalid logged user or company." requestBody: content: application/json: schema: {} description: Device guid list operationId: putApiV21EntityByEntityGuidDevice x-operation-id-source: derived /api/v2.1/company/{companyGuid}/device: get: tags: - Device summary: Get company wise device list description: 'Recognize how many devices are registered under one company, using this API endpoint. For that, send companyGuid in request url. 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 query string.' parameters: - name: companyGuid in: path description: The company guid required: true schema: type: string format: uuid - 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: sortBy in: query description: Sort by name and order, Eg. uniqueId, uniqueId asc, displayName desc etc. schema: type: string - name: searchText in: query description: To search for specific texts in the list. 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 device list received successfully. content: application/json: schema: $ref: '#/components/schemas/CompanyWiseDeviceListResponse' '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. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. The Company doesn''t exist and invalid logged user or company.' operationId: getApiV21CompanyByCompanyGuidDevice x-operation-id-source: derived /api/v2.1/Device/{deviceGuid}/child-device: get: tags: - Device summary: Get list of child devices description: 'This API endpoint provides you the list of available child devices in a gateway device. For that, you need to send gateway deviceGuid in request url. 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: deviceGuid in: path description: The Gateway device guid required: true schema: type: string format: uuid - 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: sortBy in: query description: Sort by name and order, Eg. uniqueId, uniqueId asc, displayName desc etc. 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 child device list received successfully. content: application/json: schema: $ref: '#/components/schemas/ChildDeviceListResponse' '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. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. Gateway device doesn''t exist and invalid logged user or company.' operationId: getApiV21DeviceByDeviceGuidChildDevice x-operation-id-source: derived /api/v2.1/import-batch: post: tags: - Device summary: Import devices in batch description: This API endpoint helps to create devices in bulk for the given entity guid and template code. For that, upload a JSON file in the file parameter, containing a template code and list of devices that you want to create under a given template code. Along with that, you also need to send entity guid in entityGuid parameter under which you want to create devices. This also allows you to make gateway devices in bulk. To add child devices, you need to put them under your gateway device in a JSON file. 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 batch import process has started successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceBatchImportResponse' '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. Device template doesn''t exist and invalid logged user or company.' requestBody: content: multipart/form-data: schema: type: object properties: entityGuid: type: string format: uuid description: The entity guid TemplateType: type: string description: templateType should be device, edgeDevice, gatewayDevice, edgeGatewayDevice, lowBandwidthDevice or iotEdgeEnableDevice file: type: string description: "The json file as per the file sample provided.Please download sample files form your IoTConnect Account.\n

Notes : File should be valid file, file content should be valid JSON, the device template code (dtCode) is required,\n dtCode should be valid, the device uniqueId is required, not allowed duplicate uniqueId for parent devices,\n uniqueId should be valid, not allowed duplicate child device uniqueId within parent device,\n device tag should be valid, self or CA signed parent device uniqueId length should be less than or equal to 31 characters,\n self or CA signed child device uniqueId length should be less than or equal to 64 characters,\n TPM and Key device (parent/child) uniqueId length should be less than or equal to 128 characters,\n device property key is required if passing properties of the device, not allowed duplicate property key, tag is required for gateway child device

" format: binary DeviceTemplateGuid: type: string format: uuid ImportBatchGuid: type: string format: uuid required: - ImportBatchGuid operationId: postApiV21ImportBatch x-operation-id-source: derived get: tags: - Device summary: Get device batch import list description: This API endpoint provides you the list of all imported device batches. This will give you the current status of all batch import along with the count of device insert success and failure. parameters: - name: deviceGuid in: query description: Device(gateway) guid to get child import list schema: type: string - 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: sortBy in: query description: Sort by name and order. Eg. createdDate desc, createdDate asc, createdDate. schema: type: string - name: isExternalImport in: query description: Set to true to get external import batches schema: type: boolean - name: isValidated in: query description: Set to true to get only validated batches schema: type: boolean - name: ignoreValidate in: query description: Set to true to ignore validation status filter schema: type: boolean 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 batch import list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceImportListResponse' '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: getApiV21ImportBatch x-operation-id-source: derived /api/v2.1/import-validate-batch: post: tags: - Device summary: Validate Import devices in batch description: This API endpoint helps to create devices in bulk for the given entity guid and template code. For that, upload a JSON file in the file parameter, containing a template code and list of devices that you want to create under a given template code. Along with that, you also need to send entity guid in entityGuid parameter under which you want to create devices. This also allows you to make gateway devices in bulk. To add child devices, you need to put them under your gateway device in a JSON file. 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 batch import process has started successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceBatchImportResponse' '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. Device template doesn''t exist and invalid logged user or company.' requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: ImportBatchGuid: type: string format: uuid required: - ImportBatchGuid operationId: postApiV21ImportValidateBatch x-operation-id-source: derived /api/v2.1/Device/batch-bulk-delete/{batchGuid}/devices: get: tags: - Device summary: Get deleted device list based on batchguid description: This API endpoint allows you get all the details of deleted device list based on batchguid.For that, you need to send BatchGuid in request url parameters: - name: batchGuid in: path description: Batch Guid required: true schema: type: string format: uuid - name: isDeleted in: query description: In isActive, send true to get device which are deleted successfully and falseget device which are failed schema: type: boolean 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 information received successfully. content: application/json: schema: $ref: '#/components/schemas/BulkDeleteDeviceListResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. the device doesn''t exist and invalid logged user or company.' operationId: getApiV21DeviceBatchBulkDeleteByBatchGuidDevices x-operation-id-source: derived /api/v2.1/device-delete-historylist: get: tags: - Device summary: Get device delete historylist description: 'This API endpoint gives you the list of bulk delete history devices based on devicetypes. 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: sortBy in: query description: Sort by name and order, Eg. uniqueId asc, uniqueId desc, displayName etc. schema: type: string - name: capability in: query description: 'capability : Pass value of device capability' schema: type: integer format: int32 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 list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceDeleteHistoryListResponse' '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: getApiV21DeviceDeleteHistorylist x-operation-id-source: derived /api/v2.1/import-batch/{importBatchGuid}: get: tags: - Device summary: Get list of all devices from a batch import request description: 'This API endpoint delivers you the list of all devices which had been requested to create via batch import request. For that, you need to send a batch import guid in request url. 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: importBatchGuid in: path description: Import batch guid required: true schema: type: string format: uuid - 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: sortBy in: query description: Sort by name and order. Eg. createdDate desc, createdDate asc, createdDate. schema: type: string - name: searchText in: query description: To search for specific texts in the list. schema: type: string - name: isExportJson in: query description: Export Json flag schema: type: boolean 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 batch import list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceImportListByGuidResponse' '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 import batch doesn''t exist, invalid logged user or company.' operationId: getApiV21ImportBatchByImportBatchGuid x-operation-id-source: derived /api/v2.1/import-batch/child-device: post: tags: - Device summary: Import child devices in batch description: This API endpoint helps you to create child devices in bulk for a gateway device. For that, you need to upload a JSON file in the file parameter, containing the list of child devices that you want to create. Along with the gateway device, send uniqueId in deviceUniqueId parameter for which you want to create these devices. 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 child device batch import completed successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceBatchImportChildResponse' '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. The gateway device doesn''t exist, the device uniqueId already exists and invalid logged user or company.' requestBody: content: multipart/form-data: schema: type: object properties: deviceUniqueId: type: string description: The device unique id of gateway device file: type: string description: "The json file as per the file sample provided.Please download sample files form your IoTConnect Account.\n

Notes : file should be valid file, file content should be valid JSON in file, uniqueId is required, \n device property key is required if passing properties of the device,\n device uniqueId should be valid, not allowed duplicate device uniqueId, device tag is required and device tag should be valid

" format: binary required: - deviceUniqueId - file operationId: postApiV21ImportBatchChildDevice x-operation-id-source: derived /api/v2.1/Device/entity/{entityGuid}/change: put: tags: - Device summary: Update device entity in bulk with file or json description: This API endpoint also allows you to update an entity of multiple devices in a single call. For that, you need to send either the list of device guids OR csv file in the request body along with new entityGuid in request url. parameters: - name: entityGuid in: path description: Entity Guid 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 devices entity updated successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceEntityBulkUpdateResponse' '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.\n An Entity doesn't exist and invalid logged user or company." requestBody: content: multipart/form-data: schema: type: object properties: deviceUniqueIds: type: string description: "Comma separated device unique Ids. Eg. uniqueId1,uniqueId2,uniqueId3 etc. \nThis field is required if deviceFile doesn't have value in request.\nNote : Duplicate device uniqueId not allowed." deviceFile: type: string description: 'Upload devices(uniqueId) in bulk as per the csv sample provided. Please download sample files form your IoTConnect Account. If deviceUniqueIds and this field are having value then this field consider as first priority for further process and will be ignored deviceUniqueIds field. Note : Duplicate device uniqueId not allowed.' format: binary operationId: putApiV21DeviceEntityByEntityGuidChange x-operation-id-source: derived /api/v2.1/Device/device-transfer/{entityGuid}: put: tags: - Device summary: Update device entity in bulk with file or json description: This API endpoint also allows you to update an entity of multiple devices in a single call. For that, you need to send either the list of device guids OR csv file in the request body along with new entityGuid in request url. parameters: - name: entityGuid in: path description: Entity Guid 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 devices entity updated successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceEntityBulkUpdateResponse' '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.\n An Entity doesn't exist and invalid logged user or company." requestBody: content: multipart/form-data: schema: type: object properties: deviceUniqueIds: type: string description: "Comma separated device unique Ids. Eg. uniqueId1,uniqueId2,uniqueId3 etc. \nThis field is required if deviceFile doesn't have value in request.\nNote : Duplicate device uniqueId not allowed." deviceFile: type: string description: 'Upload devices(uniqueId) in bulk as per the csv sample provided. Please download sample files form your IoTConnect Account. If deviceUniqueIds and this field are having value then this field consider as first priority for further process and will be ignored deviceUniqueIds field. Note : Duplicate device uniqueId not allowed.' format: binary operationId: putApiV21DeviceDeviceTransferByEntityGuid x-operation-id-source: derived /api/v2.1/Device/{uniqueId}/twin: put: tags: - Device summary: Update device shadow description: This API endpoint allows you to update the shadow of a device. For that, you need to send localName, desiredValue and templateSettingGuid in request body along with the device uniqueId in request url of which you look to update the shadow. parameters: - name: uniqueId in: path description: Device Unique Id required: true 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 device shadow updated successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceTwinResponse' '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.\n The device doesn't exist, the device is not acquired, the device is shared device, the device template setting doesn't exist, \n the device shadow value doesn't match with device template setting datatype, \n the device shadow value doesn't satisfy with data validation of device template setting, \n an error occurred while updating the device shadow on IOTHub, invalid local name and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceTwinRequest' description: Json object operationId: putApiV21DeviceByUniqueIdTwin x-operation-id-source: derived get: tags: - Device summary: Get device shadow list description: Get a shadow list of any device using this API. For that, you need to send device uniqueId in request url of which you want to get the shadow list. parameters: - name: uniqueId in: path description: Device Unique Id required: true schema: type: string - name: recentlyReported in: query description: Send true to get 10 shadow whose reported values updated recently. schema: type: boolean 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 shadow list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceTwinListResponse' '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.\n The device doesn't exist and invalid logged user or company." operationId: getApiV21DeviceByUniqueIdTwin x-operation-id-source: derived /api/v2.1/Device/{uniqueId}/twinjson: get: tags: - Device summary: Get device shadow json description: Get a shadow json of any device using this API. For that, you need to send device uniqueId in request url of which you want to get the shadow json. parameters: - name: uniqueId in: path description: Device Unique Id required: true 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 device shadow JSON object received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceTwinJsonResponse' '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.\n The device doesn't exist and invalid logged user or company." operationId: getApiV21DeviceByUniqueIdTwinjson x-operation-id-source: derived /api/v2.1/Device/{deviceGuid}/properties: put: tags: - Device summary: Update device properties description: This API endpoint helps you to update device properties. For that, you need to send a list of Properties with their values in the request body and send deviceGuid in request url of which you want to update the properties. parameters: - name: deviceGuid in: path description: Device guid 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 device twin property list updated successfully. content: application/json: schema: $ref: '#/components/schemas/DevicePropertyUpdateResponse' '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.\n The device doesn't exist, property doesn't exist and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DevicePropertyUpdateRequest' description: Json object operationId: putApiV21DeviceByDeviceGuidProperties x-operation-id-source: derived /api/v2.1/Device/{deviceGuid}/property/{deviceInfoGuid}: delete: tags: - Device summary: Delete a device property description: This API endpoint allows you to delete a device property. For that, you need to send a device property guid along with the deviceGuid in request url of which you want to delete a property. parameters: - name: deviceGuid in: path description: Device Guid required: true schema: type: string format: uuid - name: deviceInfoGuid in: path description: Device Info Guid 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 device property deleted successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceInfoDeleteResponse' '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.\n The device doesn't exist, property doesn't exist, the device is shared device and invalid logged user or company." operationId: deleteApiV21DeviceByDeviceGuidPropertyByDeviceInfoGuid x-operation-id-source: derived /api/v2.1/Device/property: get: tags: - Device summary: Get device property list description: This API endpoint allows you to fetch all device properties list. 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 property list is loaded successfully. content: application/json: schema: $ref: '#/components/schemas/PropertyListResponse' '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.\n invalid logged user or company." operationId: getApiV21DeviceProperty x-operation-id-source: derived /api/v2.1/Device/{deviceGuid}/grant: post: tags: - Device summary: Grant device permission description: This API endpoint allows you to grant device permissions to users who do not have the right to view or manage devices. For that, you need to send the user’s email id along with the permissions you want to grant to that user in the request body. And send deviceGuid in request url of which you wish to grant the permissions. parameters: - name: deviceGuid in: path description: Device Guid 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 device permission added successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceGrantEmailsUpdateResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n The device doesn't exist, user doesn't exist and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceGrantEmailsUpdateRequest' description: Json object operationId: postApiV21DeviceByDeviceGuidGrant x-operation-id-source: derived get: tags: - Device summary: Get device permissions list description: This API endpoint allows you to get the list of users with their device permissions. For that, you need to send deviceGuid in request url of which you want the device permissions list. parameters: - name: deviceGuid in: path description: Device Guid required: true schema: type: string format: uuid - 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: sortBy in: query description: Sort By, Eg. name, name asc, name desc etc. schema: type: string - name: searchText in: query description: To search for specific texts in the list. 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 device permission list received successfully. content: application/json: schema: $ref: '#/components/schemas/UserDevicePermissionListResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n invalid logged user or company." operationId: getApiV21DeviceByDeviceGuidGrant x-operation-id-source: derived /api/v2.1/Device/user-device-permission/{userDevicePermissionGuid}: put: tags: - Device summary: Update device permissions description: This API endpoint lets you update user’s device permissions. For that, you need to send userDevicePermissionGuid in request url along with permissions in the request body. userDevicePermissionGuid is a unique id for the combination of users and devices. parameters: - name: userDevicePermissionGuid in: path description: User device permission guid 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 user's device permission updated successfully. content: application/json: schema: $ref: '#/components/schemas/UserDevicePermissionUpdateResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n User's device permission doesn't exist and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/UserDevicePermissionUpdateRequest' operationId: putApiV21DeviceUserDevicePermissionByUserDevicePermissionGuid x-operation-id-source: derived /api/v2.1/Device/user-device-permission/{userDevicePermissionGuid}/revoke: delete: tags: - Device summary: Revoke device permissions description: This API endpoint allows you to revoke all the device permissions for any user. For that, you need to send userDevicePermissionGuid in request url. userDevicePermissionGuid is a unique id for the combination of users and devices. parameters: - name: userDevicePermissionGuid in: path description: User device permission guid 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 user's device permission revoked successfully. content: application/json: schema: $ref: '#/components/schemas/UserDevicePermissionRevokeResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n User's device permission doesn't exist and invalid logged user or company." operationId: deleteApiV21DeviceUserDevicePermissionByUserDevicePermissionGuidRevoke x-operation-id-source: derived /api/v2.1/Device/user/{userGuid}/grant: post: tags: - Device summary: Allotted devices to user description: Allow different users to view or manage devices by allotting their devices using this API. For that, you need to send deviceGuid with device permissions and userGuid in request url to whom you want to allot these devices. parameters: - name: userGuid in: path description: User Guid 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 devices permission added to user successfully. content: application/json: schema: $ref: '#/components/schemas/DevicesGrantUserUpdateResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n User doesn't exist and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DevicesGrantUserUpdateRequest' description: Json object operationId: postApiV21DeviceUserByUserGuidGrant x-operation-id-source: derived /api/v2.1/Device/user: get: tags: - Device summary: Get device allotted list description: This API endpoint lets you get the currently logged in user’s allotted device list. 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: sortBy in: query description: Sort By, Eg. displayName desc, displayName asc, displayName etc. schema: type: string - name: searchText in: query description: To search for specific texts in the list. 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 allotted device list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceAllotedListResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n invalid logged user or company." operationId: getApiV21DeviceUser x-operation-id-source: derived /api/v2.1/Device/user/{userGuid}: get: tags: - Device summary: Get user’s allotted devices description: This API endpoint allows you to get the list of allotted devices to a user. For that, you need to send userGuid in request url of which you want the list of allotted devices. parameters: - name: userGuid in: path description: User Guid required: true schema: type: string format: uuid - 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: sortBy in: query description: Sort By, Eg. displayName desc, displayName asc, displayName etc. schema: type: string - name: searchText in: query description: To search for specific texts in the list. 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 allotted device list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceAllotedListResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n An user doesn't exist and invalid logged user or company." operationId: getApiV21DeviceUserByUserGuid x-operation-id-source: derived /api/v2.1/Device/{deviceGuid}/broker-info: get: tags: - Device summary: Get device broker info description: This API endpoint allows you to get the device broker info, which is registered on Azure IoT Hub. For that, you need to send deviceGuid in request url. Broker info will be available for acquired devices only. parameters: - name: deviceGuid in: path description: Device Guid 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 device broker info received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceBrokerInfoDetailResponse' '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.\n The device doesn't exist and invalid logged user or company." operationId: getApiV21DeviceByDeviceGuidBrokerInfo x-operation-id-source: derived /api/v2.1/Device/{deviceGuid}/last-activity: put: tags: - Device summary: Update last activity date of device description: This API endpoint lets you update the last activity date for any device. For that, you need to send deviceGuid in request url along with the previous activity date in the request body. parameters: - name: deviceGuid in: path description: Device Guid 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 device last activity updated successfully. content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' '204': description: Indicates that device doesn't exist or device is not active or device last activity already updated. 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.\n invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceUpdateLastActivityRequest' description: Json object operationId: putApiV21DeviceByDeviceGuidLastActivity x-operation-id-source: derived /api/v2.1/Device/recent-activity: get: tags: - Device summary: Get recently acquired device list description: Get a recently acquired device list using this API endpoint. You can also add the filters as given in the parameters. These filters allow you to get the list by devices acquired status, connected status, OTA update available status and device active status. Though the filters are optional, to apply them, you need to send these filter parameters in a query string. parameters: - name: isAcquired in: query description: Filter by acquired status schema: type: boolean - name: isConnected in: query description: Filter by connected status schema: type: boolean - name: isOtaupdate in: query description: Filter by otaupdate status schema: type: boolean - name: count in: query description: Number of devices to be displayed schema: type: integer format: int32 - name: isActive in: query description: Filter by active status schema: type: boolean 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 recent activity list received successfully. content: application/json: schema: $ref: '#/components/schemas/RecentActivityResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n invalid logged user or company." operationId: getApiV21DeviceRecentActivity x-operation-id-source: derived /api/v2.1/Device/{uniqueId}/lifecycle: get: tags: - Device summary: Get device life cycle description: 'This API endpoint allows you to get the life cycle of any device. Device life cycle will give you details of all the actions performed on devices, from when the device was created, updated, acquired, released, entity changed to deleted. It also gives you the information about who performed these actions and the time when it was performed. To get the device life cycle, you need to send a device’s unique id in request url. 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: uniqueId in: path description: Device Unique Id required: true schema: type: string - name: pageSize in: query description: 'To define number of records in single page. Eg: 25' schema: type: integer format: int32 - name: pageNumber in: query description: 'To fetch specific page data. Eg: 2' 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: Sort By, Eg. changeDate asc, changeDate desc, changeDate etc. schema: type: string - name: isCloudDevice in: query description: Set to true to get life cycle for cloud template device schema: type: boolean 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 device life cycle list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceLifeCycleResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n invalid logged user or company." operationId: getApiV21DeviceByUniqueIdLifecycle x-operation-id-source: derived /api/v2.1/Device/connection-status: get: tags: - Device summary: Get device connection status description: This API endpoint lets you know that the given device is currently connected with the cloud or not. For that, you need to send deviceGuid or deviceUniqueId as a query string parameter in the request. parameters: - name: deviceGuid in: query description: Device Guid schema: type: string format: uuid - name: uniqueId in: query description: Device Unique Id 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 device connection information received successfully. content: application/json: schema: $ref: '#/components/schemas/ConnectionStatusResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n The device doesn't exist and invalid logged user or company." operationId: getApiV21DeviceConnectionStatus x-operation-id-source: derived /api/v2.1/Device/count: get: tags: - Device summary: Get device count description: Get device count using this API endpoint. You can filter this count by the company and active status. 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: companyguid in: query description: Company Guid schema: type: string format: uuid - name: status in: query description: Device Status, 'active' to get active device count, 'inactive' to get inactive device count and empty or null value returns all device count. 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 device count received successfully. content: application/json: schema: $ref: '#/components/schemas/CountResponse' '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.\n The device status should be active/inactive, not any device found and invalid logged user or company." operationId: getApiV21DeviceCount x-operation-id-source: derived /api/v2.1/Device/counters: get: tags: - Device summary: Get device count statistics description: This API endpoint provides you the variety of statistics of device counts like active count, connected and disconnected count, acquired count, available count and total device count. parameters: - name: companyguid in: query description: Company Guid 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 device counters received successfully. content: application/json: schema: $ref: '#/components/schemas/CountersResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n The device status should be active/inactive, no any device found and invalid logged user or company." operationId: getApiV21DeviceCounters x-operation-id-source: derived /api/v2.1/Device/{uniqueId}/diagnostics/from/{fromDate}/to/{toDate}: get: tags: - Device summary: Get device diagnostics detail description: This API endpoint will give you the diagnostics detail of any device. For that, you need to send device uniqueId, fromDate and toDate in the request path. parameters: - name: uniqueId in: path description: Device Unique Id required: true schema: type: string - name: fromDate in: path description: From Date, Date format should be yyyy-MM-dd required: true schema: type: string - name: toDate in: path description: To Date, Date format should be yyyy-MM-dd required: true schema: type: string - 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: continuationToken in: query description: To get next data from cosmos 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 device diagnostics list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceDiagnosticsResponse' '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.\n invalid logged user or company." operationId: getApiV21DeviceByUniqueIdDiagnosticsFromByFromDateToByToDate x-operation-id-source: derived /api/v2.1/Device/diagnostics: post: tags: - Device summary: Get device diagnostics detail description: This API endpoint will give you the diagnostics detail of any device. For that, you need to send device uniqueId, fromDate and toDate in the request path. 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 device diagnostics list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceDiagnosticsResponse' '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.\n invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceDiagnosticsV2Request' description: request object operationId: postApiV21DeviceDiagnostics x-operation-id-source: derived /api/v2.1/Device/statistic: get: tags: - Device summary: Get device count statistics description: This API endpoint provides you the variety of statistics of device counts like active count, connected and disconnected count, acquired count, available count and total device count. parameters: - name: entity in: query description: entity Guid schema: type: string format: uuid - name: group in: query description: group schema: type: string - name: recursive in: query description: recursive, 'true' to get device along with child entity device and 'false' to get for passing entity device, default value is true. schema: type: boolean 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 device statistic list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceStatisticListResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n The device doesn't exist, direct method execution failed and invalid logged user or company." operationId: getApiV21DeviceStatistic x-operation-id-source: derived /api/v2.1/Device/DeviceDashboardCount: get: tags: - Device summary: Get device dashboard count description: This API endpoint provides you device dashboard count. parameters: - name: widgetType in: query description: type must be certificate, edgegatewaydevice, gatewaydevice, edgedevice, device, withoutedgegatewaydevice, lowbandwidthdevice,unassociateddevice, azuresphere schema: type: string - name: entityGuid in: query description: Entity guid schema: type: string format: uuid - name: isRecursiveEntity in: query description: Pass 'true' to include child entities device count schema: type: boolean 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 device dashboard count received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceStatisticListResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n invalid logged user or company." operationId: getApiV21DeviceDeviceDashboardCount x-operation-id-source: derived /api/v2.1/Device/property/{propertyGuid}/company/{companyGuid}: delete: tags: - Device summary: Delete a device property description: This API endpoint allows you to delete a device custom property. For that, you need to send propertyGuid and companyGuid in request url. parameters: - name: companyGuid in: path description: Company Guid required: true schema: type: string format: uuid - name: propertyGuid in: path description: Property Guid 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 device customField deleted successfully. content: application/json: schema: $ref: '#/components/schemas/PropertyDeleteResponse' '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.\n invalid logged user or company." operationId: deleteApiV21DevicePropertyByPropertyGuidCompanyByCompanyGuid x-operation-id-source: derived /api/v2.1/Device/unassociated: post: tags: - Device summary: Add new device description: 'IoT device is a smart device that supports internet connectivity. Through connectivity, established using IoT communication protocols, these devices can interact with other devices. Not only that, it grants remote access to a user for managing the device as per their needs. These devices can be anything from consumer devices, wearables, home appliances, industrial monitoring systems to security systems. Add any quantity and a variety of devices using this API endpoint for easy integration with IoTConnect. The approach requires a device template, defining the features and type of your devices. Features include attributes, settings, properties, rules, commands and so on, by applying them on devices, users can monitor and manage.' 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 is created successfully and returns created device guid. content: application/json: schema: $ref: '#/components/schemas/UnassociatedDeviceCreateResponse' '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.\nThe device template doesn't exist, entity doesn't exist, the device is already exists, invalid tag, \nno attributes found in device template, parent device doesn't exist, parent and child device tags are same \nand invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/UnassociatedDeviceCreateRequest' description: Json object with device details. operationId: postApiV21DeviceUnassociated x-operation-id-source: derived get: tags: - Device summary: Get Device List description: 'This API endpoint gives you the list of available devices in your company. 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: sortBy in: query description: Sort by name and order, Eg. uniqueId asc, uniqueId desc, displayName asc,displayName desc and createdDate asc,createdDate Desc etc. schema: type: string - name: UniqueId in: query description: The unique id of device schema: type: string - name: EntityName in: query description: The entity name schema: type: string - name: Name in: query description: The entity name schema: type: string - name: Property in: query description: The custom property name of device schema: type: string - name: Value in: query description: The custom property value of device schema: type: string - name: customField in: query description: Include custom fields info, 'true' to include custom poperties of devices and 'false' to exclude schema: type: boolean - name: hasAllottedDevice in: query description: Set to true to include allotted devices in the list schema: type: boolean 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 list received successfully. content: application/json: schema: $ref: '#/components/schemas/UnassociatedDeviceListResponse' '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: getApiV21DeviceUnassociated x-operation-id-source: derived /api/v2.1/Device/unassociated/attach/bulk: put: tags: - 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: OK content: application/json: schema: $ref: '#/components/schemas/UnassociatedAttachBulkResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnassociatedAttachBulkRequest' summary: Replace api device unassociated attach bulk x-summary-source: derived operationId: putApiV21DeviceUnassociatedAttachBulk x-operation-id-source: derived /api/v2.1/Device/unassociated/{deviceGuid}: delete: tags: - Device summary: Delete a unassociated device description: To delete a device, use this API endpoint. To do that, you need to send a deviceGuid in request url that you want to delete. parameters: - name: deviceGuid in: path description: Device Guid 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 device deleted successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceDeleteResponse' '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. operationId: deleteApiV21DeviceUnassociatedByDeviceGuid x-operation-id-source: derived /api/v2.1/Device/audit-log: get: tags: - Device summary: Get invalid device communications description: This API endpoint provides you the list of device communication errors of last 3 days. parameters: - name: date in: query description: 'To fetch specific day data. date is mandatory parameter and should be in valid format of YYYY-MM-DD. Eg: 2020-12-18' schema: type: string - 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 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 invalid device communications list loaded successfully. content: application/json: schema: $ref: '#/components/schemas/InvalidDeviceCommunicationResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n invalid logged user or company." operationId: getApiV21DeviceAuditLog x-operation-id-source: derived /api/v2.1/Device/iothub-connection: get: tags: - Device summary: Refresh device connection parameters: - name: uniqueId in: query description: Device Unique Id 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: OK content: application/json: schema: $ref: '#/components/schemas/DeviceConnectionResponse' operationId: getApiV21DeviceIothubConnection x-operation-id-source: derived /api/v2.1/Device/assume-role: get: tags: - 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: OK content: application/json: schema: $ref: '#/components/schemas/AssumeRoleResponse' summary: Get api device assume role x-summary-source: derived operationId: getApiV21DeviceAssumeRole x-operation-id-source: derived /api/v2.1/Device/importTypes/lookup: get: tags: - Device summary: Get ImportType lookup description: This API endpoint provides you the lookup of all available import types. 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 import type lookup received successfully. content: application/json: schema: $ref: '#/components/schemas/ImportTypeLookupResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. operationId: getApiV21DeviceImportTypesLookup x-operation-id-source: derived /api/v2.1/validate-external-device: post: tags: - Device summary: Validate External devices in batch description: This API endpoint helps to validate external devices in bulk for the given entity guid and template code. For that, upload a JSON file in the file parameter, containing a template code and list of devices that you want to create under a given template code. Along with that, you also need to send entity guid in entityGuid parameter under which you want to create devices. This also allows you to make gateway devices in bulk. To add child devices, you need to put them under your gateway device in a JSON file. 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 external device process validated successfully. content: application/json: schema: $ref: '#/components/schemas/ExternalDeviceValidateResponse' '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. Device template doesn''t exist and invalid logged user or company.' requestBody: content: multipart/form-data: schema: type: object properties: entityGuid: type: string format: uuid description: The entity guid file: type: string description: "The json file as per the file sample provided.Please download sample files form your IoTConnect Account.\n

Notes : File should be valid file, file content should be valid JSON, the device template code (dtCode) is required,\n dtCode should be valid, the device uniqueId is required, not allowed duplicate uniqueId for parent devices,\n uniqueId should be valid, not allowed duplicate child device uniqueId within parent device,\n device tag should be valid, self or CA signed parent device uniqueId length should be less than or equal to 31 characters,\n self or CA signed child device uniqueId length should be less than or equal to 64 characters,\n TPM and Key device (parent/child) uniqueId length should be less than or equal to 128 characters,\n device property key is required if passing properties of the device, not allowed duplicate property key, tag is required for gateway child device

" format: binary CertificateGuid: type: string format: uuid description: The root certificate guid ImportTypeGuid: type: string format: uuid DeviceTemplateGuid: type: string format: uuid CustomDecoderGuid: type: string format: uuid LorawanGatewayGuid: type: string format: uuid LorawanManufacturerGuid: type: string format: uuid NetworkCoverage: type: string NetworkType: type: string ChunkFileGuid: type: string ChunkFileName: type: string operationId: postApiV21ValidateExternalDevice x-operation-id-source: derived /api/v2.1/validate-batch: post: tags: - Device summary: Validate External devices in batch description: This API endpoint helps to validate external devices in bulk for the given entity guid and template code. For that, upload a JSON file in the file parameter, containing a template code and list of devices that you want to create under a given template code. Along with that, you also need to send entity guid in entityGuid parameter under which you want to create devices. This also allows you to make gateway devices in bulk. To add child devices, you need to put them under your gateway device in a JSON file. 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 external device process validated successfully. content: application/json: schema: $ref: '#/components/schemas/ExternalDeviceValidateResponse' '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. Device template doesn''t exist and invalid logged user or company.' requestBody: content: multipart/form-data: schema: type: object properties: entityGuid: type: string format: uuid description: The entity guid file: type: string description: "The json file as per the file sample provided.Please download sample files form your IoTConnect Account.\n

Notes : File should be valid file, file content should be valid JSON, the device template code (dtCode) is required,\n dtCode should be valid, the device uniqueId is required, not allowed duplicate uniqueId for parent devices,\n uniqueId should be valid, not allowed duplicate child device uniqueId within parent device,\n device tag should be valid, self or CA signed parent device uniqueId length should be less than or equal to 31 characters,\n self or CA signed child device uniqueId length should be less than or equal to 64 characters,\n TPM and Key device (parent/child) uniqueId length should be less than or equal to 128 characters,\n device property key is required if passing properties of the device, not allowed duplicate property key, tag is required for gateway child device

" format: binary CertificateGuid: type: string format: uuid description: The root certificate guid ImportTypeGuid: type: string format: uuid DeviceTemplateGuid: type: string format: uuid CustomDecoderGuid: type: string format: uuid LorawanGatewayGuid: type: string format: uuid LorawanManufacturerGuid: type: string format: uuid NetworkCoverage: type: string NetworkType: type: string ChunkFileGuid: type: string ChunkFileName: type: string operationId: postApiV21ValidateBatch x-operation-id-source: derived /api/v2.1/external-device-batch-import-file/{importBatchGuid}: get: tags: - Device summary: Get external device import file content parameters: - name: importBatchGuid in: path description: Import batch guid 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: OK content: application/json: schema: $ref: '#/components/schemas/DeviceConnectionResponse' operationId: getApiV21ExternalDeviceBatchImportFileByImportBatchGuid x-operation-id-source: derived /api/v2.1/external-device-validated/{importBatchGuid}/{isSuccess}: get: tags: - Device summary: Get external device import file content parameters: - name: importBatchGuid in: path description: Import batch guid required: true schema: type: string format: uuid - name: isSuccess in: path description: IsSuccess required: true schema: type: boolean 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: OK content: application/json: schema: $ref: '#/components/schemas/ExternalDeviceValidatedResponse' operationId: getApiV21ExternalDeviceValidatedByImportBatchGuidByIsSuccess x-operation-id-source: derived /api/v2.1/Device/configDetail/{deviceGuid}: get: tags: - Device summary: Get device config details parameters: - name: deviceGuid in: path description: The guid of the device. 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: OK content: application/json: schema: $ref: '#/components/schemas/DeviceConfigResponse' operationId: getApiV21DeviceConfigDetailByDeviceGuid x-operation-id-source: derived /api/v2.1/Device/{uniqueId}/uploadsecondarycertificate: put: tags: - Device summary: Upload secondary Certificate description: 'In simple words, upload secondary certificate means registering your certificate on Azure IoT Hub., it adds in IoTConnect only. To upload secondary your certificate, use this API endpoint. To do that, send device uniqueID in request url.' parameters: - name: uniqueId in: path description: The unique id of device required: true 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 secondary certificate uploaded successfully. content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' '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.\nthe device doesn't exist, the device template auth type is TPM, the device is not active, the device is already acquired, the device acquires process already started, \nthe child device cannot be acquired, message or device quota are exceeded, an error occurred during acquire the device on iothub and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/UploadSecondaryCertificateRequest' description: Json object operationId: putApiV21DeviceByUniqueIdUploadsecondarycertificate x-operation-id-source: derived /api/v2.1/Device/import-batch/{importBatchGuid}: delete: tags: - Device summary: Delete a device import validation description: To delete a device import validation, use this API endpoint. To do that, you need to send a importBatchGuid in request url that you want to delete. parameters: - name: importBatchGuid in: path description: import Batch Guid 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 device deleted successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceImportValidationDeleteResponse' '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. the device doesn''t exist, the device is shared device, an error occurred during delete a device from iothub and invalid logged user or company.' operationId: deleteApiV21DeviceImportBatchByImportBatchGuid x-operation-id-source: derived /api/v2.1/Device/lookupV2: post: tags: - Device summary: Get device lookup description: 'This API endpoint provides you the lookup of all available devices in your company. 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.' 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 lookup received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceLookupResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '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/DeviceLookupV2Request' operationId: postApiV21DeviceLookupV2 x-operation-id-source: derived /api/v2.1/Device/get-latest-command/{deviceGuid}: get: tags: - Device summary: Get device latest command details description: This API endpoint provides you latest command details By deviceGuid in your company. parameters: - name: deviceGuid in: path description: Device Guid required: true schema: type: string format: uuid - name: commandGuid in: query description: Optional Command Guid to filter by specific command schema: type: string format: uuid - name: deviceTemplateGuid in: query description: Optional Device Template Guid to filter by template schema: type: string format: uuid - name: command in: query description: Optional command name to filter 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 device latest command details loaded successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceLatestCommandResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '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: getApiV21DeviceGetLatestCommandByDeviceGuid x-operation-id-source: derived /api/v2.1/Device/decoder: post: tags: - Device summary: Create a custom decoder 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 decoder created successfully. content: application/json: schema: $ref: '#/components/schemas/DecoderCreateResponse' requestBody: content: multipart/form-data: schema: type: object properties: Name: type: string Runtime: type: string TemplateGuid: type: string format: uuid FileData: type: string format: binary WirelessDeviceType: type: integer format: int32 Devices: type: array required: - Name - Runtime - TemplateGuid - WirelessDeviceType operationId: postApiV21DeviceDecoder x-operation-id-source: derived /api/v2.1/Device/decoder/list: get: tags: - Device summary: Get decoder list 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: sortBy in: query description: Sort by name and order 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 decoder list received successfully. content: application/json: schema: $ref: '#/components/schemas/DecoderListResponse' operationId: getApiV21DeviceDecoderList x-operation-id-source: derived /api/v2.1/Device/decoder/{decoderGuid}: delete: tags: - Device summary: Delete a decoder parameters: - name: decoderGuid in: path description: Decoder Guid 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 decoder deleted successfully. content: application/json: schema: $ref: '#/components/schemas/DecoderDeleteResponse' operationId: deleteApiV21DeviceDecoderByDecoderGuid x-operation-id-source: derived put: tags: - Device summary: Update a decoder parameters: - name: decoderGuid in: path description: Decoder Guid 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 decoder updated successfully. content: application/json: schema: $ref: '#/components/schemas/DecoderUpdateResponse' requestBody: content: multipart/form-data: schema: type: object properties: Name: type: string Runtime: type: string TemplateGuid: type: string format: uuid FileData: type: string format: binary Devices: type: array DecoderVersionGuid: type: string format: uuid FileName: type: string required: - Name - TemplateGuid operationId: putApiV21DeviceDecoderByDecoderGuid x-operation-id-source: derived /api/v2.1/Device/decoder/lookup/{templateGuid}: get: tags: - Device summary: Get decoder lookup by template parameters: - name: templateGuid in: path description: Device Template Guid 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 decoder lookup received successfully. content: application/json: schema: $ref: '#/components/schemas/DecoderLookupResponse' operationId: getApiV21DeviceDecoderLookupByTemplateGuid x-operation-id-source: derived /api/v2.1/Device/decoder/{decoderVersionGuid}/script: get: tags: - Device summary: Get decoder script parameters: - name: decoderVersionGuid 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 decoder script received successfully. content: application/json: schema: $ref: '#/components/schemas/DecoderScriptResponse' operationId: getApiV21DeviceDecoderByDecoderVersionGuidScript x-operation-id-source: derived /api/v2.1/Device/decoder/{decoderVersionGuid}: get: tags: - Device summary: Get decoder details parameters: - name: decoderVersionGuid in: path description: Decoder Version Guid 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 decoder details received successfully. content: application/json: schema: $ref: '#/components/schemas/DecoderDetailResponse' operationId: getApiV21DeviceDecoderByDecoderVersionGuid x-operation-id-source: derived /api/v2.1/Device/device-status/{companyGuid}: get: tags: - Device summary: Retrieve device status parameters: - name: companyGuid in: path description: Company Guid required: true schema: type: string format: uuid - name: uniqueId in: query description: Device Unique Id schema: type: string - name: deviceGuid in: query description: Device Guid 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 device status received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceStatusResponse' operationId: getApiV21DeviceDeviceStatusByCompanyGuid x-operation-id-source: derived /api/v2.1/Device/update-certificate: put: tags: - 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: OK content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceCertificateUpdateRequest' summary: Replace api device update certificate x-summary-source: derived operationId: putApiV21DeviceUpdateCertificate x-operation-id-source: derived /api/v2.1/Device/video-stream: put: tags: - Device summary: Manage video stream for 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 video stream operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ManageVideoStreamResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/ManageVideoStreamRequest' description: Json object with video stream details operationId: putApiV21DeviceVideoStream x-operation-id-source: derived /api/v2.1/Device/{deviceGuid}/video-stream: get: tags: - Device summary: Get video stream history for device 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: sortBy in: query description: Sort by name and order schema: type: string - name: deviceGuid in: path description: Device Guid 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 video stream history received successfully. content: application/json: schema: $ref: '#/components/schemas/VideoStreamHistoryResponse' operationId: getApiV21DeviceByDeviceGuidVideoStream x-operation-id-source: derived /api/v2.1/Device/client-streaming-url: get: tags: - Device summary: Get streaming URL for device description: This API endpoint retrieves the streaming URL for a specific device using its unique identifier. parameters: - name: uniqueId in: query description: Device unique identifier schema: type: string - name: isWebRTC in: query description: WebRTC schema: type: boolean 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 streaming URL was retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/GetStreamingUrlResponse' '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. '404': description: Indicates that the device was not found. operationId: getApiV21DeviceClientStreamingUrl x-operation-id-source: derived /api/v2.1/Device/propertyUpdate: post: tags: - Device summary: Add or Update Device Property 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 property updated successfully. content: application/json: schema: $ref: '#/components/schemas/UpdateDevicePropertyResponse' '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. requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDevicePropertyRequest' description: Json object with device property details. operationId: postApiV21DevicePropertyUpdate x-operation-id-source: derived /api/v2.1/Device/{deviceGuid}/component/{deviceComponentGuid}/attributes: get: tags: - Device summary: Get attributes by device endpoint description: This API endpoint allows get attributes by device functionality. parameters: - name: deviceGuid in: path description: Device Guid required: true schema: type: string format: uuid - name: deviceComponentGuid in: path description: Device Component Guid required: true schema: type: string format: uuid - 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 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 GetAttributesByDevice request completed successfully. content: application/json: schema: $ref: '#/components/schemas/GetAttributesByDeviceResponse' '401': description: Authentication failed due to invalid, expired, or missing token. operationId: getApiV21DeviceByDeviceGuidComponentByDeviceComponentGuidAttributes x-operation-id-source: derived /api/v2.1/Device/greengrass/component-attribute: post: tags: - Device summary: Add device component attribute endpoint 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 AddDeviceComponentAttribute request completed successfully. content: application/json: schema: $ref: '#/components/schemas/AddDeviceComponentAttributeResponse' '401': description: Authentication failed due to invalid, expired, or missing token. requestBody: content: application/json: schema: $ref: '#/components/schemas/AddDeviceComponentAttributeRequest' description: The request object operationId: postApiV21DeviceGreengrassComponentAttribute x-operation-id-source: derived /api/v2.1/Device/{deviceGuid}/components: get: tags: - Device summary: Get components by device endpoint description: This API endpoint allows get components by device functionality. parameters: - name: deviceGuid 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 GetCompnentsByDevice request completed successfully. content: application/json: schema: $ref: '#/components/schemas/GetComponentsByDeviceResponse' '401': description: Authentication failed due to invalid, expired, or missing token. operationId: getApiV21DeviceByDeviceGuidComponents x-operation-id-source: derived /api/v2.1/Device/component/{componentGuid}/attributes: get: tags: - Device summary: Get attributes by device and device component endpoint description: This API endpoint allows get attributes by device and device component functionality. parameters: - name: componentGuid 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 GetAttributesByDeviceComponent request completed successfully. content: application/json: schema: $ref: '#/components/schemas/GetAttributesByDeviceComponentResponse' '401': description: Authentication failed due to invalid, expired, or missing token. operationId: getApiV21DeviceComponentByComponentGuidAttributes x-operation-id-source: derived /api/v2.1/Device/create-secondary-certificate: post: tags: - Device summary: Create Secondary Certificate description: This API endpoint allows you to Create Secondary Certificate 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' requestBody: content: application/json: schema: $ref: '#/components/schemas/SecondaryCertificateRequest' operationId: postApiV21DeviceCreateSecondaryCertificate x-operation-id-source: derived /api/v2.1/Device/{templateGuid}/devices: get: tags: - Device summary: Get Devices based on templateGuid description: This API endpoint allows you to Get Devices based on templateGuid. parameters: - name: templateGuid in: path required: true schema: type: string format: uuid - name: pageNumber in: query schema: type: integer format: int32 - name: pageSize in: query schema: type: integer format: int32 - name: sortBy 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: OK content: application/json: schema: $ref: '#/components/schemas/DeviceListResponse' operationId: getApiV21DeviceByTemplateGuidDevices x-operation-id-source: derived /api/v2.1/Device/{decoderGuid}/decoderVersions: get: tags: - Device summary: Get Decoder Versions based on decoderGuid description: This API endpoint allows you to Get Decoder Versions based on decoderGuid. parameters: - name: decoderGuid in: path required: true schema: type: string format: uuid - name: sortBy 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: OK content: application/json: schema: $ref: '#/components/schemas/DecoderVersionListResponse' operationId: getApiV21DeviceByDecoderGuidDecoderVersions x-operation-id-source: derived /api/v2.1/Device/{deviceGuid}/decoderChange: put: tags: - Device parameters: - name: deviceGuid 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: OK content: application/json: schema: $ref: '#/components/schemas/DecoderChangeResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/DecoderChangeRequest' summary: Replace api device by device guid decoder change x-summary-source: derived operationId: putApiV21DeviceByDeviceGuidDecoderChange x-operation-id-source: derived /api/v2/Device: post: tags: - Device summary: Add new device description: 'IoT device is a smart device that supports internet connectivity. Through connectivity, established using IoT communication protocols, these devices can interact with other devices. Not only that, it grants remote access to a user for managing the device as per their needs. These devices can be anything from consumer devices, wearables, home appliances, industrial monitoring systems to security systems. Add any quantity and a variety of devices using this API endpoint for easy integration with IoTConnect. The approach requires a device template, defining the features and type of your devices. Features include attributes, settings, properties, rules, commands and so on, by applying them on devices, users can monitor and manage.' 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 is created successfully and returns created device guid. content: application/json: schema: $ref: '#/components/schemas/DeviceCreateResponse' '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.\nThe device template doesn't exist, entity doesn't exist, the device is already exists, invalid tag, \nno attributes found in device template, parent device doesn't exist, parent and child device tags are same \nand invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceCreateRequest_2' description: Json object with device details. operationId: postApiV2Device x-operation-id-source: derived get: tags: - Device summary: Get Device List description: 'This API endpoint gives you the list of available devices in your company. 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: sortBy in: query description: Sort by name and order, Eg. uniqueId asc, uniqueId desc, displayName etc. schema: type: string - name: UniqueId in: query description: The unique id of device schema: type: string - name: Name in: query description: The display name of device schema: type: string - name: TemplateName in: query description: The device template name schema: type: string - name: AuthType in: query description: 'Authentication Type - 1: Token, 2: CA Signed Certificate, 3: Self Signed Certificate, 4: TPM, 5: Symmetric Key, 6: Bootstrap Certificate, 7: CA-Signed (individual)' schema: type: integer format: int32 - name: EntityName in: query description: The entity name schema: type: string - name: Status in: query description: The status of device, Eg. active or inactive schema: type: string - name: Property in: query description: The custom property name of device schema: type: string - name: Value in: query description: The custom property value of device schema: type: string - name: Acquired in: query description: The device acquire status, Eg. acquired, released or inprogress schema: type: string - name: EntityGuid in: query schema: type: string format: uuid - name: TemplateGuid in: query schema: type: string format: uuid - name: IncludeRecentValue in: query schema: type: boolean - name: customField in: query description: Include custom fields info, 'true' to include custom poperties of devices and 'false' to exclude schema: type: boolean - name: isEdge in: query description: 'IsEdge : Pass value as true to get only edge devices' schema: type: boolean - name: isSphere in: query description: 'IsSphere : Pass value as true to get only sphere devices' schema: type: boolean - name: isGateway in: query description: 'IsGateway : Pass value as true to get only gateway devices' schema: type: boolean - name: isLowBandwidth in: query description: 'IsLowBandwidth : Pass value as true to get only low badnwidth devices' schema: type: boolean - name: isIotEdgeEnable in: query description: 'IsIotEdgeEnable : Pass value as true to get only low badnwidth devices' schema: type: boolean - name: certificateGuid in: query 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 device list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceListResponse' '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: getApiV2Device x-operation-id-source: derived /api/v2/Device/{deviceGuid}: put: tags: - Device summary: Update a device description: Device details need to be updated anytime. Use this API endpoint to update your device details. Nevertheless, you can only update the display name, properties, notes and entity of a device. To update device details, you need to send deviceGuid in request url. parameters: - name: deviceGuid in: path description: The guid of the device. 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 device is updated successfully. content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' '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. The device doesn''t exist, the device is shared device, the entity doesn''t exist, the child device entity can not update and invalid logged user or company.' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceUpdateRequest_2' description: Json object with device update details. operationId: putApiV2DeviceByDeviceGuid x-operation-id-source: derived delete: tags: - Device summary: Delete a device description: To delete a device, use this API endpoint. To do that, you need to send a deviceGuid in request url that you want to delete. This will also release your device from Azure IoT Hub, even if the device is acquired. parameters: - name: deviceGuid in: path description: Device Guid 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 device deleted successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceDeleteResponse' '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. the device doesn''t exist, the device is shared device, an error occurred during delete a device from iothub and invalid logged user or company.' operationId: deleteApiV2DeviceByDeviceGuid x-operation-id-source: derived /api/v2/Device/{uniqueId}/acquire: put: tags: - Device summary: Acquire device broker info from cloud description: 'In simple words, acquire a device means registering your device on Azure IoT Hub. When you add a device, it adds in IoTConnect only. However, to transmit data from one device to the other, you need to register a device with Azure IoT Hub. To acquire your device, use this API endpoint. To do that, send device uniqueID in request url.' parameters: - name: uniqueId in: path description: The unique id of device required: true 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 device acquired successfully. content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' '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.\nthe device doesn't exist, the device template auth type is TPM, the device is not active, the device is already acquired, the device acquires process already started, \nthe child device cannot be acquired, message or device quota are exceeded, an error occurred during acquire the device on iothub and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceAcquireRequest_2' description: Json object operationId: putApiV2DeviceByUniqueIdAcquire x-operation-id-source: derived /api/v2/Device/{uniqueId}/release: put: tags: - Device summary: Release device from cloud description: This API endpoint is used to release or remove your IoT device from Azure IoT Hub. For that, you need to send device Unique ID in request url. parameters: - name: uniqueId in: path description: The unique id of device required: true schema: type: string - name: isCloudDevice in: query schema: type: boolean 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 released successfully. content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' '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.\nThe device doesn't exist, the device is not active, the device is already released, the device is shared device, \nan error occurred during release the device on iothub and invalid logged user or company." operationId: putApiV2DeviceByUniqueIdRelease x-operation-id-source: derived /api/v2/Device/{deviceGuid}/status: put: tags: - Device summary: Update device status description: This API endpoint allows you to change the status of your device. For that, you need to send deviceGuid in request url and isActive in the request body. In isActive, send true to activate your device and false to deactivate your device. When you deactivate your device, this will also release your device from Azure IoT Hub, even if the device is acquired. parameters: - name: deviceGuid in: path description: Device Guid 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 device activated or inactivated successfully. content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' '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 conflicts on the server,\nthe device doesn't exist, the device is already active or inactive, the device is shared device, \nmessage or device quota are exceeded to activate device only and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceUpdateStatusRequest' description: Json object operationId: putApiV2DeviceByDeviceGuidStatus x-operation-id-source: derived /api/v2/Device/uniqueId/{uniqueId}: get: tags: - Device summary: Get all the details of single device description: Getting all the details of a device, including firmware update, device availability and when it was last connected, etc., is critical for any user. To get all the details of a device, you need to send the device uniqueId in request url. Moreover, if you wish to fetch child device details, send gateway device uniqueId in parentDeviceUniqueId parameter of a query string. parameters: - name: uniqueId in: path description: Device Unique Id required: true schema: type: string - name: parentDeviceUniqueId in: query description: Gateway Device Unique Id 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 device information received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceInformationResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. the device doesn''t exist and invalid logged user or company.' operationId: getApiV2DeviceUniqueIdByUniqueId x-operation-id-source: derived /api/v2/Device/lookup: get: tags: - Device summary: Get device lookup description: 'This API endpoint provides you the lookup of all available devices in your company. 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: deviceTemplateGuid in: query description: To get device lookup by device template, required to pass device template guid. schema: type: string format: uuid - name: tag in: query description: To get device lookup by device tag. schema: type: string - name: iotEdgeEnabled in: query schema: type: boolean - name: getChildDevice in: query description: Required to pass 'true' for getting device lookup along with child devices and 'false' for getting device lookup without child devices. schema: type: boolean - name: excludeEdge in: query description: Required to pass 'false' for getting non-edge device lookup and 'true' for getting edge device lookup. schema: type: boolean - name: deviceEntityGuid in: query description: Entity guid 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 device lookup received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceLookupResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '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: getApiV2DeviceLookup x-operation-id-source: derived /api/v2/template/{templateGuid}/device: get: tags: - Device summary: Get device list by templateGuid description: 'This API endpoint helps you to find out how many devices are registered under one device template. To find that out, send device templateGuid in request url. 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: templateGuid in: path description: The device template guid required: true schema: type: string format: uuid - 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: sortBy in: query description: Sort by name and order, Eg. uniqueId, deviceTemplateName, uniqueId asc, displayName desc etc. schema: type: string - name: UniqueId in: query description: The unique id of device schema: type: string - name: Name in: query description: The display name of device schema: type: string - name: TemplateName in: query description: The device template name schema: type: string - name: AuthType in: query description: 'Authentication Type - 1: Token, 2: CA Signed Certificate, 3: Self Signed Certificate, 4: TPM, 5: Symmetric Key, 6: Bootstrap Certificate, 7: CA-Signed (individual)' schema: type: integer format: int32 - name: EntityName in: query description: The entity name schema: type: string - name: Status in: query description: The status of device, Eg. active or inactive schema: type: string - name: Property in: query description: The custom property name of device schema: type: string - name: Value in: query description: The custom property value of device schema: type: string - name: Acquired in: query description: The device acquire status, Eg. acquired, released or inprogress schema: type: string - name: EntityGuid in: query schema: type: string format: uuid - name: TemplateGuid in: query schema: type: string format: uuid - name: isEdge in: query description: 'IsEdge : Pass value as true to get only edge devices' schema: type: boolean - name: isGateway in: query description: 'IsGateway : Pass value as true to get only gateway devices' schema: type: boolean - name: isLowBandwidth in: query description: 'IsLowBandwidth : Pass value as true to get only low badnwidth devices' schema: type: boolean - name: isIotEdgeEnable in: query schema: type: boolean - name: IsSphere in: query description: 'IsSphere : Pass value as true to get only sphere devices' schema: type: boolean 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 list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceListResponse' '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. '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: getApiV2TemplateByTemplateGuidDevice x-operation-id-source: derived /api/v2/entity/{entityGuid}/device: get: tags: - Device summary: Get device list by entityGuid description: 'Know how many devices are registered under one entity, using this API endpoint. To know that, send entityGuid in request url. 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: entityGuid in: path description: The entity guid required: true schema: type: string format: uuid - 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: sortBy in: query description: 'Sort by name and order, eg: uniqueId, deviceTemplateName, uniqueId asc, displayName desc etc.' schema: type: string - name: UniqueId in: query description: The unique id of device schema: type: string - name: Name in: query description: The display name of device schema: type: string - name: TemplateName in: query description: The device template name schema: type: string - name: AuthType in: query description: 'Authentication Type - 1: Token, 2: CA Signed Certificate, 3: Self Signed Certificate, 4: TPM, 5: Symmetric Key, 6: Bootstrap Certificate, 7: CA-Signed (individual)' schema: type: integer format: int32 - name: EntityName in: query description: The entity name schema: type: string - name: Status in: query description: The status of device, Eg. active or inactive schema: type: string - name: Property in: query description: The custom property name of device schema: type: string - name: Value in: query description: The custom property value of device schema: type: string - name: Acquired in: query description: The device acquire status, Eg. acquired, released or inprogress schema: type: string - name: EntityGuid in: query schema: type: string format: uuid - name: TemplateGuid in: query schema: type: string format: uuid - name: isEdge in: query description: 'IsEdge : Pass value as true to get only edge devices' schema: type: boolean - name: isGateway in: query description: 'IsGateway : Pass value as true to get only gateway devices' schema: type: boolean - name: isLowBandwidth in: query description: 'IsLowBandwidth : Pass value as true to get only low badnwidth devices' schema: type: boolean - name: isIotEdgeEnable in: query schema: type: boolean 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 list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceListResponse' '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. '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: getApiV2EntityByEntityGuidDevice x-operation-id-source: derived put: tags: - Device summary: Update device entity in bulk description: This API endpoint helps you to update an entity of multiple devices in a single call. For that, send the list of deviceGuids in the request body along with new entityGuid in request url. parameters: - name: entityGuid in: path description: Entity Guid 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 devices entity updated successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceEntityUpdateResponse' '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.\n An Entity doesn't exist and invalid logged user or company." requestBody: content: application/json: schema: {} description: Device guid list operationId: putApiV2EntityByEntityGuidDevice x-operation-id-source: derived /api/v2/company/{companyGuid}/device: get: tags: - Device summary: Get company wise device list description: 'Recognize how many devices are registered under one company, using this API endpoint. For that, send companyGuid in request url. 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 query string.' parameters: - name: companyGuid in: path description: The company guid required: true schema: type: string format: uuid - 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: sortBy in: query description: Sort by name and order, Eg. uniqueId, uniqueId asc, displayName desc etc. schema: type: string - name: searchText in: query description: To search for specific texts in the list. 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 device list received successfully. content: application/json: schema: $ref: '#/components/schemas/CompanyWiseDeviceListResponse' '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. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. The Company doesn''t exist and invalid logged user or company.' operationId: getApiV2CompanyByCompanyGuidDevice x-operation-id-source: derived /api/v2/Device/{deviceGuid}/child-device: get: tags: - Device summary: Get list of child devices description: 'This API endpoint provides you the list of available child devices in a gateway device. For that, you need to send gateway deviceGuid in request url. 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: deviceGuid in: path description: The Gateway device guid required: true schema: type: string format: uuid - 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: sortBy in: query description: Sort by name and order, Eg. uniqueId, uniqueId asc, displayName desc etc. 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 child device list received successfully. content: application/json: schema: $ref: '#/components/schemas/ChildDeviceListResponse' '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. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. Gateway device doesn''t exist and invalid logged user or company.' operationId: getApiV2DeviceByDeviceGuidChildDevice x-operation-id-source: derived /api/v2/import-batch: post: tags: - Device summary: Import devices in batch description: This API endpoint helps to create devices in bulk for the given entity guid and template code. For that, upload a JSON file in the file parameter, containing a template code and list of devices that you want to create under a given template code. Along with that, you also need to send entity guid in entityGuid parameter under which you want to create devices. This also allows you to make gateway devices in bulk. To add child devices, you need to put them under your gateway device in a JSON file. 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 batch import process has started successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceBatchImportResponse' '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. Device template doesn''t exist and invalid logged user or company.' requestBody: content: multipart/form-data: schema: type: object properties: entityGuid: type: string format: uuid description: The entity guid file: type: string description: "The json file as per the file sample provided.Please download sample files form your IoTConnect Account.\n

Notes : File should be valid file, file content should be valid JSON, the device template code (dtCode) is required,\n dtCode should be valid, the device uniqueId is required, not allowed duplicate uniqueId for parent devices,\n uniqueId should be valid, not allowed duplicate child device uniqueId within parent device,\n device tag should be valid, self or CA signed parent device uniqueId length should be less than or equal to 31 characters,\n self or CA signed child device uniqueId length should be less than or equal to 64 characters,\n TPM and Key device (parent/child) uniqueId length should be less than or equal to 128 characters,\n device property key is required if passing properties of the device, not allowed duplicate property key, tag is required for gateway child device

" format: binary CertificateGuid: type: string format: uuid description: The root certificate guid TemplateGuid: type: string format: uuid required: - entityGuid - file operationId: postApiV2ImportBatch x-operation-id-source: derived get: tags: - Device summary: Get device batch import list description: This API endpoint provides you the list of all imported device batches. This will give you the current status of all batch import along with the count of device insert success and failure. parameters: - name: deviceGuid in: query description: Device(gateway) guid to get child import list schema: type: string - 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: sortBy in: query description: Sort by name and order. Eg. createdDate desc, createdDate asc, createdDate. schema: type: string - name: isEdge in: query schema: type: boolean - name: isSphere in: query schema: type: boolean - name: isGateway in: query schema: type: boolean - name: isLowBandwidth in: query schema: type: boolean - name: isIotEdgeEnable in: query schema: type: boolean - name: isExternalImport in: query description: To fetch data with external import. schema: type: boolean - name: isValidated in: query description: To fetch data with only validated. schema: type: boolean - name: ContinuationToken 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 device batch import list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceImportListResponse_2' '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: getApiV2ImportBatch x-operation-id-source: derived /api/v2/template/{templateGuid}/import-batch-validate: post: tags: - Device summary: Import devices in batch description: This API endpoint helps to create devices in bulk for the given entity guid and template code. For that, upload a JSON file in the file parameter, containing a template code and list of devices that you want to create under a given template code. Along with that, you also need to send entity guid in entityGuid parameter under which you want to create devices. This also allows you to make gateway devices in bulk. To add child devices, you need to put them under your gateway device in a JSON file. parameters: - name: templateGuid in: path description: Guid of Template 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 device batch import process has started successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceBatchImportValidateResponse' '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. Device template doesn''t exist and invalid logged user or company.' requestBody: content: multipart/form-data: schema: type: object properties: entityGuid: type: string format: uuid description: The entity guid file: type: string description: "The json file as per the file sample provided.Please download sample files form your IoTConnect Account.\n

Notes : File should be valid file, file content should be valid JSON, the device template code (dtCode) is required,\n dtCode should be valid, the device uniqueId is required, not allowed duplicate uniqueId for parent devices,\n uniqueId should be valid, not allowed duplicate child device uniqueId within parent device,\n device tag should be valid, self or CA signed parent device uniqueId length should be less than or equal to 31 characters,\n self or CA signed child device uniqueId length should be less than or equal to 64 characters,\n TPM and Key device (parent/child) uniqueId length should be less than or equal to 128 characters,\n device property key is required if passing properties of the device, not allowed duplicate property key, tag is required for gateway child device

" format: binary CertificateGuid: type: string format: uuid description: The root certificate guid ImportTypeGuid: type: string format: uuid required: - entityGuid - file - ImportTypeGuid operationId: postApiV2TemplateByTemplateGuidImportBatchValidate x-operation-id-source: derived /api/v2/import-batch/{importBatchGuid}: get: tags: - Device summary: Get list of all devices from a batch import request description: 'This API endpoint delivers you the list of all devices which had been requested to create via batch import request. For that, you need to send a batch import guid in request url. 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: importBatchGuid in: path description: Import batch guid required: true schema: type: string format: uuid - 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: sortBy in: query description: Sort by name and order. Eg. createdDate desc, createdDate asc, createdDate. schema: type: string - name: searchText in: query description: To search for specific texts in the list. schema: type: string - name: continuationToken in: query description: Continuation token returned from the previous request for fetching the next set of results. 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 device batch import list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceImportListByGuidResponse' '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 import batch doesn''t exist, invalid logged user or company.' operationId: getApiV2ImportBatchByImportBatchGuid x-operation-id-source: derived /api/v2/import-batch/child-device: post: tags: - Device summary: Import child devices in batch description: This API endpoint helps you to create child devices in bulk for a gateway device. For that, you need to upload a JSON file in the file parameter, containing the list of child devices that you want to create. Along with the gateway device, send uniqueId in deviceUniqueId parameter for which you want to create these devices. 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 child device batch import completed successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceBatchImportChildResponse' '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. The gateway device doesn''t exist, the device uniqueId already exists and invalid logged user or company.' requestBody: content: multipart/form-data: schema: type: object properties: deviceUniqueId: type: string description: The device unique id of gateway device file: type: string description: "The json file as per the file sample provided.Please download sample files form your IoTConnect Account.\n

Notes : file should be valid file, file content should be valid JSON in file, uniqueId is required, \n device property key is required if passing properties of the device,\n device uniqueId should be valid, not allowed duplicate device uniqueId, device tag is required and device tag should be valid

" format: binary required: - deviceUniqueId - file operationId: postApiV2ImportBatchChildDevice x-operation-id-source: derived /api/v2/Device/entity/{entityGuid}/change: put: tags: - Device summary: Update device entity in bulk with file or json description: This API endpoint also allows you to update an entity of multiple devices in a single call. For that, you need to send either the list of device guids OR csv file in the request body along with new entityGuid in request url. parameters: - name: entityGuid in: path description: Entity Guid 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 devices entity updated successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceEntityBulkUpdateResponse' '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.\n An Entity doesn't exist and invalid logged user or company." requestBody: content: multipart/form-data: schema: type: object properties: deviceUniqueIds: type: string description: "Comma separated device unique Ids. Eg. uniqueId1,uniqueId2,uniqueId3 etc. \nThis field is required if deviceFile doesn't have value in request.\nNote : Duplicate device uniqueId not allowed." deviceFile: type: string description: 'Upload devices(uniqueId) in bulk as per the csv sample provided. Please download sample files form your IoTConnect Account. If deviceUniqueIds and this field are having value then this field consider as first priority for further process and will be ignored deviceUniqueIds field. Note : Duplicate device uniqueId not allowed.' format: binary operationId: putApiV2DeviceEntityByEntityGuidChange x-operation-id-source: derived /api/v2/Device/device-transfer/{entityGuid}: put: tags: - Device summary: Update device entity in bulk with file or json description: This API endpoint also allows you to update an entity of multiple devices in a single call. For that, you need to send either the list of device guids OR csv file in the request body along with new entityGuid in request url. parameters: - name: entityGuid in: path description: Entity Guid 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 devices entity updated successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceEntityBulkUpdateResponse' '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.\n An Entity doesn't exist and invalid logged user or company." requestBody: content: multipart/form-data: schema: type: object properties: deviceUniqueIds: type: string description: "Comma separated device unique Ids. Eg. uniqueId1,uniqueId2,uniqueId3 etc. \nThis field is required if deviceFile doesn't have value in request.\nNote : Duplicate device uniqueId not allowed." deviceFile: type: string description: 'Upload devices(uniqueId) in bulk as per the csv sample provided. Please download sample files form your IoTConnect Account. If deviceUniqueIds and this field are having value then this field consider as first priority for further process and will be ignored deviceUniqueIds field. Note : Duplicate device uniqueId not allowed.' format: binary operationId: putApiV2DeviceDeviceTransferByEntityGuid x-operation-id-source: derived /api/v2/Device/{uniqueId}/twin: put: tags: - Device summary: Update device twin property description: This API endpoint allows you to update the twin property of a device. For that, you need to send localName, desiredValue and templateSettingGuid in request body along with the device uniqueId in request url of which you look to update the twin property. parameters: - name: uniqueId in: path description: Device Unique Id required: true 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 device twin property updated successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceTwinResponse' '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.\n The device doesn't exist, the device is not acquired, the device is shared device, the device template setting doesn't exist, \n the device twin property value doesn't match with device template setting datatype, \n the device twin property value doesn't satisfy with data validation of device template setting, \n an error occurred while updating the device twin property on IOTHub, invalid local name and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceTwinRequest' description: Json object operationId: putApiV2DeviceByUniqueIdTwin x-operation-id-source: derived get: tags: - Device summary: Get device twin property list description: Get a twin property list of any device using this API. For that, you need to send device uniqueId in request url of which you want to get the twin property list. parameters: - name: uniqueId in: path description: Device Unique Id required: true schema: type: string - name: recentlyReported in: query description: Send true to get 10 twin properties whose reported values updated recently. schema: type: boolean 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 twin property list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceTwinListResponse' '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.\n The device doesn't exist and invalid logged user or company." operationId: getApiV2DeviceByUniqueIdTwin x-operation-id-source: derived /api/v2/Device/{uniqueId}/twinjson: get: tags: - Device summary: Get device twin property json description: Get a twin property json of any device using this API. For that, you need to send device uniqueId in request url of which you want to get the twin property json. parameters: - name: uniqueId in: path description: Device Unique Id required: true 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 device twin JSON object received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceTwinJsonResponse' '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.\n The device doesn't exist and invalid logged user or company." operationId: getApiV2DeviceByUniqueIdTwinjson x-operation-id-source: derived /api/v2/Device/{deviceGuid}/properties: put: tags: - Device summary: Update device properties description: This API endpoint helps you to update device properties. For that, you need to send a list of properties with their values in the request body and send deviceGuid in request url of which you want to update the properties. parameters: - name: deviceGuid in: path description: Device guid 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 device twin property list updated successfully. content: application/json: schema: $ref: '#/components/schemas/DevicePropertyUpdateResponse' '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.\n The device doesn't exist, property doesn't exist and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DevicePropertyUpdateRequest' description: Json object operationId: putApiV2DeviceByDeviceGuidProperties x-operation-id-source: derived /api/v2/Device/{deviceGuid}/property/{deviceInfoGuid}: delete: tags: - Device summary: Delete a device property description: This API endpoint allows you to delete a device property. For that, you need to send a device property guid along with the deviceGuid in request url of which you want to delete a property. parameters: - name: deviceGuid in: path description: Device Guid required: true schema: type: string format: uuid - name: deviceInfoGuid in: path description: Device Info Guid 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 device property deleted successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceInfoDeleteResponse_2' '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.\n The device doesn't exist, property doesn't exist, the device is shared device and invalid logged user or company." operationId: deleteApiV2DeviceByDeviceGuidPropertyByDeviceInfoGuid x-operation-id-source: derived /api/v2/Device/property: get: tags: - Device summary: Get device property list description: This API endpoint allows you to fetch all device properties list. 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 property list is loaded successfully. content: application/json: schema: $ref: '#/components/schemas/PropertyListResponse' '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.\n invalid logged user or company." operationId: getApiV2DeviceProperty x-operation-id-source: derived /api/v2/Device/{deviceGuid}/grant: post: tags: - Device summary: Grant device permission description: This API endpoint allows you to grant device permissions to users who do not have the right to view or manage devices. For that, you need to send the user’s email id along with the permissions you want to grant to that user in the request body. And send deviceGuid in request url of which you wish to grant the permissions. parameters: - name: deviceGuid in: path description: Device Guid 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 device permission added successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceGrantEmailsUpdateResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n The device doesn't exist, user doesn't exist and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceGrantEmailsUpdateRequest_2' description: Json object operationId: postApiV2DeviceByDeviceGuidGrant x-operation-id-source: derived get: tags: - Device summary: Get device permissions list description: This API endpoint allows you to get the list of users with their device permissions. For that, you need to send deviceGuid in request url of which you want the device permissions list. parameters: - name: deviceGuid in: path description: Device Guid required: true schema: type: string format: uuid - 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: sortBy in: query description: Sort By, Eg. name, name asc, name desc etc. schema: type: string - name: searchText in: query description: To search for specific texts in the list. 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 device permission list received successfully. content: application/json: schema: $ref: '#/components/schemas/UserDevicePermissionListResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n invalid logged user or company." operationId: getApiV2DeviceByDeviceGuidGrant x-operation-id-source: derived /api/v2/Device/user-device-permission/{userDevicePermissionGuid}: put: tags: - Device summary: Update device permissions description: This API endpoint lets you update user’s device permissions. For that, you need to send userDevicePermissionGuid in request url along with permissions in the request body. userDevicePermissionGuid is a unique id for the combination of users and devices. parameters: - name: userDevicePermissionGuid in: path description: User device permission guid 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 user's device permission updated successfully. content: application/json: schema: $ref: '#/components/schemas/UserDevicePermissionUpdateResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n User's device permission doesn't exist and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/UserDevicePermissionUpdateRequest_2' operationId: putApiV2DeviceUserDevicePermissionByUserDevicePermissionGuid x-operation-id-source: derived /api/v2/Device/user-device-permission/{userDevicePermissionGuid}/revoke: delete: tags: - Device summary: Revoke device permissions description: This API endpoint allows you to revoke all the device permissions for any user. For that, you need to send userDevicePermissionGuid in request url. userDevicePermissionGuid is a unique id for the combination of users and devices. parameters: - name: userDevicePermissionGuid in: path description: User device permission guid 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 user's device permission revoked successfully. content: application/json: schema: $ref: '#/components/schemas/UserDevicePermissionRevokeResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n User's device permission doesn't exist and invalid logged user or company." operationId: deleteApiV2DeviceUserDevicePermissionByUserDevicePermissionGuidRevoke x-operation-id-source: derived /api/v2/Device/recent-activity: get: tags: - Device summary: Get recently acquired device list description: Get a recently acquired device list using this API endpoint. You can also add the filters as given in the parameters. These filters allow you to get the list by devices acquired status, connected status, OTA update available status and device active status. Though the filters are optional, to apply them, you need to send these filter parameters in a query string. parameters: - name: count in: query description: Number of devices to be displayed schema: type: integer format: int32 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 recent activity list received successfully. content: application/json: schema: $ref: '#/components/schemas/RecentActivityResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n invalid logged user or company." operationId: getApiV2DeviceRecentActivity x-operation-id-source: derived /api/v2/Device/{uniqueId}/lifecycle: get: tags: - Device summary: Get device life cycle description: 'This API endpoint allows you to get the life cycle of any device. Device life cycle will give you details of all the actions performed on devices, from when the device was created, updated, acquired, released, entity changed to deleted. It also gives you the information about who performed these actions and the time when it was performed. To get the device life cycle, you need to send a device’s unique id in request url. 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: uniqueId in: path description: Device Unique Id required: true schema: type: string - name: pageSize in: query description: 'To define number of records in single page. Eg: 25' schema: type: integer format: int32 - name: pageNumber in: query description: 'To fetch specific page data. Eg: 2' 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: Sort By, Eg. changeDate asc, changeDate desc, changeDate etc. schema: type: string - name: isCloudDevice in: query schema: type: boolean - name: deviceGuid in: query description: Device guid. 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 device life cycle list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceLifeCycleResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n invalid logged user or company." operationId: getApiV2DeviceByUniqueIdLifecycle x-operation-id-source: derived /api/v2/Device/connection-status: get: tags: - Device summary: Get device connection status description: This API endpoint lets you know that the given device is currently connected with the cloud or not. For that, you need to send deviceGuid or deviceUniqueId as a query string parameter in the request. parameters: - name: deviceGuid in: query description: Device Guid schema: type: string format: uuid - name: uniqueId in: query description: Device Unique Id 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 device connection information received successfully. content: application/json: schema: $ref: '#/components/schemas/ConnectionStatusResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n The device doesn't exist and invalid logged user or company." operationId: getApiV2DeviceConnectionStatus x-operation-id-source: derived /api/v2/Device/connection-status/bulk: get: tags: - Device summary: Get device connection status for multiple devices description: 'Accepts a JSON array of device uniqueIds in the request body and returns an array of objects where each object maps a uniqueId to its connection status (true/false). Example: [ { "device1": 1 }, { "device2": 0 } ]' parameters: - name: uniqueIds in: query schema: type: array 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: OK content: application/json: schema: $ref: '#/components/schemas/ConnectionStatusBulkResponse' operationId: getApiV2DeviceConnectionStatusBulk x-operation-id-source: derived /api/v2/Device/count: get: tags: - Device summary: Get device count description: Get device count using this API endpoint. You can filter this count by the company and active status. 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: companyguid in: query description: Company Guid schema: type: string format: uuid - name: status in: query description: Device Status, 'active' to get active device count, 'inactive' to get inactive device count and empty or null value returns all device count. 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 device count received successfully. content: application/json: schema: $ref: '#/components/schemas/CountResponse' '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.\n The device status should be active/inactive, not any device found and invalid logged user or company." operationId: getApiV2DeviceCount x-operation-id-source: derived /api/v2/Device/counters: get: tags: - Device summary: Get device count statistics description: This API endpoint provides you the variety of statistics of device counts like active count, connected and disconnected count, acquired count, available count and total device count. parameters: - name: companyguid in: query description: Company Guid 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 device counters received successfully. content: application/json: schema: $ref: '#/components/schemas/CountersResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n The device status should be active/inactive, no any device found and invalid logged user or company." operationId: getApiV2DeviceCounters x-operation-id-source: derived /api/v2/Device/diagnostics: post: tags: - Device summary: Get device diagnostics detail description: This API endpoint will give you the diagnostics detail of any device. For that, you need to send device uniqueId, fromDate and toDate in the request path. 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 device diagnostics list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceDiagnosticsResponse_2' '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.\n invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceDiagnosticsV2Request' description: request object operationId: postApiV2DeviceDiagnostics x-operation-id-source: derived /api/v2/Device/{deviceGuid}/direct-method: post: tags: - Device summary: Execute direct method on device description: This API endpoint lets you execute direct methods on device. parameters: - name: deviceGuid in: path description: Device Guid 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 direct method executed successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceDirectMethodResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n The device doesn't exist, direct method execution failed and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceDirectMethodRequest' operationId: postApiV2DeviceByDeviceGuidDirectMethod x-operation-id-source: derived get: tags: - Device summary: Get list of direct method on device description: This API endpoint lets you get list of executed direct methods on device. parameters: - name: deviceGuid in: path description: Device Guid required: true schema: type: string format: uuid - 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 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 direct method list of device received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceDirectMethodListResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n invalid logged user or company." operationId: getApiV2DeviceByDeviceGuidDirectMethod x-operation-id-source: derived /api/v2/Device/statistic: get: tags: - Device summary: Get device count statistics description: This API endpoint provides you the variety of statistics of device counts like active count, connected and disconnected count, acquired count, available count and total device count. parameters: - name: entity in: query description: entity Guid schema: type: string format: uuid - name: group in: query description: group schema: type: string - name: recursive in: query description: recursive, 'true' to get device along with child entity device and 'false' to get for passing entity device, default value is true. schema: type: boolean 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 device statistic list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceStatisticListResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n The device doesn't exist, direct method execution failed and invalid logged user or company." operationId: getApiV2DeviceStatistic x-operation-id-source: derived /api/v2/Device/DeviceDashboardCount: get: tags: - Device summary: Get device dashboard count description: This API endpoint provides you device dashboard count. parameters: - name: widgetType in: query description: type must be certificate, edgegatewaydevice, gatewaydevice, edgedevice, device, withoutedgegatewaydevice, lowbandwidthdevice,unassociateddevice, azuresphere schema: type: string - name: entityGuid in: query description: Entity guid schema: type: string format: uuid - name: isRecursiveEntity in: query description: Pass 'true' to include child entities device count schema: type: boolean 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 device dashboard count received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceStatisticListResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n invalid logged user or company." operationId: getApiV2DeviceDeviceDashboardCount x-operation-id-source: derived /api/v2/Device/property/{propertyGuid}/company/{companyGuid}: delete: tags: - Device summary: Delete a device property description: This API endpoint allows you to delete a device custom property. For that, you need to send propertyGuid and companyGuid in request url. parameters: - name: companyGuid in: path description: Company Guid required: true schema: type: string format: uuid - name: propertyGuid in: path description: Property Guid 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 device customField deleted successfully. content: application/json: schema: $ref: '#/components/schemas/PropertyDeleteResponse' '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.\n invalid logged user or company." operationId: deleteApiV2DevicePropertyByPropertyGuidCompanyByCompanyGuid x-operation-id-source: derived /api/v2/Device/unassociated: get: tags: - Device summary: Get Device List description: 'This API endpoint gives you the list of available devices in your company. 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: sortBy in: query description: Sort by name and order, Eg. uniqueId asc, uniqueId desc, displayName asc,displayName desc and createdDate asc,createdDate Desc etc. schema: type: string - name: UniqueId in: query description: The unique id of device schema: type: string - name: EntityName in: query description: The entity name schema: type: string - name: Name in: query description: The entity name schema: type: string - name: Property in: query description: The custom property name of device schema: type: string - name: Value in: query description: The custom property value of device schema: type: string - name: customField in: query description: Include custom fields info, 'true' to include custom poperties of devices and 'false' to exclude schema: type: boolean - name: hasAllottedDevice in: query schema: type: boolean 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 list received successfully. content: application/json: schema: $ref: '#/components/schemas/UnassociatedDeviceListResponse' '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: getApiV2DeviceUnassociated x-operation-id-source: derived /api/v2/Device/unassociated/attach/bulk: put: tags: - Device summary: Attach unassociated devices in bulk 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: OK content: application/json: schema: $ref: '#/components/schemas/UnassociatedAttachBulkResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnassociatedAttachBulkRequest_2' operationId: putApiV2DeviceUnassociatedAttachBulk x-operation-id-source: derived /api/v2/Device/unassociated/attach: put: tags: - Device summary: Attach unassociated 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: OK content: application/json: schema: $ref: '#/components/schemas/UnassociatedAttachBulkResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnassociatedAttachRequest' operationId: putApiV2DeviceUnassociatedAttach x-operation-id-source: derived /api/v2/Device/unassociated/{deviceGuid}: delete: tags: - Device summary: Delete a unassociated device description: To delete a device, use this API endpoint. To do that, you need to send a deviceGuid in request url that you want to delete. parameters: - name: deviceGuid in: path description: Device Guid 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 device deleted successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceDeleteResponse' '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. operationId: deleteApiV2DeviceUnassociatedByDeviceGuid x-operation-id-source: derived /api/v2/Device/audit-log: get: tags: - Device summary: Get invalid device communications description: This API endpoint provides you the list of device communication errors of last 3 days. parameters: - name: date in: query description: 'To fetch specific day data. date is mandatory parameter and should be in valid format of YYYY-MM-DD. Eg: 2020-12-18' schema: type: string - 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 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 invalid device communications list loaded successfully. content: application/json: schema: $ref: '#/components/schemas/InvalidDeviceCommunicationResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: "Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\n invalid logged user or company." operationId: getApiV2DeviceAuditLog x-operation-id-source: derived /api/v2/validate-external-device: post: tags: - Device summary: Validate External devices in batch description: This API endpoint helps to validate external devices in bulk for the given entity guid and template code. For that, upload a JSON file in the file parameter, containing a template code and list of devices that you want to create under a given template code. Along with that, you also need to send entity guid in entityGuid parameter under which you want to create devices. This also allows you to make gateway devices in bulk. To add child devices, you need to put them under your gateway device in a JSON file. 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 external device process validated successfully. content: application/json: schema: $ref: '#/components/schemas/ExternalDeviceValidateResponse_2' '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. Device template doesn''t exist and invalid logged user or company.' requestBody: content: multipart/form-data: schema: type: object properties: entityGuid: type: string format: uuid file: type: string description: "The json file as per the file sample provided.Please download sample files form your IoTConnect Account.\n

Notes : File should be valid file, file content should be valid JSON, the device template code (dtCode) is required,\n dtCode should be valid, the device uniqueId is required, not allowed duplicate uniqueId for parent devices,\n uniqueId should be valid, not allowed duplicate child device uniqueId within parent device,\n device tag should be valid, self or CA signed parent device uniqueId length should be less than or equal to 31 characters,\n self or CA signed child device uniqueId length should be less than or equal to 64 characters,\n TPM and Key device (parent/child) uniqueId length should be less than or equal to 128 characters,\n device property key is required if passing properties of the device, not allowed duplicate property key, tag is required for gateway child device

" format: binary CertificateGuid: type: string format: uuid description: The root certificate guid KId: type: integer format: int32 ImportTypeGuid: type: string format: uuid DeviceTemplateGuid: type: string format: uuid required: - entityGuid - file - ImportTypeGuid - DeviceTemplateGuid operationId: postApiV2ValidateExternalDevice x-operation-id-source: derived /api/v2/external-device-batch-import: post: tags: - Device summary: External devices batch import description: This API endpoint helps to batch import external 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 external device batch import successfully. content: application/json: schema: $ref: '#/components/schemas/ExternalDeviceValidateResponse_2' '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. Device template doesn''t exist and invalid logged user or company.' requestBody: content: multipart/form-data: schema: type: object properties: ImportBatchGuid: type: string format: uuid entityGuid: type: string format: uuid file: type: string description: "The json file as per the file sample provided.Please download sample files form your IoTConnect Account.\n

Notes : File should be valid file, file content should be valid JSON, the device template code (dtCode) is required,\n dtCode should be valid, the device uniqueId is required, not allowed duplicate uniqueId for parent devices,\n uniqueId should be valid, not allowed duplicate child device uniqueId within parent device,\n device tag should be valid, self or CA signed parent device uniqueId length should be less than or equal to 31 characters,\n self or CA signed child device uniqueId length should be less than or equal to 64 characters,\n TPM and Key device (parent/child) uniqueId length should be less than or equal to 128 characters,\n device property key is required if passing properties of the device, not allowed duplicate property key, tag is required for gateway child device

" format: binary CertificateGuid: type: string format: uuid description: The root certificate guid KId: type: integer format: int32 ImportTypeGuid: type: string format: uuid DeviceTemplateGuid: type: string format: uuid required: - entityGuid - file - ImportTypeGuid - DeviceTemplateGuid operationId: postApiV2ExternalDeviceBatchImport x-operation-id-source: derived /api/v2/Device/bulk-delete: put: tags: - Device summary: Delete multiple devices description: This API endpoint allows you to delete multiple devices. For that, you need to send DeviceGuid in request url. 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 devices deleted successfully. content: application/json: schema: $ref: '#/components/schemas/MultipleDeviceDeleteResponse' '201': description: Indicates that the devices not found. '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. requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleDeviceDeleteRequest' description: Json object operationId: putApiV2DeviceBulkDelete x-operation-id-source: derived /api/v2/Device/batch-bulk-delete/{batchGuid}/devices: get: tags: - Device summary: Get deleted device list based on batchguid description: This API endpoint allows you get all the details of deleted device list based on batchguid.For that, you need to send BatchGuid in request url parameters: - name: batchGuid in: path description: Batch Guid required: true schema: type: string format: uuid - name: isDeleted in: query description: In isActive, send true to get device which are deleted successfully and falseget device which are failed schema: type: boolean 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 information received successfully. content: application/json: schema: $ref: '#/components/schemas/BulkDeleteDeviceListResponse_2' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server. the device doesn''t exist and invalid logged user or company.' operationId: getApiV2DeviceBatchBulkDeleteByBatchGuidDevices x-operation-id-source: derived /api/v2/device-delete-historylist: get: tags: - Device summary: Get device delete history list description: 'This API endpoint gives you the list of bulk delete history devices based on devicetypes. 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: sortBy in: query description: Sort by name and order, Eg. uniqueId asc, uniqueId desc, displayName etc. schema: type: string - name: isSphere in: query description: 'IsSphere : Pass value as true to get only Sphere devices' schema: type: boolean - name: isIotEdgeEnable in: query description: 'IsIotEdgeEnable : Pass value as true to get only Iot EdgeEnable devices' schema: type: boolean - name: isEdge in: query description: 'IsEdge : Pass value as true to get only Edge devices' schema: type: boolean - name: isGateway in: query description: 'IsGateway : Pass value as true to get only Type2 Support devices' schema: type: boolean - name: isLowBandwidth in: query description: 'IsLowBandwidth : Pass value as true to get only LowBandwidth Support devices' schema: type: boolean 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 list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceDeleteHistoryListResponse' '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: getApiV2DeviceDeleteHistorylist x-operation-id-source: derived /api/v2/device-delete-history-list: get: tags: - Device summary: Get device delete history list description: 'This API endpoint gives you the list of bulk delete history devices based on devicetypes. 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: sortBy in: query description: Sort by name and order, Eg. uniqueId asc, uniqueId desc, displayName etc. schema: type: string - name: isSphere in: query description: 'IsSphere : Pass value as true to get only Sphere devices' schema: type: boolean - name: isIotEdgeEnable in: query description: 'IsIotEdgeEnable : Pass value as true to get only Iot EdgeEnable devices' schema: type: boolean - name: isEdge in: query description: 'IsEdge : Pass value as true to get only Edge devices' schema: type: boolean - name: isGateway in: query description: 'IsGateway : Pass value as true to get only Type2 Support devices' schema: type: boolean - name: isLowBandwidth in: query description: 'IsLowBandwidth : Pass value as true to get only LowBandwidth Support devices' schema: type: boolean 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 list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceDeleteHistoryListResponse' '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: getApiV2DeviceDeleteHistoryList x-operation-id-source: derived /api/v2/external-device-batch-import-file/{importBatchGuid}: get: tags: - Device summary: Get external device import file content parameters: - name: importBatchGuid in: path description: Import batch guid 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: OK content: application/json: schema: $ref: '#/components/schemas/DeviceConnectionResponse' operationId: getApiV2ExternalDeviceBatchImportFileByImportBatchGuid x-operation-id-source: derived /api/v2/Device/importTypes/lookup: get: tags: - Device summary: Get import type lookup description: This API endpoint provides you the lookup of all available import types. 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 import type lookup received successfully. content: application/json: schema: $ref: '#/components/schemas/ImportTypeLookupResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. operationId: getApiV2DeviceImportTypesLookup x-operation-id-source: derived /api/v2/Device/import-type/lookup: get: tags: - Device summary: Get import type lookup description: This API endpoint provides you the lookup of all available import types. 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 import type lookup received successfully. content: application/json: schema: $ref: '#/components/schemas/ImportTypeLookupResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. operationId: getApiV2DeviceImportTypeLookup x-operation-id-source: derived /api/v2/Device/{deviceGuid}/devicetemplate/{deviceTemplateGuid}: put: tags: - Device summary: Update template of device parameters: - name: deviceGuid in: path required: true schema: type: string - name: deviceTemplateGuid in: path required: true 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: OK content: application/json: schema: $ref: '#/components/schemas/DeviceTemplateUpdateResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceTemplateUpdateRequest' operationId: putApiV2DeviceByDeviceGuidDevicetemplateByDeviceTemplateGuid x-operation-id-source: derived /api/v2/external-device-validated/{importBatchGuid}/{isSuccess}: get: tags: - Device summary: Get external device import file content parameters: - name: importBatchGuid in: path description: Import batch guid required: true schema: type: string format: uuid - name: isSuccess in: path description: IsSuccess required: true schema: type: boolean 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: OK content: application/json: schema: $ref: '#/components/schemas/ExternalDeviceValidatedResponse_2' operationId: getApiV2ExternalDeviceValidatedByImportBatchGuidByIsSuccess x-operation-id-source: derived /api/v2/Device/{uniqueId}/uploadsecondarycertificate: put: tags: - Device summary: Upload secondary Certificate description: 'In simple words, upload secondary certificate means registering your certificate on Azure IoT Hub., it adds in IoTConnect only. To upload secondary your certificate, use this API endpoint. To do that, send device uniqueID in request url.' parameters: - name: uniqueId in: path description: The unique id of device required: true 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 secondary certificate uploaded successfully. content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' '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.\nthe device doesn't exist, the device template auth type is TPM, the device is not active, the device is already acquired, the device acquires process already started, \nthe child device cannot be acquired, message or device quota are exceeded, an error occurred during acquire the device on iothub and invalid logged user or company." requestBody: content: application/json: schema: $ref: '#/components/schemas/UploadSecondaryCertificateRequest' description: Json object operationId: putApiV2DeviceByUniqueIdUploadsecondarycertificate x-operation-id-source: derived /api/v2/Device/configDetail/{deviceGuid}: get: tags: - Device summary: Get Device Config Detail parameters: - name: deviceGuid 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: OK content: application/json: schema: $ref: '#/components/schemas/DeviceConfigResponse' operationId: getApiV2DeviceConfigDetailByDeviceGuid x-operation-id-source: derived /api/v2/Device/import-batch/{importBatchGuid}: delete: tags: - Device summary: Delete a device import validation description: To delete a device import validation, use this API endpoint. To do that, you need to send a importBatchGuid in request url that you want to delete. parameters: - name: importBatchGuid in: path description: import Batch Guid 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 device deleted successfully. content: application/json: schema: $ref: '#/components/schemas/DeviceImportDeleteResponse' '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. the device doesn''t exist, the device is shared device, an error occurred during delete a device from iothub and invalid logged user or company.' operationId: deleteApiV2DeviceImportBatchByImportBatchGuid x-operation-id-source: derived components: schemas: DeviceEntityUpdateResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceEntityUpdate' 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 DeviceLookup: type: object properties: guid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' displayName: type: - string - 'null' parentDeviceGuid: type: - string - 'null' readOnly: true isAcquired: type: integer format: int32 isActive: type: boolean isEdgeSupport: type: boolean isParentAcquired: type: - boolean - 'null' deviceTemplateGuid: type: - string - 'null' readOnly: true messageVersion: type: - string - 'null' parentDeviceUniqueId: type: - string - 'null' videoStreamResource: type: - string - 'null' readOnly: true videoStreamType: type: - string - 'null' readOnly: true supportStream: type: boolean readOnly: true autoStartStream: type: boolean readOnly: true additionalProperties: false PropertyList: type: object properties: guid: type: - string - 'null' readOnly: true name: type: - string - 'null' fieldType: type: - string - 'null' options: type: - string - 'null' value: type: - string - 'null' readOnly: true additionalProperties: false ConnectionStatusResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ConnectionStatus' 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 RecentActivityResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/RecentActivity' 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 UserDevicePermissionListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/UserDevicePermissionList' 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 InvalidDeviceCommunicationResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/InvalidDeviceCommunicationList' 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 DeviceDeleteHistoryListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceDeleteHistoryList' 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 DeviceEntityUpdate: type: object properties: deviceGuid: type: - string - 'null' readOnly: true oldEntityGuid: type: - string - 'null' readOnly: true entityGuid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' deviceTemplateGuid: type: - string - 'null' readOnly: true firmwareUpgradeGuid: type: - string - 'null' readOnly: true displayName: type: - string - 'null' isActive: type: boolean isDeleted: type: boolean note: type: - string - 'null' isAcquired: type: integer format: int32 parentDeviceGuid: type: - string - 'null' readOnly: true additionalProperties: false PropertyValue: required: - guid type: object properties: guid: minLength: 1 type: string description: The custom property guid value: maxLength: 500 type: - string - 'null' description: The custom property value companyGuid: type: - string - 'null' format: uuid additionalProperties: false DeviceStatusResponse: type: object properties: data: type: - string - '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 DeviceBrokerInfoDetailResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceBrokerInfoDetail' 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 DeviceTwinRequest: required: - desiredValue - localName - templateSettingGuid type: object properties: localName: minLength: 1 type: string description: The twin property name of device. desiredValue: minLength: 1 type: string description: The twin property value of device. twin property value should be valid as per device template setting datatype. templateSettingGuid: minLength: 1 type: string description: Template Setting Guid additionalProperties: false DeviceProperty: type: object properties: guid: type: - string - 'null' readOnly: true deviceGuid: type: - string - 'null' readOnly: true value: type: - string - 'null' name: type: - string - 'null' propertyGuid: type: - string - 'null' readOnly: true options: type: - string - 'null' fieldType: type: - string - 'null' additionalProperties: false DecoderUpdate: type: object properties: decoderGuid: type: - string - 'null' decoderVersionGuid: type: string format: uuid additionalProperties: false DeviceAllotedListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceAllotedList' 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 ImportTypeLookupResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ImportTypeLookup' 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 UnassociatedDeviceCreate: type: object properties: newid: type: - string - 'null' readOnly: true additionalProperties: false UserDevicePermissionUpdate: type: object additionalProperties: false DeviceInformationResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceInformation' 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 DeviceComponentAttribute: type: object properties: attrCount: type: integer format: int32 additionalProperties: false SecondaryCertificateRequest: type: object properties: uniqueId: type: - string - 'null' description: The unique identifier of the device for which the secondary certificate is requested. additionalProperties: false description: Request class for obtaining a secondary certificate for a device. UnassociatedDeviceCreateRequest: required: - autoStartVideoStream - displayName - entityGuid - uniqueId - videoStreamResource type: object properties: uniqueId: maxLength: 128 minLength: 1 type: string description: "The uniqueId of device.\nNotes: Device uniqueId length is conditional based on device template auth type and device type \n1. Self or CA signed parent device uniqueId length should be less than or equal to 31 characters. \n2. Self or CA signed child device uniqueId length should be less than or equal to 31 characters. \n3. For TPM or key, all device uniqueId length should be less than or equal to 128 characters." properties: type: - array - 'null' items: $ref: '#/components/schemas/PropertyValue' description: The custom properties of device. xmlProperties: type: - object - 'null' readOnly: true displayName: maxLength: 100 minLength: 1 type: string description: The display name of device. note: maxLength: 500 type: - string - 'null' description: The note of the device. entityGuid: minLength: 1 type: string description: The entityGuid of device. videoStreamResource: type: integer description: Video stream resource format: int32 autoStartVideoStream: type: boolean description: Video stream resource additionalProperties: false UserDevicePermissionRevokeResponse: 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 DeviceLifeCycle: type: object properties: status: type: - string - 'null' changeDate: type: - string - 'null' format: date-time changeBy: type: - string - 'null' readOnly: true messageText: type: - string - 'null' additionalProperties: false BulkDeleteDeviceListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceListByBroker' 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 DeviceImportListByGuidResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceImportListByGuid' 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 DeviceEntityBulkUpdateResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceEntityBulkUpdateResult' 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 VideoStreamHistoryList: type: object properties: startDate: type: - string - 'null' format: date-time endDate: type: - string - 'null' format: date-time uniqueId: type: - string - 'null' action: type: - string - 'null' additionalProperties: false CountersResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceCounters' 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 AWSDeviceDiagnosticsData: type: object properties: deviceId: type: - string - 'null' eventType: type: - string - 'null' ipAddress: type: - string - 'null' type: type: - string - 'null' eventDesc: type: - string - 'null' continuationToken: type: - string - 'null' timeStamp: type: integer format: int64 time: type: string format: date-time readOnly: true statusCode: type: integer format: int32 readOnly: true level: type: - string - 'null' readOnly: true additionalProperties: false DeviceLookupV2Request: type: object properties: deviceTemplateGuid: type: - string - 'null' format: uuid getChildDevice: type: boolean excludeEdge: type: boolean ioTEdgeEnabled: type: - boolean - 'null' Tag: type: - string - 'null' deviceEntityGuid: type: - string - 'null' format: uuid devices: type: - array - 'null' items: type: string isGreengrass: type: boolean pageNumber: type: integer format: int32 pageSize: type: integer format: int32 searchText: type: - string - 'null' sortBy: type: - string - 'null' additionalProperties: false ManageVideoStreamRequest: type: object properties: uniqueId: type: - string - 'null' action: type: - string - 'null' isWebRTC: type: boolean default: false additionalProperties: false DecoderList: type: object properties: guid: type: string format: uuid name: type: - string - 'null' status: type: - string - 'null' statusText: type: - string - 'null' runTime: type: - string - 'null' isActive: type: boolean createdBy: type: string format: uuid createdByUser: type: - string - 'null' createdDate: type: string format: date-time deviceCount: type: integer format: int32 templateName: type: - string - 'null' transmission: type: integer format: int32 latestVersion: type: - string - 'null' versionCount: type: integer format: int32 additionalProperties: false DeviceLifeCycleResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceLifeCycle' 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 DevicesGrantUserUpdateResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DevicesGrantUserUpdateResult' 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 DeviceEntityBulkUpdate: type: object properties: errorText: type: - string - 'null' deviceGuid: type: - string - 'null' readOnly: true oldEntityGuid: type: - string - 'null' readOnly: true entityGuid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' deviceTemplateGuid: type: - string - 'null' readOnly: true firmwareUpgradeGuid: type: - string - 'null' readOnly: true displayName: type: - string - 'null' isActive: type: - boolean - 'null' isDeleted: type: - boolean - 'null' note: type: - string - 'null' isAcquired: type: integer format: int32 parentDeviceGuid: type: - string - 'null' readOnly: true additionalProperties: false DeviceLatestCommandDetail: type: object properties: guid: type: string format: uuid uniqueId: type: - string - 'null' status: type: - string - 'null' statusText: type: - string - 'null' StatusDate: type: - string - 'null' format: date-time additionalProperties: false UpdateDevicePropertyRequest: type: object properties: deviceGuid: type: string format: uuid propertyName: type: - string - 'null' propertyValue: type: - string - 'null' additionalProperties: false DeviceTwinResponse: 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 ImportTypeLookup: type: object properties: deviceImportTypeGuid: type: string format: uuid deviceImportTypeName: type: - string - 'null' additionalProperties: false UnassociatedDeviceCreateResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/UnassociatedDeviceCreate' 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 DeviceEntityBulkUpdateResult: type: object properties: error: type: - array - 'null' items: $ref: '#/components/schemas/DeviceEntityBulkUpdate' success: type: - array - 'null' items: $ref: '#/components/schemas/DeviceEntityBulkUpdate' additionalProperties: false DeviceBrokerInfoDetail: type: object properties: hostName: type: - string - 'null' deviceID: type: - string - 'null' connectionString: type: - string - 'null' primaryKey: type: - string - 'null' secondaryKey: type: - string - 'null' dpsReferenceId: type: - string - 'null' additionalProperties: false DeviceBatchImportResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ImportBatchStatus' 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 CreateDevice: type: object properties: newid: type: - string - 'null' readOnly: true entityGuid: type: - string - 'null' readOnly: true ParentUniqueId: type: - string - 'null' uniqueId: type: - string - 'null' ggDeviceScript: type: - string - 'null' activeDeviceCount: type: integer format: int32 inActiveDeviceCount: type: integer format: int32 ggDeviceType: type: integer format: int32 fileSupport: type: boolean additionalProperties: false UnassociatedAttachBulk: type: object properties: guid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' deviceTemplateGuid: type: - string - 'null' readOnly: true authType: type: integer format: int32 certificateThumbPrint: type: - string - 'null' tag: type: - string - 'null' parentDeviceGuid: type: - string - 'null' readOnly: true cpId: type: - string - 'null' isEdgeSupport: type: boolean entityGuid: type: - string - 'null' readOnly: true firmwareupgradeguid: type: - string - 'null' readOnly: true displayName: type: - string - 'null' isActive: type: boolean isDeleted: type: boolean note: type: - string - 'null' isAcquired: type: boolean additionalProperties: false ExternalDeviceValidatedResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/BatchFileErrorResult' 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 InvalidDeviceCommunicationList: type: object properties: uniqueId: type: - string - 'null' date: type: string format: date-time type: type: - string - 'null' readOnly: true error: type: - string - 'null' errorDetail: type: - string - 'null' data: type: - string - 'null' additionalProperties: false DeviceUpdateStatusRequest: required: - isActive type: object properties: isActive: type: boolean description: Device Active Status, 'true' for making device active and 'false' for making device inactive additionalProperties: false DeviceImportValidationDeleteResponse: 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 DeviceGrantEmailsUpdateResult: type: object properties: success: type: - array - 'null' items: $ref: '#/components/schemas/DeviceGrantEmailsUpdate' error: type: - array - 'null' items: $ref: '#/components/schemas/DeviceGrantEmailsUpdate' additionalProperties: false DeviceTwinJsonResponse: 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 DecoderChangeResponse: 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 DeviceTwinListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceTwinList' 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 DeviceImportListByGuid: type: object properties: guid: type: - string - 'null' readOnly: true jsonData: type: - object - 'null' isValid: type: - boolean - 'null' deviceGuid: type: - string - 'null' readOnly: true deviceTemplateGuid: type: - string - 'null' readOnly: true dtCode: type: - string - 'null' firmwareGuid: type: - string - 'null' readOnly: true deviceTemplateName: type: - string - 'null' importLog: type: - string - 'null' parentDeviceGuid: type: - string - 'null' readOnly: true parentDeviceUniqueId: type: - string - 'null' uniqueId: type: - string - 'null' entityGuid: type: string format: uuid authType: type: integer format: int32 version: type: - string - 'null' parentAuthType: type: integer format: int32 additionalProperties: false ResponseMetadata: type: object properties: RequestId: type: - string - 'null' additionalProperties: false UserDevicePermissionList: type: object properties: name: type: - string - 'null' email: type: - string - 'null' userGuid: type: - string - 'null' readOnly: true reportingGroupGuid: type: - string - 'null' readOnly: true userDevicePermissionGuid: type: - string - 'null' readOnly: true permission: type: - object - 'null' additionalProperties: type: boolean additionalProperties: false UserDevicePermissionUpdateResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/UserDevicePermissionUpdate' 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 GetAttributesByDeviceComponent: type: object properties: guid: type: string format: uuid localname: type: - string - 'null' additionalProperties: false DeviceCounters: type: object properties: active: type: integer format: int32 inActive: type: integer format: int32 connected: type: integer format: int32 disConnected: type: integer format: int32 acquired: type: integer format: int32 available: type: integer format: int32 total: type: integer format: int32 released: type: integer format: int32 unAssociatedDevice: type: integer format: int32 readOnly: true cloudDevice: type: integer format: int32 readOnly: true additionalProperties: false PropertyListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/PropertyList' 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 DeviceGrantEmailsUpdateResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceGrantEmailsUpdateResult' 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 Credentials: type: object properties: AccessKeyId: type: - string - 'null' SecretAccessKey: type: - string - 'null' SessionToken: type: - string - 'null' Expiration: type: string format: date-time additionalProperties: false ChildDeviceListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ChildDeviceList' 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 AddDeviceComponentAttributeRequest: type: object properties: deviceGuid: type: - string - 'null' deviceComponentGuid: type: - string - 'null' attributeGuids: type: - array - 'null' items: type: string additionalProperties: false DecoderListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DecoderList' 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 IceServerDetails: type: object properties: uris: type: - array - 'null' items: type: string username: type: - string - 'null' password: type: - string - 'null' ttl: type: integer format: int32 additionalProperties: false DeviceUpdateRequest: required: - autoStartVideoStream - displayName - entityGuid - videoStreamResource type: object properties: displayName: maxLength: 100 minLength: 1 type: string description: The display name of device. note: maxLength: 500 type: - string - 'null' description: The note of the device. entityGuid: minLength: 1 type: string description: The entityGuid of device. properties: type: - array - 'null' items: $ref: '#/components/schemas/PropertyValue' description: The custom properties of device. xmlProperties: type: - object - 'null' readOnly: true videoStreamResource: type: integer description: Video stream resource format: int32 autoStartVideoStream: type: boolean description: Video stream resource additionalProperties: false GetAttributesByDeviceComponentResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/GetAttributesByDeviceComponent' 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 AddDeviceComponentAttributeResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceComponentAttribute' 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 UnassociatedAttachBulkRequest: required: - certificateGuid - deviceGuids - deviceTemplateGuid - entityGuid - isCpIdOptional type: object properties: entityGuid: minLength: 1 type: string description: Entity Guid deviceTemplateGuid: minLength: 1 type: string description: Group Guid deviceGuids: type: array items: type: string description: Device Guid List certificateGuid: type: string format: uuid isCpIdOptional: type: boolean 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 AssumedRoleUser: type: object properties: AssumedRoleId: type: - string - 'null' Arn: type: - string - 'null' additionalProperties: false DeviceDelete: type: object properties: guid: type: - string - 'null' readOnly: true status: type: boolean entityGuid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' parentDeviceGuid: type: - string - 'null' readOnly: true eventPlaceHolders: type: - string - 'null' activeDeviceCount: type: integer format: int32 inActiveDeviceCount: type: integer format: int32 additionalProperties: false DeviceConfigDetail: type: object properties: ver: type: - string - 'null' pf: type: - string - 'null' cpid: type: - string - 'null' env: type: - string - 'null' uid: type: - string - 'null' did: type: - string - 'null' at: type: integer format: int32 disc: type: - string - 'null' additionalProperties: false DeviceDiagnosticsV2Request: type: object properties: uniqueId: type: - string - 'null' fromDate: type: - string - 'null' toDate: type: - string - 'null' continuationToken: type: - string - 'null' pageNumber: type: integer format: int32 pageSize: type: integer format: int32 searchText: type: - string - 'null' sortBy: type: - string - 'null' additionalProperties: false DeviceInfoDeleteResponse: type: object properties: data: $ref: '#/components/schemas/DeviceDeletePropertyInfo' 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 SidewalkDeviceCreateRequest: type: object properties: customDecoderGuid: type: - string - 'null' additionalProperties: false GetComponentsByDeviceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/GetCompnentsByDevice' 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 DeviceCreateRequest: required: - deviceTemplateGuid - displayName - entityGuid - uniqueId type: object properties: uniqueId: maxLength: 200 minLength: 1 type: string description: "The uniqueId of device.\nNotes: Device uniqueId length is conditional based on device template auth type and device type \n1. Self or CA signed parent device uniqueId length should be less than or equal to 31 characters. \n2. Self or CA signed child device uniqueId length should be less than or equal to 31 characters. \n3. For TPM or key, all device uniqueId length should be less than or equal to 128 characters." firmwareUpgradeGuid: type: - string - 'null' description: The firmwareUpgradeGuid of device. deviceTemplateGuid: minLength: 1 type: string description: The deviceTemplateGuid of device. tag: type: - string - 'null' description: The tag of the device which must be exists in device template. This field is required if the request for child device create and gateway support enabled in device template. parentDeviceGuid: type: - string - 'null' description: The gateway device guid. This field is required if the request for child device create and gateway support enabled in device template. properties: type: - array - 'null' items: $ref: '#/components/schemas/PropertyValue' description: The custom properties of device. xmlProperties: type: - object - 'null' readOnly: true deviceCertificateGuid: type: - string - 'null' description: The certificateGuid of devicetemplate. deviceCertificate: type: - string - 'null' description: Byte array of device certificate file(Only .pfx file allowed). format: byte deviceCertificatePassword: type: - string - 'null' description: Password of device certificate certificateText: type: - string - 'null' isAutoGeneratedSelfSignCertificate: type: boolean wirelessDeviceType: type: integer format: int32 ggDeviceType: type: integer format: int32 sidewalkDevice: $ref: '#/components/schemas/SidewalkDeviceCreateRequest' videoStreamResource: type: - integer - 'null' format: int32 videoStreamType: type: - integer - 'null' format: int32 autoStartVideoStream: type: boolean templateCode: type: string channelARN: type: string displayName: maxLength: 100 minLength: 1 type: string description: The display name of device. note: maxLength: 500 type: - string - 'null' description: The note of the device. entityGuid: minLength: 1 type: string description: The entityGuid of device. additionalProperties: false DeviceCertificateUpdateRequest: type: object properties: uniqueId: type: - string - 'null' cert: type: - string - 'null' description: Byte array of device certificate file(Only .pfx file allowed). format: byte certPassword: type: - string - 'null' description: Password of device certificate caCertGuid: type: - string - 'null' description: root CA Individual certificate guid. additionalProperties: false DeviceConnectionStatus: type: object properties: isConnected: type: boolean additionalProperties: false DeviceList: type: object properties: guid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' displayName: type: - string - 'null' isConnected: type: boolean lastactivityDate: type: - string - 'null' format: date-time isActive: type: boolean firmwareupgradeGuid: type: - string - 'null' readOnly: true deviceTemplateGuid: type: - string - 'null' readOnly: true authType: type: integer format: int32 authTypeName: type: - string - 'null' messageVersion: type: - string - 'null' isSolutionTemplate: type: boolean solutionName: type: - string - 'null' deviceInfo: type: - object - 'null' deviceTemplateName: type: - string - 'null' reportingTo: type: - string - 'null' entityName: type: - string - 'null' IsAcquired: type: boolean readOnly: true childDeviceCount: type: integer format: int32 isType2Support: type: boolean isAllottedDevice: type: integer format: int32 readOnly: true allottedDevicePermission: type: - integer - 'null' format: int32 count: type: integer format: int32 properties: type: - array - 'null' items: $ref: '#/components/schemas/DeviceProperty' deviceStatus: type: - string - 'null' recentAttrValue: type: - object - 'null' lastConnection: type: - string - 'null' format: date-time lastCommunication: type: - string - 'null' format: date-time solutionGuid: type: - string - 'null' readOnly: true groupName: type: - string - 'null' productName: type: - string - 'null' parentCompanyGuid: type: - string - 'null' format: uuid certLocation: type: integer format: int32 Wireless: type: boolean wirelessDeviceType: type: integer format: int32 publicDevice: type: boolean certAvailable: type: boolean ggDeviceType: type: integer format: int32 cloudTemplateGuid: type: - string - 'null' readOnly: true createdBy: type: - string - 'null' createdDate: type: string format: date-time attrEnable: type: boolean deviceCapability: type: - integer - 'null' format: int32 info: type: - array - 'null' items: $ref: '#/components/schemas/OutputparamListResponse' additionalProperties: false DeviceGrantEmailsUpdate: type: object properties: userId: type: - string - 'null' userGuid: type: - string - 'null' readOnly: true errorLog: type: - string - 'null' additionalProperties: false BatchFileErrorResult: type: object properties: deviceId: type: - string - 'null' uniqueId: type: - string - 'null' errorMsg: type: - string - 'null' errorStatus: type: - string - 'null' additionalProperties: false UploadSecondaryCertificateRequest: type: object properties: deviceCertificate: type: - string - 'null' description: Byte array of device certificate file(Only .pfx file allowed). format: byte deviceCertificatePassword: type: - string - 'null' description: Password of device certificate rootCAIndividualCertificateGuid: type: - string - 'null' description: root CA Individual certificate guid. additionalProperties: false UnassociatedDeviceList: type: object properties: guid: type: - string - 'null' readOnly: true deviceGuid: type: - string - 'null' format: uuid uniqueId: type: - string - 'null' displayName: type: - string - 'null' deviceTemplateGuid: type: - string - 'null' readOnly: true entityName: type: - string - 'null' createdBy: type: - string - 'null' createdDate: type: - string - 'null' format: date-time deviceStatus: type: - string - 'null' solutionGuid: type: - string - 'null' format: uuid isTpDevice: type: boolean additionalProperties: false DeviceDeleteResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceDelete' 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 DeviceTwinList: type: object properties: guid: type: - string - 'null' readOnly: true companyGuid: type: - string - 'null' readOnly: true templateSettingGuid: type: - string - 'null' readOnly: true deviceGuid: type: - string - 'null' readOnly: true createdDate: type: - string - 'null' format: date-time sdkDate: type: - string - 'null' format: date-time gatewayDate: type: - string - 'null' format: date-time deviceDate: type: - string - 'null' format: date-time desiredValue: type: - string - 'null' reportedValue: type: - string - 'null' desiredUpdatedDate: type: - string - 'null' format: date-time reportedUpdatedDate: type: - string - 'null' format: date-time desiredVersion: type: - string - 'null' name: type: - string - 'null' localName: type: - string - 'null' dataTypeName: type: - string - 'null' cpId: type: - string - 'null' uniqueId: type: - string - 'null' daTypeGuid: type: - string - 'null' readOnly: true isFault: type: boolean entityGuid: type: - string - 'null' format: uuid isReadOnly: type: boolean additionalProperties: false GetStreamingUrlData: type: object properties: streamingUrl: type: - string - 'null' uniqueId: type: - string - 'null' webRtcChannelDetailsResponse: $ref: '#/components/schemas/WebRtcChannelDetailsResponse' additionalProperties: false DevicePropertyUpdateResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DevicePropertyUpdate' 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 VideoStreamHistoryResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/VideoStreamHistoryList' 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 DeviceStatisticListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceStatistic' 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 SuccessResponse: type: object properties: message: type: - string - 'null' status: type: integer format: int32 data: type: - array - 'null' items: type: - object - 'null' additionalProperties: false ChildDeviceList: type: object properties: guid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' displayName: type: - string - 'null' tag: type: - string - 'null' isConnected: type: boolean lastactivityDate: type: - string - 'null' format: date-time isActive: type: boolean firmwareupgradeGuid: type: - string - 'null' readOnly: true deviceTemplateGuid: type: - string - 'null' readOnly: true deviceTemplateName: type: - string - 'null' reportingTo: type: - string - 'null' entityName: type: - string - 'null' isAcquired: type: boolean lastCommunication: type: - string - 'null' format: date-time additionalProperties: false DecoderChangeRequest: type: object properties: customDecoderGuid: type: - string - 'null' additionalProperties: false DeviceAcquireRequest: type: object properties: deviceCertificate: type: - string - 'null' description: Byte array of device certificate file(Only .pfx file allowed). format: byte deviceCertificatePassword: type: - string - 'null' description: Password of device certificate caCertificateId: type: - string - 'null' description: root certificate guid. certLocation: type: integer format: int32 isCloudDevice: type: boolean additionalProperties: false DevicePropertyUpdate: type: object properties: value: type: - string - 'null' uniqueId: type: - string - 'null' additionalProperties: false GetAttributesByDeviceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/GetAttributesByDevice' 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 DeviceStatistic: type: object properties: entity: type: - string - 'null' readOnly: true counters: $ref: '#/components/schemas/DeviceCounters' additionalProperties: false CompanyWiseDeviceList: type: object properties: guid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' displayName: type: - string - 'null' isConnected: type: boolean isAcquired: type: boolean lastactivityDate: type: - string - 'null' format: date-time isActive: type: boolean deviceStatus: type: - string - 'null' authType: type: - integer - 'null' format: int32 firmwareupgradeGuid: type: - string - 'null' readOnly: true deviceTemplateGuid: type: - string - 'null' readOnly: true deviceInfo: type: - object - 'null' readOnly: true deviceTemplateName: type: - string - 'null' reportingTo: type: - string - 'null' entityGuid: type: - string - 'null' readOnly: true entityName: type: - string - 'null' childDeviceCount: type: integer format: int32 isType2Support: type: boolean createdByName: type: - string - 'null' createdDate: type: - string - 'null' format: date-time cpid: type: - string - 'null' companyGuid: type: - string - 'null' readOnly: true lastConnection: type: - string - 'null' format: date-time lastCommunication: type: - string - 'null' format: date-time deviceCertExpiryDate: type: - string - 'null' format: date-time additionalProperties: false DeviceCreateResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/CreateDevice' 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 ImportBatchStatus: type: object properties: importBatchGuid: type: - string - 'null' readOnly: true status: type: - string - 'null' additionalProperties: false DecoderUpdateResponse: type: object properties: data: $ref: '#/components/schemas/DecoderUpdate' 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 DecoderDetailResponse: type: object properties: data: $ref: '#/components/schemas/DecoderVersionDetail' 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 GetCompnentsByDevice: type: object properties: guid: type: string format: uuid deviceGuid: type: string format: uuid uniqueId: type: - string - 'null' deploymentName: type: - string - 'null' componentName: type: - string - 'null' latestVersion: type: - string - 'null' createdDate: type: string format: date-time attrCount: type: integer format: int32 additionalProperties: false UserDevicePermissionUpdateRequest: required: - permission type: object properties: permission: type: object additionalProperties: type: object description: 'Permission list, Represents a dictionary of pemission(true/false) accessed by permission name. Note : Here, ''view'' and ''operation'' are available permission and at least one permission is required Eg. {"view" : true, "operation" : false}' additionalProperties: false GetStreamingUrlResponse: type: object properties: data: $ref: '#/components/schemas/GetStreamingUrlData' 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 DeviceLookupResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceLookup' 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 DecoderVersionDetail: type: object properties: guid: type: string format: uuid customDecoderGuid: type: - string - 'null' format: uuid status: type: - string - 'null' statusText: type: - string - 'null' deviceJson: type: - string - 'null' decoderVersion: type: - string - 'null' isActive: type: boolean createdDate: type: string format: date-time createdBy: type: - string - 'null' format: uuid updatedDate: type: - string - 'null' format: date-time updatedBy: type: - string - 'null' format: uuid fileName: type: - string - 'null' name: type: - string - 'null' runTime: type: - string - 'null' wirelessDeviceType: type: - integer - 'null' format: int32 createdByUser: type: - string - 'null' createdByName: type: - string - 'null' deviceTemplateGuid: type: string format: uuid latestVersion: type: boolean additionalProperties: false DeviceUpdateLastActivityRequest: required: - lastActivityDate type: object properties: lastActivityDate: minLength: 1 type: string description: Last activity date time, Date format must be YYYY-MM-DD hh:mm:ss additionalProperties: false CountResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceCounts' 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 DeviceDiagnosticsResponse: type: object properties: pageToken: type: - string - 'null' data: type: - array - 'null' items: $ref: '#/components/schemas/AWSDeviceDiagnosticsData' 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 DecoderDetail: type: object properties: guid: type: string format: uuid name: type: - string - 'null' status: type: - string - 'null' statusText: type: - string - 'null' runTime: type: - string - 'null' isActive: type: boolean createdBy: type: string format: uuid createdByUser: type: - string - 'null' createdDate: type: string format: date-time deviceCount: type: integer format: int32 fileGuid: type: string format: uuid deviceTemplateGuid: type: string format: uuid wirelessDeviceType: type: integer format: int32 decoderVersion: type: - string - 'null' customDecoderLatestVersion: type: - string - 'null' additionalProperties: false DeviceLatestCommandResponse: type: object properties: data: $ref: '#/components/schemas/DeviceLatestCommandDetail' 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 AwsCredentials: type: object properties: accessKeyId: type: - string - 'null' secretAccessKey: type: - string - 'null' sessionToken: type: - string - 'null' expiration: type: string format: date-time additionalProperties: false AssumeRole: type: object properties: ResponseMetadata: $ref: '#/components/schemas/ResponseMetadata' Credentials: $ref: '#/components/schemas/Credentials' AssumedRoleUser: $ref: '#/components/schemas/AssumedRoleUser' additionalProperties: false DeviceCounts: type: object properties: deviceCount: type: integer format: int32 additionalProperties: false PropertyDeleteResponse: 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 UnassociatedAttachBulkResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/UnassociatedAttachBulk' 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 DecoderCreateResponse: type: object properties: data: $ref: '#/components/schemas/DecoderCreate' 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 GetAttributesByDevice: type: object properties: guid: type: string format: uuid localname: type: - string - 'null' datatypeguid: type: string format: uuid datatypename: type: - string - 'null' tag: type: - string - 'null' sequence: type: integer format: int32 parentTemplateAttributeGuid: type: string format: uuid aggregateType: type: integer format: int32 aggregateTypeCount: type: integer format: int32 deviceComponentUsed: type: boolean childAttributes: type: - string - 'null' startIndex: type: integer format: int32 numChar: type: integer format: int32 colorCode: type: - string - 'null' conditionBitValue: type: integer format: int32 additionalProperties: false DeviceInformation: type: object properties: guid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' displayName: type: - string - 'null' isConnected: type: boolean lastActivityDate: type: - string - 'null' format: date-time isActive: type: boolean firmwareUpgradeGuid: type: - string - 'null' readOnly: true deviceTemplateGuid: type: - string - 'null' readOnly: true entityGuid: type: - string - 'null' readOnly: true certificateGuid: type: - string - 'null' readOnly: true certificateName: type: - string - 'null' certificateType: type: - integer - 'null' format: int32 deviceTemplateAuthType: type: integer format: int32 entityName: type: - string - 'null' deviceTemplateName: type: - string - 'null' note: type: - string - 'null' image: type: - string - 'null' cpId: type: - string - 'null' isAcquired: type: integer format: int32 firmwareAvail: type: integer format: int32 parentDeviceGuid: type: - string - 'null' readOnly: true tag: type: - string - 'null' parentDeviceUniqueId: type: - string - 'null' isParentAcquired: type: integer format: int32 isSimulatorOn: type: integer format: int32 isType2Support: type: boolean isEdgeSupport: type: boolean isAllottedDevice: type: integer format: int32 allottedDevicePermission: type: - object - 'null' additionalProperties: type: boolean imageUrl: type: - string - 'null' readOnly: true properties: type: - object - 'null' deviceStatus: type: - string - 'null' isLowBandwidth: type: boolean isSolutionTemplate: type: boolean fileSupport: type: boolean msgCode: type: - string - 'null' readOnly: true messageVersion: type: - string - 'null' authTypeName: type: - string - 'null' authType: type: integer format: int32 hasTwin: type: boolean parentCompanyGuid: type: - string - 'null' format: uuid companyGuid: type: - string - 'null' readOnly: true lastConnection: type: - string - 'null' format: date-time cUrl: type: - string - 'null' ckUrl: type: - string - 'null' certLocation: type: integer format: int32 wireless: type: boolean wirelessDeviceType: type: integer format: int32 wirelessId: type: - string - 'null' parentAuthType: type: - integer - 'null' format: int32 parentAuthTypeName: type: - string - 'null' commandFormat: enum: - 1 - 2 type: integer format: int32 rawTelemetry: type: boolean readOnly: true ggDeviceType: type: integer format: int32 lorawanDeviceProfileGuid: type: - string - 'null' format: uuid lorawanProfileName: type: - string - 'null' isExistLorawanProfile: type: boolean cloudTemplateGuid: type: - string - 'null' readOnly: true clientId: type: - string - 'null' c2dOnDemand: type: integer format: int32 createdBy: type: - string - 'null' createdDate: type: string format: date-time videoStreamResource: type: - string - 'null' readOnly: true videoStreamType: type: - string - 'null' readOnly: true supportStream: type: boolean readOnly: true autoStartStream: type: boolean readOnly: true availableSecondaryCert: type: boolean clientStreamingName: type: - string - 'null' networkType: type: - string - 'null' gatewayName: type: - string - 'null' networkCoverage: type: - string - 'null' decoderName: type: - string - 'null' appKey: type: - string - 'null' regionalParameterVersion: type: - string - 'null' macVersion: type: - string - 'null' appEui: type: - string - 'null' rfRegion: type: - string - 'null' capability: type: - integer - 'null' format: int32 additionalProperties: false UpdateDevicePropertyResponse: 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 DeviceConfigResponse: type: object properties: data: $ref: '#/components/schemas/DeviceConfigDetail' 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 DeviceConnectionResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceConnectionStatus' 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 CompanyWiseDeviceListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/CompanyWiseDeviceList' 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 ExternalDeviceValidateResponse: 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 DeviceDeleteHistoryList: type: object properties: fileName: type: - string - 'null' batchGuid: type: - string - 'null' format: uuid status: type: - string - 'null' entityName: type: - string - 'null' success: type: integer format: int32 failed: type: integer format: int32 deletedDate: type: string format: date-time deletedBy: type: - string - 'null' totalDevice: type: integer format: int32 additionalProperties: false ErrorModel: type: object properties: param: type: - string - 'null' message: type: - string - 'null' additionalProperties: false DeviceDeletePropertyInfo: type: object properties: deviceInfo: type: - object - 'null' readOnly: true additionalProperties: false DecoderLookupResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DecoderDetail' 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 DevicePropertyUpdateRequest: required: - properties type: object properties: properties: type: array items: $ref: '#/components/schemas/PropertyValue' xmlProperties: type: - object - 'null' readOnly: true additionalProperties: false DeviceGrantEmailsUpdateRequest: required: - emails - permission type: object properties: emails: type: array items: type: string description: An email address list, not allowed duplicate email addresses. permission: type: object additionalProperties: type: object description: 'Permission list, Represents a dictionary of pemission(true/false) accessed by permission name. Note : Here, ''view'' and ''operation'' are available permission and at least one permission is required Eg. {"view" : true, "operation" : false}' additionalProperties: false ManageVideoStreamResponse: 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 DeviceImportList: type: object properties: guid: type: - string - 'null' readOnly: true fileName: type: - string - 'null' status: type: - string - 'null' createdDate: type: - string - 'null' format: date-time updatedDate: type: - string - 'null' format: date-time success: type: integer format: int32 error: type: integer format: int32 createdBy: type: - string - 'null' readOnly: true updatedBy: type: - string - 'null' readOnly: true entityGuid: type: - string - 'null' readOnly: true deviceTemplateGuid: type: - string - 'null' readOnly: true entityName: type: - string - 'null' updatebyName: type: - string - 'null' deviceTemplateName: type: - string - 'null' deviceImportTypeName: type: - string - 'null' bsuccess: type: integer format: int32 bfailed: type: integer format: int32 fileUrl: type: - string - 'null' readOnly: true certificateGuid: type: - string - 'null' format: uuid batchImportDate: type: - string - 'null' format: date-time isValidBatch: type: boolean templateProperty: type: - string - 'null' statusText: type: - string - 'null' additionalProperties: false DevicesGrantUserUpdateResult: type: object properties: success: type: - array - 'null' items: $ref: '#/components/schemas/DevicesGrantUserUpdate' error: type: - array - 'null' items: $ref: '#/components/schemas/DevicesGrantUserUpdate' additionalProperties: false DeviceBatchImportChildResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ImportBatchStatus' 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 RecentActivity: type: object properties: uniqueId: type: - string - 'null' deviceName: type: - string - 'null' entityName: type: - string - 'null' createdDate: type: string format: date-time type2Support: type: boolean edgeSupport: type: boolean lowbandWidth: type: boolean iotEdgeEnable: type: boolean greenGrass: type: - boolean - 'null' wireless: type: - boolean - 'null' additionalProperties: false OutputparamListResponse: type: object properties: fName: type: - string - 'null' dName: type: - string - 'null' value: type: - object - 'null' additionalProperties: false DeviceAllotedList: type: object properties: guid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' displayName: type: - string - 'null' isConnected: type: boolean lastactivityDate: type: - string - 'null' format: date-time isActive: type: boolean firmwareupgradeGuid: type: - string - 'null' readOnly: true deviceTemplateGuid: type: - string - 'null' readOnly: true authType: type: integer format: int32 deviceInfo: type: - string - 'null' deviceTemplateName: type: - string - 'null' reportingTo: type: - string - 'null' isAcquired: type: boolean childDeviceCount: type: integer format: int32 isType2Support: type: boolean userDevicePermissionGuid: type: - string - 'null' readOnly: true permission: type: - object - 'null' additionalProperties: type: boolean additionalProperties: false DecoderCreate: type: object properties: newId: type: - string - 'null' customDecoderVersionGuid: type: string format: uuid additionalProperties: false DecoderVersionListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DecoderVersionDetail' 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 AssumeRoleResponse: type: object properties: data: $ref: '#/components/schemas/AssumeRole' 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 DeviceListByBroker: type: object properties: uniquerId: type: - string - 'null' tag: type: - string - 'null' parentUniqueId: type: - string - 'null' isAcquired: type: boolean guid: type: - string - 'null' readOnly: true companyGuid: type: - string - 'null' readOnly: true deviceGuid: type: - string - 'null' readOnly: true cpId: type: - string - 'null' isActive: type: boolean certificateGuid: type: - string - 'null' readOnly: true deviceTemplateGuid: type: - string - 'null' readOnly: true authType: type: integer format: int32 iotEdgeEnable: type: boolean primayThumbPrint: type: - string - 'null' eventPlaceHolders: type: - string - 'null' brokerGuid: type: - string - 'null' readOnly: true selfSignPrimayThumbPrint: type: - string - 'null' selfSignSecondaryThumbprint: type: - string - 'null' deviceStatus: type: - string - 'null' parentDeviceGuid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' displayName: type: - string - 'null' firmwareUpgradeGuid: type: - string - 'null' readOnly: true entityGuid: type: - string - 'null' readOnly: true brokerInfo: type: - string - 'null' note: type: - string - 'null' solutionGuid: type: string format: uuid messageVersion: type: - string - 'null' certLocation: type: integer format: int32 ssCertificateType: type: integer format: int32 greenGrass: type: - boolean - 'null' wireless: type: - boolean - 'null' supportVideoStream: type: - string - 'null' additionalProperties: false WebRtcChannelDetailsResponse: type: object properties: channelARN: type: - string - 'null' wssEndpoint: type: - string - 'null' httpsEndpoint: type: - string - 'null' viewerCredentials: $ref: '#/components/schemas/AwsCredentials' iceServers: type: - array - 'null' items: $ref: '#/components/schemas/IceServerDetails' additionalProperties: false UnassociatedDeviceListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/UnassociatedDeviceList' 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 DecoderScriptResponse: 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 ConnectionStatus: type: object properties: isConnected: type: integer format: int32 readOnly: true additionalProperties: false DeviceListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceList' 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 DevicesGrantUserUpdate: type: object properties: userGuid: type: - string - 'null' readOnly: true deviceGuid: type: - string - 'null' readOnly: true errorLog: type: - string - 'null' additionalProperties: false DevicesGrantUserUpdateRequest: required: - deviceGuids - permission type: object properties: deviceGuids: type: array items: type: string description: List of device guid permission: type: object additionalProperties: type: object description: 'Permission list, Represents a dictionary of pemission(true/false) accessed by permission name. Note : Here, ''view'' and ''operation'' are available permission and at least one permission is required Eg. {"view" : true, "operation" : false}' additionalProperties: false DecoderDeleteResponse: 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 DeviceImportListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceImportList' 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 DeviceLookup_2: type: object properties: guid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' displayName: type: - string - 'null' parentDeviceGuid: type: - string - 'null' readOnly: true isAcquired: type: integer format: int32 isActive: type: boolean isEdgeSupport: type: boolean isParentAcquired: type: - boolean - 'null' deviceTemplateGuid: type: - string - 'null' readOnly: true messageVersion: type: - string - 'null' additionalProperties: false DeviceDirectMethodListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceDirectMethodList' 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 UnassociatedAttachRequest: required: - deviceGuid - deviceTemplateGuid - entityGuid - solutionGuidValue type: object properties: entityGuid: minLength: 1 type: string description: Entity Guid deviceTemplateGuid: minLength: 1 type: string description: Template Guid deviceGuid: minLength: 1 type: string primaryThumbprint: type: - string - 'null' secondaryThumbprint: type: - string - 'null' deviceCertificateGuid: type: - string - 'null' description: The certificateGuid of devicetemplate. endorsementKey: maxLength: 2000 type: - string - 'null' description: The endorsementKey of TPM device. This field is required if device template authentication type is TPM. solutionGuidValue: minLength: 1 type: string additionalProperties: false PropertyValue_2: required: - guid type: object properties: guid: minLength: 1 type: string description: The custom property guid value: maxLength: 500 type: - string - 'null' description: The custom property value additionalProperties: false ConnectionBulkStatus: type: object properties: deviceConnectionStatus: type: - array - 'null' items: $ref: '#/components/schemas/DeviceConnectionStatuses' additionalProperties: false MultipleDeviceDeleteRequest: type: object properties: deviceGuids: type: - array - 'null' items: type: string additionalProperties: false BulkDeleteDeviceListResponse_2: 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 CreateDevice_2: type: object properties: newid: type: - string - 'null' readOnly: true entityGuid: type: - string - 'null' readOnly: true parentUniqueId: type: - string - 'null' uniqueId: type: - string - 'null' additionalProperties: false UnassociatedAttachBulk_2: type: object properties: guid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' deviceTemplateGuid: type: - string - 'null' readOnly: true authType: type: integer format: int32 certificateThumbPrint: type: - string - 'null' tag: type: - string - 'null' parentDeviceGuid: type: - string - 'null' readOnly: true cpId: type: - string - 'null' isEdgeSupport: type: boolean entityGuid: type: - string - 'null' readOnly: true firmwareupgradeguid: type: - string - 'null' readOnly: true displayName: type: - string - 'null' isActive: type: boolean isDeleted: type: boolean note: type: - string - 'null' isAcquired: type: boolean capability: type: integer format: int32 additionalProperties: false ExternalDeviceValidatedResponse_2: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ExternlDeviceValidated' 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 ExternlDeviceValidated: type: object properties: uniqueId: type: - string - 'null' errorMsg: type: - string - 'null' additionalProperties: false DeviceImportListByGuid_2: type: object properties: guid: type: - string - 'null' readOnly: true jsonData: type: - object - 'null' isValid: type: - boolean - 'null' deviceGuid: type: - string - 'null' readOnly: true deviceTemplateGuid: type: - string - 'null' readOnly: true dtCode: type: - string - 'null' firmwareGuid: type: - string - 'null' readOnly: true deviceTemplateName: type: - string - 'null' importLog: type: - string - 'null' parentDeviceGuid: type: - string - 'null' readOnly: true parentDeviceUniqueId: type: - string - 'null' uniqueId: type: - string - 'null' additionalProperties: false DeviceInfoDelete: type: object properties: value: type: - string - 'null' uniqueId: type: - string - 'null' additionalProperties: false ConnectionStatusBulkResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ConnectionBulkStatus' 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 DeviceUpdateRequest_2: required: - displayName - entityGuid type: object properties: displayName: maxLength: 100 minLength: 1 type: string description: The display name of device. note: maxLength: 500 type: - string - 'null' description: The note of the device. entityGuid: minLength: 1 type: string description: The entityGuid of device. properties: type: - array - 'null' items: $ref: '#/components/schemas/PropertyValue_2' description: The custom properties of device. xmlProperties: type: - object - 'null' readOnly: true additionalProperties: false UnassociatedAttachBulkRequest_2: required: - deviceGuids - deviceTemplateGuid - entityGuid - solutionGuidValue type: object properties: entityGuid: minLength: 1 type: string description: Entity Guid deviceTemplateGuid: minLength: 1 type: string description: Group Guid solutionGuidValue: minLength: 1 type: string deviceCertificateGuid: type: - string - 'null' description: The certificateGuid of devicetemplate. brokerGuid: type: - string - 'null' format: uuid deviceGuids: type: array items: type: string description: Device Guid List deviceId: type: - string - 'null' additionalProperties: false DeviceDelete_2: type: object properties: guid: type: - string - 'null' readOnly: true status: type: boolean entityGuid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' parentDeviceGuid: type: - string - 'null' readOnly: true eventPlaceHolders: type: - string - 'null' additionalProperties: false DeviceInfoDeleteResponse_2: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceInfoDelete' 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 DeviceConfigDetail_2: type: object properties: ver: type: - string - 'null' pf: type: - string - 'null' cpid: type: - string - 'null' env: type: - string - 'null' uid: type: - string - 'null' did: type: - string - 'null' at: type: integer format: int32 sk: type: - string - 'null' disc: type: - string - 'null' additionalProperties: false DeviceCreateRequest_2: required: - deviceTemplateGuid - displayName - entityGuid - uniqueId type: object properties: uniqueId: maxLength: 200 minLength: 1 type: string description: "The uniqueId of device.\nNotes: Device uniqueId length is conditional based on device template auth type and device type \n1. Self or CA signed parent device uniqueId length should be less than or equal to 31 characters. \n2. Self or CA signed child device uniqueId length should be less than or equal to 31 characters. \n3. For TPM or key, all device uniqueId length should be less than or equal to 128 characters." firmwareUpgradeGuid: type: - string - 'null' description: The firmwareUpgradeGuid of device. deviceTemplateGuid: minLength: 1 type: string description: The deviceTemplateGuid of device. tag: type: - string - 'null' description: The tag of the device which must be exists in device template. This field is required if the request for child device create and gateway support enabled in device template. parentDeviceGuid: type: - string - 'null' description: The gateway device guid. This field is required if the request for child device create and gateway support enabled in device template. primaryThumbprint: type: - string - 'null' description: The primaryThumbprint of self signed device. This field is required if device template authentication type is self signed certificate. secondaryThumbprint: type: - string - 'null' description: The secondaryThumbprint of self signed device. endorsementKey: maxLength: 2000 type: - string - 'null' description: The endorsementKey of TPM device. This field is required if device template authentication type is TPM. properties: type: - array - 'null' items: $ref: '#/components/schemas/PropertyValue_2' description: The custom properties of device. xmlProperties: type: - object - 'null' readOnly: true deviceCertificateGuid: type: - string - 'null' description: The certificateGuid of devicetemplate. deviceCertificate: type: - string - 'null' description: Byte array of device certificate file(Only .pfx file allowed). format: byte deviceCertificatePassword: type: - string - 'null' description: Password of device certificate primaryKey: type: - string - 'null' description: The primaryKey of symmetric key device. This field is required if device template authentication type is symmetric key. secondaryKey: type: - string - 'null' description: The secondaryKey of symmetric key device. This field is required if device template authentication type is symmetric key. certificateText: type: - string - 'null' autoGenerate: type: boolean displayName: maxLength: 100 minLength: 1 type: string description: The display name of device. note: maxLength: 500 type: - string - 'null' description: The note of the device. entityGuid: minLength: 1 type: string description: The entityGuid of device. additionalProperties: false DeviceList_2: type: object properties: guid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' displayName: type: - string - 'null' isConnected: type: boolean lastactivityDate: type: - string - 'null' format: date-time isActive: type: boolean firmwareupgradeGuid: type: - string - 'null' readOnly: true deviceTemplateGuid: type: - string - 'null' readOnly: true authType: type: integer format: int32 authenticationType: type: - string - 'null' messageVersion: type: - string - 'null' isSolutionTemplate: type: boolean solutionName: type: - string - 'null' deviceInfo: type: - object - 'null' deviceTemplateName: type: - string - 'null' reportingTo: type: - string - 'null' entityName: type: - string - 'null' IsAcquired: type: boolean readOnly: true childDeviceCount: type: integer format: int32 isType2Support: type: boolean isAllottedDevice: type: integer format: int32 readOnly: true allottedDevicePermission: type: - integer - 'null' format: int32 count: type: integer format: int32 isSharedDevice: type: - boolean - 'null' properties: type: - array - 'null' items: $ref: '#/components/schemas/DeviceProperty' deviceStatus: type: - string - 'null' recentAttrValue: type: - object - 'null' isDpsDevice: type: boolean readOnly: true lastConnection: type: - string - 'null' format: date-time lastCommunication: type: - string - 'null' format: date-time solutionGuid: type: - string - 'null' readOnly: true groupName: type: - string - 'null' productName: type: - string - 'null' parentCompanyGuid: type: - string - 'null' format: uuid cloudDeviceTemplateGuid: type: - string - 'null' format: uuid createdBy: type: - string - 'null' createdDate: type: string format: date-time attrEnable: type: boolean info: type: - array - 'null' items: $ref: '#/components/schemas/OutputparamListResponse' additionalProperties: false DeviceBatchImportValidateResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ImportBatchStatus_2' 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 UnassociatedDeviceList_2: type: object properties: guid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' displayName: type: - string - 'null' deviceTemplateGuid: type: - string - 'null' readOnly: true entityName: type: - string - 'null' createdBy: type: - string - 'null' createdDate: type: - string - 'null' format: date-time deviceStatus: type: - string - 'null' dpsInfoGuid: type: - string - 'null' format: uuid solutionGuid: type: - string - 'null' format: uuid isTpDevice: type: boolean additionalProperties: false DeviceDirectMethodResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceDirectMethod' 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 DeviceTemplateUpdateRequest: type: object properties: templateGuid: type: string format: uuid additionalProperties: false DeviceAcquireRequest_2: type: object properties: deviceCertificate: type: - string - 'null' description: Byte array of device certificate file(Only .pfx file allowed). format: byte deviceCertificatePassword: type: - string - 'null' description: Password of device certificate certificateText: type: - string - 'null' rootCAIndividualCertificateGuid: type: - string - 'null' description: root CA Individual certificate guid. isCloudDevice: type: boolean additionalProperties: false CompanyWiseDeviceList_2: type: object properties: guid: type: - string - 'null' readOnly: true uniqueId: type: - string - 'null' displayName: type: - string - 'null' isConnected: type: boolean isAcquired: type: boolean lastactivityDate: type: - string - 'null' format: date-time isActive: type: boolean deviceStatus: type: - string - 'null' authType: type: - integer - 'null' format: int32 firmwareupgradeGuid: type: - string - 'null' readOnly: true deviceTemplateGuid: type: - string - 'null' readOnly: true deviceInfo: type: - object - 'null' readOnly: true deviceTemplateName: type: - string - 'null' reportingTo: type: - string - 'null' entityGuid: type: - string - 'null' readOnly: true entityName: type: - string - 'null' childDeviceCount: type: integer format: int32 isType2Support: type: boolean createdByName: type: - string - 'null' createdDate: type: - string - 'null' format: date-time cpid: type: - string - 'null' companyGuid: type: - string - 'null' readOnly: true lastConnection: type: - string - 'null' format: date-time lastCommunication: type: - string - 'null' format: date-time additionalProperties: false ImportBatchStatus_2: type: object properties: importBatchGuid: type: - string - 'null' readOnly: true additionalProperties: false MultipleDeviceDeleteResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceBatchGuidStatus' 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 UserDevicePermissionUpdateRequest_2: required: - permission type: object properties: permission: type: object additionalProperties: type: - object - 'null' description: 'Permission list, Represents a dictionary of pemission(true/false) accessed by permission name. Note : Here, ''view'' and ''operation'' are available permission and at least one permission is required Eg. {"view" : true, "operation" : false}' additionalProperties: false DeviceDirectMethodRequest: required: - methodName - payload - responseTimeoutInSeconds - templateDirectMethodGuid type: object properties: templateDirectMethodGuid: type: string description: Template Direct Method Guid format: uuid methodName: minLength: 1 type: string description: MethodName responseTimeoutInSeconds: type: integer description: Response timeout seconds format: int32 payload: type: object description: Direct method payload additionalProperties: false DeviceDiagnosticsResponse_2: type: object properties: pageToken: type: - string - 'null' data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceDiagnostics' 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 DeviceDiagnostics: type: object properties: uniqueId: type: - string - 'null' authType: type: - string - 'null' maskedIpAddress: type: - string - 'null' statusCode: type: - string - 'null' time: type: - string - 'null' format: date-time operationName: type: - string - 'null' category: type: - string - 'null' level: type: - string - 'null' resultDescription: type: - string - 'null' location: type: - string - 'null' partitionKey: type: - string - 'null' rowKey: type: - string - 'null' timestamp: type: - string - 'null' format: date-time eTag: type: - string - 'null' properties: type: - string - 'null' additionalProperties: false DeviceInformation_2: type: object properties: guid: type: - string - 'null' readOnly: true solutionGuid: type: string format: uuid uniqueId: type: - string - 'null' displayName: type: - string - 'null' isConnected: type: boolean lastActivityDate: type: - string - 'null' format: date-time isActive: type: boolean firmwareUpgradeGuid: type: - string - 'null' readOnly: true deviceTemplateGuid: type: - string - 'null' readOnly: true entityGuid: type: - string - 'null' readOnly: true certificateGuid: type: - string - 'null' readOnly: true certificateName: type: - string - 'null' certificateType: type: - integer - 'null' format: int32 deviceTemplateAuthType: type: integer format: int32 authType: type: integer format: int32 entityName: type: - string - 'null' deviceTemplateName: type: - string - 'null' note: type: - string - 'null' image: type: - string - 'null' cpId: type: - string - 'null' isAcquired: type: integer format: int32 firmwareAvail: type: integer format: int32 parentDeviceGuid: type: - string - 'null' readOnly: true tag: type: - string - 'null' parentDeviceUniqueId: type: - string - 'null' isParentAcquired: type: integer format: int32 isSimulatorOn: type: integer format: int32 isType2Support: type: boolean isEdgeSupport: type: boolean isAllottedDevice: type: integer format: int32 isSphere: type: boolean allottedDevicePermission: type: - object - 'null' additionalProperties: type: boolean imageUrl: type: - string - 'null' readOnly: true properties: type: - array - 'null' items: $ref: '#/components/schemas/DeviceProperty' deviceStatus: type: - string - 'null' isLowBandwidth: type: boolean isIotEdgeEnable: type: boolean isSolutionTemplate: type: boolean fileSupport: type: boolean msgCode: type: - string - 'null' readOnly: true messageVersion: type: - string - 'null' hasTwin: type: boolean hasDirectMethod: type: boolean parentCompanyGuid: type: - string - 'null' format: uuid companyGuid: type: - string - 'null' readOnly: true lastConnection: type: - string - 'null' format: date-time isDpsDevice: type: boolean readOnly: true sendOfflineCommand: type: - boolean - 'null' authTypeName: type: - string - 'null' parentAuthType: type: integer format: int32 parentAuthTypeName: type: - string - 'null' c2dOnDemand: type: integer format: int32 cloudDeviceTemplateGuid: type: - string - 'null' format: uuid createdBy: type: - string - 'null' createdDate: type: string format: date-time additionalProperties: false DeviceBatchGuidStatus: type: object properties: batchGuid: type: string format: uuid additionalProperties: false DeviceDirectMethod: type: object properties: guid: type: - string - 'null' readOnly: true status: type: - string - 'null' readOnly: true responseJson: type: - string - 'null' additionalProperties: false ExternalDeviceValidateResponse_2: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ImportBatchStatus_2' 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 DeviceDirectMethodList: type: object properties: guid: type: - string - 'null' readOnly: true methodName: type: - string - 'null' requestJson: type: - string - 'null' responseJson: type: - string - 'null' status: type: - string - 'null' responseTimeoutSecond: type: integer format: int32 createdDate: type: string format: date-time createBy: type: - string - 'null' readOnly: true additionalProperties: false DeviceConnectionStatuses: type: object properties: isConnected: type: integer format: int32 uniqueId: type: - string - 'null' additionalProperties: false DeviceImportDeleteResponse: 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 DeviceGrantEmailsUpdateRequest_2: required: - emails - permission type: object properties: emails: type: array items: type: string description: An email address list, not allowed duplicate email addresses. permission: type: object additionalProperties: type: - object - 'null' description: 'Permission list, Represents a dictionary of pemission(true/false) accessed by permission name. Note : Here, ''view'' and ''operation'' are available permission and at least one permission is required Eg. {"view" : true, "operation" : false}' additionalProperties: false DeviceImportList_2: type: object properties: guid: type: - string - 'null' readOnly: true fileName: type: - string - 'null' status: type: - string - 'null' createdDate: type: - string - 'null' format: date-time updatedDate: type: - string - 'null' format: date-time success: type: integer format: int32 error: type: integer format: int32 createdBy: type: - string - 'null' readOnly: true updatedBy: type: - string - 'null' readOnly: true entityGuid: type: - string - 'null' readOnly: true deviceTemplateGuid: type: - string - 'null' readOnly: true certificateGuid: type: - string - 'null' readOnly: true isExternalImport: type: boolean deviceImportTypeGuid: type: - string - 'null' format: uuid deviceImportTypeName: type: - string - 'null' entityName: type: - string - 'null' updatebyName: type: - string - 'null' fileUrl: type: - string - 'null' readOnly: true bsuccess: type: integer format: int32 bfailed: type: integer format: int32 deviceTemplateName: type: - string - 'null' isEdgeSupport: type: - boolean - 'null' isType2Support: type: - boolean - 'null' isLowBandwidth: type: - boolean - 'null' iotEdgeEnable: type: - boolean - 'null' hasSphere: type: - boolean - 'null' batchImportDate: type: - string - 'null' format: date-time parentDeviceUniqueId: type: - string - 'null' additionalProperties: false RecentActivity_2: type: object properties: uniqueId: type: - string - 'null' deviceName: type: - string - 'null' entityName: type: - string - 'null' createdDate: type: string format: date-time type2Support: type: boolean edgeSupport: type: boolean lowbandWidth: type: boolean iotEdgeEnable: type: boolean additionalProperties: false DeviceTemplateUpdateResponse: 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 DeviceImportListResponse_2: type: object properties: continuationToken: type: - string - 'null' data: type: - array - 'null' items: $ref: '#/components/schemas/DeviceImportList_2' 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 securitySchemes: Bearer: type: apiKey description: Please enter JWT with Bearer into field name: Authorization in: header x-refined-from: - avnet-iotconnect-device-aws-prod-swagger.json - avnet-iotconnect-device-azure-prod-swagger.json